nqrduck/nqrduck-spectrometer-limenqr
1
0
Fork 0
mirror of https://github.com/nqrduck/nqrduck-spectrometer-limenqr.git synced 2024-05-01 16:06:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
70 commits 1 branch 4 tags 503 KiB
Python 100%
Go to file
jupfi 2c63fa4028 Linting.
2024-04-30 16:02:46 +02:00
.github/workflows Automatic pypi deployment and linting. 2024-04-23 18:06:12 +02:00
src/nqrduck_spectrometer_limenqr Linting. 2024-04-30 16:02:46 +02:00
.gitignore Added preliminary drivers for lime spectrometer w. permission from Andrin Doll. 2024-01-09 18:25:15 +01:00
CHANGELOG.md Version bump. 2024-04-26 17:56:31 +02:00
LICENSE Automatic pypi deployment and linting. 2024-04-23 18:06:12 +02:00
pyproject.toml Version bump. 2024-04-26 17:56:31 +02:00
README.md Automatic pypi deployment and linting. 2024-04-23 18:06:12 +02:00

README.md

NQRduck Module: Spectrometer LimeNQR

This module is a part of the NQRduck project. It is a submodule of the spectrometer module for the NQRduck project. It is designed to be used with the NQRduck project.

The module provides a Graphical User Interface (GUI) for the control of the LimeSDR based spectrometer. It is designed to be used with the NQRduck project. The GUI is based on the PyQt5 library

The original code for the control of the LimeSDR based spectrometer was part of the paper by A. Doll; Pulsed and continuous-wave magnetic resonance spectroscopy using a low-cost software-defined radio. AIP Advances 1 November 2019; 9 (11): 115110. https://doi.org/10.1063/1.5127746. More information about the original code can be found in the LimeDriver project.

The currently supported LimeSDR devices are:

  • LimeSDR Mini v2.0 (probably also v1.x, but not tested)
  • LimeSDR USB

Installation

Requirements

You can find more information about the installation of dependencies in the LimeDriver project.

Additional dependencies should be installed by the pyproject.toml file when installing this module.

Setup

To install the module you need the NQRduck core. You can find the installation instructions for the NQRduck core here.

Ideally you should install the module in a virtual environment. You can create a virtual environment by running the following command in the terminal:

python -m venv nqrduck

You can install this module and the dependencies by running the following command in the terminal after cloning the repositor and navigating to the module directory:

pip install .

Alternatively you can install the module via the PyPi package manager by running the following command in the terminal:

pip install nqrduck-spectrometer-limenqr

Usage

The module is used together with the NQRduck pulseprogrammer module.

Notes

  • When using the LimeSDR USB use the TX Matching: 0 and RX Matching: 0 for frequencies below 1.5GHz in the settings of the module.
  • For the LimeSDR Mini 2.0 use the TX Matching: 2 and RX Matching: 2 for frequencies bellow 1.5GHz.

License

This project is licensed under the MIT License - see the LICENSE file for details.