NQRduck

Installation

Requirements

• Python 3.10+
• pip
• virtualenv

Setup

1. Clone the repository

2. Create a virtual environment and activate it:

   python -m venv venv
   source venv/bin/activate
   

You can install the nqrduck core via PyPi or from the cloned repository. 3. Install the package with pip install .[all] to install all available NQRduck modules inside the cloned repository or just pip install "nqrduck[all]" to install the core package from PyPi. Careful here you might need additional dependencies specified in the respective module repositories. If you only want to install some base modules use pip install .[base] inside the cloned repository or with pip install -U "nqrduck[base]" . You can find the different modules here. 4. Run the program with nqrduck.

Usage

Individual features of the software can be installed as separate Python packages, like spectrometer control, pulse sequence programming or simulation of magnetic resonance experiments. The available functionality of the NQRduck program therefore depends on the installed packages.

The UI is structured as follows:

The UI is separated into different areas. Section 'a', highlighted in red, represents the menu bar used for general settings of the program and spectrometer selection. Section 'b', outlined in green, allows switching among various modules within the main view of the core, with the active module displayed in bold. Section 'c', depicted in blue, is the active module's view. The currently active module in the figure is the nqrduck-measurement module used for single frequency mangetic resonance experiments. The overall application is part of the NQRduck core and opens when the NQRduck core is started.

Uninstall

To uninstall the nqrduck program you can run the following command in the terminal while the virtual environment is activated:

nqrduck --uninstall

License

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

Contributing: Developing NQRduck modules

A template module is provided here. It is a good starting point for developing new modules.

If you want to contribute to the core, please add an issue or a pull request :).