Added tutorial pages, fixed title.
This commit is contained in:
parent
6665bac88d
commit
687082a474
6 changed files with 100 additions and 4 deletions
|
@ -1,2 +1,25 @@
|
|||
Tutorials
|
||||
==========
|
||||
NQRduck Tutorials 🦆
|
||||
====================
|
||||
|
||||
|
||||
Introduction
|
||||
------------
|
||||
|
||||
This is a collection of different tutorials for the NQRduck program.
|
||||
|
||||
- :doc:`0. NQRduck Setup <tutorial_0>` - This tutorial shows you how to setup the NQRduck program.
|
||||
|
||||
- :doc:`1. NQRduck Simulator <tutorial_1>` - This tutorial shows you how to use the NQRduck Simulator.
|
||||
|
||||
- :doc:`2. LimeNQR <tutorial_2>` - This tutorial shows you how to use the LimeNQR spectrometer with the NQRduck program.
|
||||
|
||||
Tutorials in work
|
||||
-----------------
|
||||
|
||||
- Automatic Tuning and Matching - This tutorial shows you how to use the Automatic Tuning and Matching module.
|
||||
|
||||
- Broadband - This tutorial shows you how to use the Broadband module.
|
||||
|
||||
- Developing a new module - This tutorial shows you how to develop a new module for the NQRduck program.
|
||||
|
||||
- Signal Processing - This tutorial shows you how to perform signal processing with the NQRduck program.
|
43
source/tutorials/tutorial_0.rst
Normal file
43
source/tutorials/tutorial_0.rst
Normal file
|
@ -0,0 +1,43 @@
|
|||
0. NQRduck Setup Tutorial 🦆
|
||||
============================
|
||||
|
||||
Introduction
|
||||
------------
|
||||
This Tutorial gives a short overview of how to setup the NQRduck program. The NQRduck program is a collection of different modules that can be installed separately. The core program is the main entry point and provides a user interface to access the different modules.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
- Python 3.10+
|
||||
- pip
|
||||
- virtualenv
|
||||
- About 600MB of free storage space
|
||||
|
||||
|
||||
Steps (Linux)
|
||||
-------------
|
||||
1. Install the specified requirements.
|
||||
|
||||
2. Create a virtual environment and activate it:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
python -m venv venv
|
||||
. venv/bin/activate
|
||||
|
||||
3. You can now install the NQRduck core program:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install nqrduck
|
||||
|
||||
|
||||
4. Run the program with `nqrduck`. This should open up a window with the NQRduck program.
|
||||
|
||||
5. The install wizard for different modules should open up. Install the `nqrduck-spectrometer`, `nqrduck-spectrometer-limenqr`, `nqrduck-pulseprogrammer` and `nqrduck-measurements` modules. You can also install other modules if you like.
|
||||
|
||||
6. You can switch between different modules with the toolbar. The installed modules should be `Measurement` and `Spectrometer`. You can also check all available modules by opening `Help -> About Modules`.
|
||||
|
||||
7. If you don't like how the program looks, you can change the appearance in `Settings -> Preferences`. Settings are saved and restored on the next start. Updating of the plot font size requires a restart of the program.
|
||||
|
||||
8. Continue the tutorial with the NQRduck Simulator Tutorial.
|
|
@ -0,0 +1,2 @@
|
|||
1. NQRduck Simulator Tutorial 🦆
|
||||
================================
|
2
source/tutorials/tutorial_2.rst
Normal file
2
source/tutorials/tutorial_2.rst
Normal file
|
@ -0,0 +1,2 @@
|
|||
2. LimeNQR Tutorial 🦆
|
||||
======================
|
Loading…
Add table
Add a link
Reference in a new issue