Go to file
2024-05-20 07:41:28 +02:00
.github/workflows Automatic PyPi deployment. 2024-04-18 19:28:26 +02:00
src/nqrduck_spectrometer Version bump. 2024-05-20 07:41:28 +02:00
.gitignore Initial commit 2023-06-27 21:52:59 +02:00
CHANGELOG.md Version bump. 2024-05-20 07:41:28 +02:00
LICENSE Automatic PyPi deployment. 2024-04-18 19:28:26 +02:00
pyproject.toml Version bump. 2024-05-20 07:41:28 +02:00
README.md UPdated README. 2024-02-28 11:39:15 +01:00

NQRduck Module: nqrduck-spectrometer

A module for the nqrduck project. This module is used as a base module for implementing different spectrometers. It provides the basic functionality for controlling a spectrometer and programming pulse sequences.

Installation

Requirements

Dependencies are handled via the pyproject.toml file.

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
# Activate the virtual environment
. nqrduck/bin/activate

You can install this module and the dependencies by running the following command in the terminal while the virtual environment is activated and you are in the root directory of this module:

pip install .

Usage

Examples for implementation of submodules can be found in the following repositories:

License

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

Contributing

If you're interested in contributing to the project, start by checking out our nqrduck-module template. To contribute to existing modules, please first open an issue in the respective module repository to discuss your ideas or report bugs.