Installation

LabOne Q requires Python 3.7 or higher. We recommend to use Anaconda. To ease the maintenance of multiple installations and software packages, it is recommended to use Python environments through e.g. venv, pipenv, or conda.

LabOne Q also requires an installation of the Zurich Instruments LabOne Software. LabOne and LabOne Q follow a frequent release cycle with updates and new features. LabOne Q always supports the current LabOne release. Changes to this are mentioned in the release notes.

The following command will make the latest officially released LabOne Q version available in your current Python environment. Use pip3 and python3 with your corresponding python version.

To run LabOne Q on real hardware, an access token is required during an initial, managed beta phase. Please visit https://www.zhinst.com/ch/en/install-labone-q-today to get the access token.

A development setup is only needed if you need deeper insights into the software or when you want to contribute to the development. The LabOne Q repository is found here: https://github.com/zhinst/laboneq

Use your favorite shell to configure a virtual Python environment. With conda you can create and activate your virtual environment.

Then make the Python package available as editable installations in-place (from repository root directory).

With this approach, Python code can be edited and executed in the source directories with your favorite IDE.