zhinst-toolkit 0.5.0

Zurich Instruments Toolkit High Level API

Zurich Instruments Toolkit (zhinst-toolkit)

The Zurich Instruments Toolkit (zhinst-toolkit) is a high level driver package that allows communication with Zurich Instruments devices from the Python programming language. It is based on top of the native Python API (zhinst.core) of LabOne®, the Zurich Instruments control software. It comes in the form of a package compatible with Python 3.7+.

The central goal of zhinst-toolkit is to provide a pythonic approach to interact with any Zurich Instruments device and is intended as a full replacement for the low level zhinst.core package.

Status

The zhinst-toolkit is 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.

LabOne software

As 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 al your devices using the web interface before continuing.

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

Install

Install the package with pip:

pip install zhinst-toolkit

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.

Please see Contributing section

License

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