Installation

General Requirements

LabOne Q requires Python 3.9 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 most recent LabOne release and currently requires LabOne version 24.07. Changes to this are mentioned in the release notes.

Latest Release

The following command will install the latest officially released LabOne Q version. Make sure to run this command in the Python environment into which LabOne Q should be installed.

pip install --upgrade laboneq

Note

During the initial, managed beta phase, LabOne Q required an access token to run on real hardware. No token is required from release 2.9 and newer. However, you are welcome to contact us at info@zhinst.com anytime if you need assistance.

Setup for Development

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

git clone git@github.com:zhinst/laboneq.git <YOUR_DIR>
cd <YOUR_DIR>

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

conda create -n laboneq anaconda
conda activate laboneq

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

pip install -e .

Note

LabOne Q contains code written in Rust. To build the Rust code, you must have a Rust toolchain available. You can install Rust by following the instructions on the Rust website.

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

To build wheels for distribution, you can use maturin as follows to create a wheel for the current platform in the wheels directory:

pip install maturin
maturin build --release --out wheels