Skip to content

QuTech-Delft/QMI

Repository files navigation

pylint mypy Documentation Status coverage tests

Quantum Measurement Infrastructure

QMI is a Python 3 framework for controlling laboratory equipment. It is suitable for anything ranging from one-off scientific experiments to robust operational setups.

QMI is developed by QuTech to support advanced physics experiments involving quantum bits. However, other than its name and original purpose, there is nothing specifically quantum about QMI — it is potentially useful in any environment where monitoring and control of measurement equipment is needed.

Installation

Currently, no PIP installation is possible. Please clone and setup with python setup.py install.

Documentation

Latest version

The latest version of the documentation can be found here.

Installing for generating documentation

To install the necessary packages to perform documentation activities for QMI do:

pip install -e .[rtd]

To build the 'readthedocs' documentation locally do:

cd documentation/sphinx
./make-docs

The documentation can then be found in the build/html directory.

Contribute

For contribution guidelines see CONTRIBUTING