nqrduck/NQRduckumentation
1
0
Fork 1
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

Updated requirements, added quackseq autodoc.

Browse source
This commit is contained in:
jupfi 2024-06-23 16:55:19 +02:00
parent 30fe0b575b
commit c53f87ca95
7 changed files with 45 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

4
requirements.txt
View file

@ -1,4 +1,5 @@
sphinx sphinx
setuptools
pydata-sphinx-theme pydata-sphinx-theme
myst-parser myst-parser
nqrduck nqrduck
@ -7,5 +8,8 @@ nqrduck-spectrometer-limenqr
nqrduck-spectrometer-simulator nqrduck-spectrometer-simulator
nqrduck-autotm nqrduck-autotm
nqrduck-broadband nqrduck-broadband
quackseq
quackseq-simulator
quackseq-limenqr
sphinx-design sphinx-design
sphinxcontrib-bibtex sphinxcontrib-bibtex

8
source/api_reference/index.rst
View file

@ -24,3 +24,11 @@ API Reference
limedriverbindings limedriverbindings
nqr-blochsimulator nqr-blochsimulator
.. toctree::
:maxdepth: 2
:caption: QuackSeq:
quackseq
quackseq-simulator
quackseq-limenqr

8
source/api_reference/quackseq-limenqr.rst Normal file
View file

@ -0,0 +1,8 @@
QuackSeq LimeNQR
================
.. autosummary::
:toctree: _autosummary
:recursive:
quackseq_limenqr

8
source/api_reference/quackseq-simulator.rst Normal file
View file

@ -0,0 +1,8 @@
QuackSeq Simulator
==================
.. autosummary::
:toctree: _autosummary
:recursive:
quackseq_simulator

8
source/api_reference/quackseq.rst Normal file
View file

@ -0,0 +1,8 @@
QuackSeq
========
.. autosummary::
:toctree: _autosummary
:recursive:
quackseq

2
source/index.md
View file

@ -1,4 +1,4 @@
# Welcome to the NQRduckumentation! # Welcome to the NQRduckumentation
<img src="_static/Logo_full.png" alt="NQRduck Logo" class="center"> <img src="_static/Logo_full.png" alt="NQRduck Logo" class="center">
<br> <br>

3
source/installation.md
View file

@ -2,13 +2,11 @@
## Requirements ## Requirements
- Python 3.10+ - Python 3.10+
- pip - pip
- virtualenv - virtualenv
- About 600MB of free storage space - About 600MB of free storage space
## Steps (Linux) ## Steps (Linux)
1. Install the specified requirements. 1. Install the specified requirements.
@ -26,7 +24,6 @@
pip install nqrduck pip install nqrduck
``` ```
4. Run the program with `nqrduck`. This should open up a window with the NQRduck install wizard. 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. 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.