diff --git a/README.md b/README.md index c282a23..8bb5ff2 100644 --- a/README.md +++ b/README.md @@ -1 +1,22 @@ -# quackseq \ No newline at end of file +# 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.