1. Installation

First, clone the current version of QuMADA from gitlab

git clone git@git-ce.rwth-aachen.de:qutech/lab_software/qumada.git qumada
cd qumada

1.1. Setup virtual environment

Installation of QuMADA should be done in a virtual environment. There are several methods of creating a virtual environment, python’s native being venv:

On windows, run

python -m venv .venv
.venv\Scripts\activate.bat

On linux, run

python -m venv .venv
source .venv/bin/activate

1.2. Setup for general use

Install QuMADA through pip

pip install -e .

You can also install optional dependencies, like Spyder or the ZurichInstruments MFLI instrument driver:

pip install -e .[spyder,mfli]

1.3. Setup for development

For development, the requirements are stored in dev_requirements.txt.

pip install -r dev_requirements.txt

Set up pre-commit hooks

pre-commit install

1.4. Build documentation

Run

tox -e docs

or

cd docs
make html

The built documentation can be found at _build/html/index.html.