nqrduck/nqrduck-spectrometer-simulator
1
0
Fork 0
mirror of https://github.com/nqrduck/nqrduck-spectrometer-simulator.git synced 2024-12-30 11:18:07 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated README

Browse source
This commit is contained in:
jupfi 2024-03-01 15:14:08 +01:00
parent b01f1a5334
commit 6750dd5d5a
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -11,7 +11,17 @@ The requirements for the module are handled by the pyproject.toml file. The user
The simulator module uses the [nqr-blochsimulator](https://github.com/nqrduck/nqr-blochsimulator) project for simulation of the bloch equation. This module is automatically installed when installing the simulator module.
### Setup
To install the module you need the NQRduck core. You can find the installation instructions for the NQRduck core [here](https://github.com/nqrduck/nqrduck).
Ideally you should install the module in a virtual environment. You can create a virtual environment by running the following command in the terminal:
```bash
python -m venv nqrduck
```
You can install this module and the dependencies by running the following command in the terminal:
```bash
pip install .
```
## Usage
The pulse sequence is graphically programmed using the [nqrduck-pulseprogrammer](htpps://github.com/nqrduck-pulseprogrammer) within the NQRduck program under the 'Spectrometer' tab.