Skip to main content

CI Coverage PyPI version License: MIT Code style: black Twitter URL

Zurich Instruments Labber Drivers

END OF LIFE

LabOne 24.10 will be the last LabOne version officially supported by the Zurich Instruments Labber drivers. After LabOne 24.10 we do no longer test and maintain the drivers.

Zurich Instruments continues to support the existing users of Labber drivers until the end of 2025.

The Zurich Instruments Labber Drivers is a python package that is able to automatically generate and update instrument drivers for all Zurich Instruments devices for the scientific measurement software Labber.

The Labber drivers are based on the Zurich Instruments Toolkit (zhinst-toolkit), a high level driver of our Python core API.

WARNING

Upgrading from zhinst-labber versions lower than 0.3 needs some special attention since version 0.3 breaks the API in many ways and measurements need to be adapted. If you need more Information on the upgrading process or need assistance feel free to contact the Zurich Instruments support at any time. (support@zhinst.com)

Status

The Zurich Instruments Labber Drivers are well tested and considered stable enough for general usage. The interfaces may have some incompatible changes between releases. Please check the changelog if you are upgrading to the latest version.

LabOne software

As a prerequisite, the LabOne software version 22.02 or later must be installed. It can be downloaded for free at https://www.zhinst.com/labone. Follow the installation instructions specific to your platform. Verify that you can connect to your instrument(s) using the web interface of LabOne. If you are upgrading from an older version, be sure to update the firmware of all Zurich Instruments devices in use by using the web interface.

In principle LabOne can be installed in a remote machine, but we highly recommend to install it on a local machine where you intend to run the experiment.

Getting Started

Labber comes with its own Python distribution that is used by default. If not specified otherwise (Preferences -> Advanced -> Python distribution) the following command needs to be executed within this distribution. (C:\Program Files\Labber\python-labber\Scripts\pip.exe or similar).

pip install zhinst-labber

The drivers for an device can now be generated using the command line interface.

For example the following command generated the driver for the Device DEV1234 inside the Labber driver folder of the ZI user.

zhinst-labber setup "C:\Users\ZI\Labber\Drivers" DEV1234 localhost

Documentation

For a full documentation see here.

Contributing

We welcome contributions by the community, either as bug reports, fixes and new code. Please use the GitHub issue tracker to report bugs or submit patches. Before developing something new, please get in contact with us.

License

This software is licensed under the terms of the MIT license. See LICENSE for more detail.

Metadata

Release files for zhinst-labber 0.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for zhinst-labber 0.3.3
File Size Uploaded Provenance Actions
zhinst_labber-0.3.3.tar.gz 526.8 kB Without provenance Details for zhinst_labber-0.3.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for zhinst-labber 0.3.3
File Interpreter ABI Platform Actions
zhinst_labber-0.3.3-py3-none-any.whl Python 3 none any Details for zhinst_labber-0.3.3-py3-none-any.whl

Total release size: 566.8 kB

Release files / zhinst_labber-0.3.3.tar.gz

Download URL zhinst_labber-0.3.3.tar.gz
Size 526.8 kB
Tags Source
SHA-256 checksum
How to use checksums
aef165617a6f97c75dae55e39c6c995a1241344b5f45d32dd26e46176df2f017
BLAKE2b-256 checksum
How to use checksums
2bee2b7f1f833afa6dceab98c65b65d26d14bdc94da1647eeadfbd69c9fd6d32
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.9

Release files / zhinst_labber-0.3.3-py3-none-any.whl

Download URL zhinst_labber-0.3.3-py3-none-any.whl
Size 40.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0c62c90896e80638b5e56724537351df6702bdf056de8c95f4b2ebc258eea620
BLAKE2b-256 checksum
How to use checksums
afd5e6c8e4c2a1a261d449f8c3496d987f98bc1c3b13c5721022984d0e78d19f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.11.9

Security for zhinst-labber 0.3.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page