Skip to content

zhinst/labone-python

Repository files navigation

Package PyPI version
Meta Hatch project linting - Ruff code style - Black types - Mypy License
CI

LabOne Python API

The labone package provides a plain asynchronous Python API for LabOne, the control software of Zurich Instruments.

Caution

This API package is solely being developed to support LabOne Q, the software framework for quantum computing.

For direct access to the instruments without LabOne Q, the standard Python API for all Zurich Instruments' devices is provided through the zhinst package and can be obtained from PyPI by pip install zhinst.

Note

Since labone is not intended for direct usage, we do not offer any support or external documentation. Please contact Zurich Instruments if you have any questions.

LabOne compatibility

The labone package is broadly compatible with any LabOne version greater or equal than 23.06. When used with older versions of LabOne, some features may not be available or only partially working.

labone version Minimum LabOne version Best with LabOne
up to 2.3 23.06 23.06 or later
up to 3.1.2 23.06 24.10 or later
from 3.2.0 23.06 25.01 or later

Internal Documentation

The internal documentation can be found here. Due to the early stage there is not public documentation.

Contributing

See Contributing