Added install instructions.

This commit is contained in:
jupfi 2024-05-15 17:15:35 +02:00
parent 63b3803e6c
commit bbdf869bad
3 changed files with 39 additions and 0 deletions

View file

@ -9,6 +9,7 @@ This program is intended as an educational tool for magnetic resonance experimen
:gutter: 2
:::{grid-item-card}
:link: installation.html
{fas}`wrench;pst-color-primary` **Installation**
^^^
The NQRduck can be easily installed via pip. Additional modules can be installed via an included install wizard.
@ -41,6 +42,7 @@ The focus for spectrometers currently lies on LimeSDR based spectrometers (LimeS
:maxdepth: 1
:caption: Contents:
installation
tutorials/index
software_structure/index
api_reference/index

36
source/installation.md Normal file
View file

@ -0,0 +1,36 @@
# Installation
## 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:
```bash
python -m venv venv
. venv/bin/activate
```
3. You can now install the NQRduck core program:
```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.

View file

@ -3,6 +3,7 @@
## Introduction
If you have already followed the [installation instructions](../installation.md), you can skip this tutorial. Just make sure you have the modules from point 5 installed.
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