mirror of
https://github.com/nqrduck/NQRduckumentation.git
synced 2024-12-22 08:07:49 +00:00
Updated requirements, added quackseq autodoc.
This commit is contained in:
parent
30fe0b575b
commit
c53f87ca95
7 changed files with 45 additions and 12 deletions
|
@ -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
|
|
@ -24,3 +24,11 @@ API Reference
|
|||
|
||||
limedriverbindings
|
||||
nqr-blochsimulator
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: QuackSeq:
|
||||
|
||||
quackseq
|
||||
quackseq-simulator
|
||||
quackseq-limenqr
|
8
source/api_reference/quackseq-limenqr.rst
Normal file
8
source/api_reference/quackseq-limenqr.rst
Normal file
|
@ -0,0 +1,8 @@
|
|||
QuackSeq LimeNQR
|
||||
================
|
||||
|
||||
.. autosummary::
|
||||
:toctree: _autosummary
|
||||
:recursive:
|
||||
|
||||
quackseq_limenqr
|
8
source/api_reference/quackseq-simulator.rst
Normal file
8
source/api_reference/quackseq-simulator.rst
Normal file
|
@ -0,0 +1,8 @@
|
|||
QuackSeq Simulator
|
||||
==================
|
||||
|
||||
.. autosummary::
|
||||
:toctree: _autosummary
|
||||
:recursive:
|
||||
|
||||
quackseq_simulator
|
8
source/api_reference/quackseq.rst
Normal file
8
source/api_reference/quackseq.rst
Normal file
|
@ -0,0 +1,8 @@
|
|||
QuackSeq
|
||||
========
|
||||
|
||||
.. autosummary::
|
||||
:toctree: _autosummary
|
||||
:recursive:
|
||||
|
||||
quackseq
|
|
@ -1,4 +1,4 @@
|
|||
# Welcome to the NQRduckumentation!
|
||||
# Welcome to the NQRduckumentation
|
||||
|
||||
<img src="_static/Logo_full.png" alt="NQRduck Logo" class="center">
|
||||
<br>
|
||||
|
|
|
@ -2,13 +2,11 @@
|
|||
|
||||
## Requirements
|
||||
|
||||
|
||||
- Python 3.10+
|
||||
- pip
|
||||
- virtualenv
|
||||
- About 600MB of free storage space
|
||||
|
||||
|
||||
## Steps (Linux)
|
||||
|
||||
1. Install the specified requirements.
|
||||
|
@ -26,7 +24,6 @@
|
|||
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.
|
||||
|
|
Loading…
Reference in a new issue