Added readme.

This commit is contained in:
jupfi 2024-06-24 19:26:49 +02:00
parent 1fceff04d7
commit 06e9bf210a

View file

@ -1 +1,22 @@
# quackseq # QuackSeq
QuackSeq is a tool for programming pulse sequences for magnetic resonance experiments.
The general idea is that different QuackSeq sequences can be run on either hardware spectrometers or software simulators.
Different QuackSeq interpreters can be used to run the same sequence on different spectrometers or simulators.
## Installation
Create a new virtual environment and install QuackSeq:
```bash
python3 -m venv venv
source venv/bin/activate
pip install quackseq
```
## Modules
- [quackseq-simulator](https://github.com/nqrduck/quackseq-simulator): A simulator for QuackSeq sequences.
- [quackseq-limenqr](https://github.com/nqrduck/quackseq-limenqr): A QuackSeq interpreter for the LimeNQR spectrometer.