From c53f87ca9561de82ddaeb79289f1a0b73a6a08dd Mon Sep 17 00:00:00 2001 From: jupfi Date: Sun, 23 Jun 2024 16:55:19 +0200 Subject: [PATCH] Updated requirements, added quackseq autodoc. --- requirements.txt | 4 ++++ source/api_reference/index.rst | 10 +++++++++- source/api_reference/quackseq-limenqr.rst | 8 ++++++++ source/api_reference/quackseq-simulator.rst | 8 ++++++++ source/api_reference/quackseq.rst | 8 ++++++++ source/index.md | 10 +++++----- source/installation.md | 9 +++------ 7 files changed, 45 insertions(+), 12 deletions(-) create mode 100644 source/api_reference/quackseq-limenqr.rst create mode 100644 source/api_reference/quackseq-simulator.rst create mode 100644 source/api_reference/quackseq.rst diff --git a/requirements.txt b/requirements.txt index e4ca81e..739ce92 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ sphinx +setuptools pydata-sphinx-theme myst-parser nqrduck @@ -7,5 +8,8 @@ nqrduck-spectrometer-limenqr nqrduck-spectrometer-simulator nqrduck-autotm nqrduck-broadband +quackseq +quackseq-simulator +quackseq-limenqr sphinx-design sphinxcontrib-bibtex \ No newline at end of file diff --git a/source/api_reference/index.rst b/source/api_reference/index.rst index 850ae3f..ec77e51 100644 --- a/source/api_reference/index.rst +++ b/source/api_reference/index.rst @@ -23,4 +23,12 @@ API Reference :caption: Other Components: limedriverbindings - nqr-blochsimulator \ No newline at end of file + nqr-blochsimulator + +.. toctree:: + :maxdepth: 2 + :caption: QuackSeq: + + quackseq + quackseq-simulator + quackseq-limenqr \ No newline at end of file diff --git a/source/api_reference/quackseq-limenqr.rst b/source/api_reference/quackseq-limenqr.rst new file mode 100644 index 0000000..3f62a0b --- /dev/null +++ b/source/api_reference/quackseq-limenqr.rst @@ -0,0 +1,8 @@ +QuackSeq LimeNQR +================ + +.. autosummary:: + :toctree: _autosummary + :recursive: + + quackseq_limenqr \ No newline at end of file diff --git a/source/api_reference/quackseq-simulator.rst b/source/api_reference/quackseq-simulator.rst new file mode 100644 index 0000000..9807f93 --- /dev/null +++ b/source/api_reference/quackseq-simulator.rst @@ -0,0 +1,8 @@ +QuackSeq Simulator +================== + +.. autosummary:: + :toctree: _autosummary + :recursive: + + quackseq_simulator \ No newline at end of file diff --git a/source/api_reference/quackseq.rst b/source/api_reference/quackseq.rst new file mode 100644 index 0000000..059ce8b --- /dev/null +++ b/source/api_reference/quackseq.rst @@ -0,0 +1,8 @@ +QuackSeq +======== + +.. autosummary:: + :toctree: _autosummary + :recursive: + + quackseq \ No newline at end of file diff --git a/source/index.md b/source/index.md index 0c9eb18..4de4202 100644 --- a/source/index.md +++ b/source/index.md @@ -1,9 +1,9 @@ -# Welcome to the NQRduckumentation! +# Welcome to the NQRduckumentation NQRduck Logo
-This program is intended as an educational tool for magnetic resonance experiments (NMR, NQR, ...). Its focus lies on modular behaviour depending on what nqrduck modules are installed. +This program is intended as an educational tool for magnetic resonance experiments (NMR, NQR, ...). Its focus lies on modular behaviour depending on what nqrduck modules are installed. ::::{grid} 2 :gutter: 2 @@ -22,9 +22,9 @@ There exists a range of different modules for the NQRduck software. The tutorial ::: :::{grid-item-card} :link: software_structure/index.html -{fab}`python;pst-color-primary` **Software Structure** +{fab}`python;pst-color-primary` **Software Structure** ^^^ -The NQRduck comes with a user friendly PyQt6 based user interface. Different Python modules can be installed via pip to customize the functionality of the program. +The NQRduck comes with a user friendly PyQt6 based user interface. Different Python modules can be installed via pip to customize the functionality of the program. ::: :::{grid-item-card} :link: api_reference/index.html @@ -47,4 +47,4 @@ tutorials/index software_structure/index api_reference/index bibliography -``` \ No newline at end of file +``` diff --git a/source/installation.md b/source/installation.md index 772a366..7c15e38 100644 --- a/source/installation.md +++ b/source/installation.md @@ -2,13 +2,11 @@ ## Requirements - - Python 3.10+ - pip - virtualenv - About 600MB of free storage space - ## Steps (Linux) 1. Install the specified requirements. @@ -21,16 +19,15 @@ ``` 3. You can now install the NQRduck core program: - - ```bash + + ```bash pip install nqrduck ``` - 4. Run the program with `nqrduck`. This should open up a window with the NQRduck install wizard. 5. The install wizard for different modules should open up. Install the modules you would like to use. Some modules have dependencies on other modules, but the install wizard will automatically install them for you. 6. You now need to restart the program. -7. You can switch between different modules with the toolbar. You can customize the appearance of the program in `Settings -> Preferences`. Settings are saved and restored on the next start. \ No newline at end of file +7. You can switch between different modules with the toolbar. You can customize the appearance of the program in `Settings -> Preferences`. Settings are saved and restored on the next start.