Skip to main content

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

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.10+.

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 25.04 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 via info@zhinst.com.

License

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

Metadata

Release files for zhinst-toolkit 1.5.0

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-toolkit 1.5.0
File Size Uploaded Provenance Actions
zhinst_toolkit-1.5.0.tar.gz 806.0 kB Without provenance Details for zhinst_toolkit-1.5.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for zhinst-toolkit 1.5.0
File Interpreter ABI Platform Actions
zhinst_toolkit-1.5.0-py3-none-any.whl Python 3 none any Details for zhinst_toolkit-1.5.0-py3-none-any.whl

Total release size: 925.5 kB

Release files / zhinst_toolkit-1.5.0.tar.gz

Download URL zhinst_toolkit-1.5.0.tar.gz
Size 806.0 kB
Tags Source
SHA-256 checksum
How to use checksums
8be0cd97d73a77e387498a19ae43580024d525904dadbfb01ad1dfe75c93ae91
BLAKE2b-256 checksum
How to use checksums
5e1f5416a85105c1ea29234a8248c89c9ac4bad63b93be6a72a32045ef849ba1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.18.2 {"ci":true,"cpu":"x86_64","distro":{"id":"noble","libc":{"lib":"glibc","version":"2.39"},"name":"Ubuntu","version":"24.04"},"implementation":{"name":"CPython","version":"3.12.3"},"installer":{"name":"hatch","version":"1.18.2"},"openssl_version":"OpenSSL 3.0.13 30 Jan 2024","python":"3.12.3","system":{"name":"Linux","release":"7.0.0-1017-azure"}} HTTPX2/2.16.0

Release files / zhinst_toolkit-1.5.0-py3-none-any.whl

Download URL zhinst_toolkit-1.5.0-py3-none-any.whl
Size 119.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
37a1c1fdbcc8e9fe69e290a8bb36595729da7e595b51ba05e024843a503ce6d8
BLAKE2b-256 checksum
How to use checksums
4580cd7921439cd4f43d6bf0565d862a583b1b482df42609bda7251928c7ee33
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.18.2 {"ci":true,"cpu":"x86_64","distro":{"id":"noble","libc":{"lib":"glibc","version":"2.39"},"name":"Ubuntu","version":"24.04"},"implementation":{"name":"CPython","version":"3.12.3"},"installer":{"name":"hatch","version":"1.18.2"},"openssl_version":"OpenSSL 3.0.13 30 Jan 2024","python":"3.12.3","system":{"name":"Linux","release":"7.0.0-1017-azure"}} HTTPX2/2.16.0

Security for zhinst-toolkit 1.5.0

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.

Release history Release notifications | RSS feed

This release

1.5.0 This release

2 release files No provenance

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