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.4.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.4.0
File Size Uploaded
zhinst_toolkit-1.4.0.tar.gz 805.2 kB Details

Built distribution (wheel)

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

Total release size: 919.9 kB

Release files / zhinst_toolkit-1.4.0.tar.gz

Download URL zhinst_toolkit-1.4.0.tar.gz
Size 805.2 kB
Tags Source
SHA-256 checksum
How to use checksums
fefdccd631a06341055d7a7e012096cdc51b06c3139cf69ba158062152e7dc21
BLAKE2b-256 checksum
How to use checksums
df91e27c1a5493d6a097e4fb3c20c6c11b9dc79c8f8768fb972be29dab534b06
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.16.5 cpython/3.12.3 HTTPX/0.28.1

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

Download URL zhinst_toolkit-1.4.0-py3-none-any.whl
Size 114.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e79e0c36285bc5719638a83670412bae7e706d9e87593213f4829d050ef91d56
BLAKE2b-256 checksum
How to use checksums
0d1da56c877894f6a95c2ed22bada490623ea6be04f5b62cabc45c610a9b85de
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Hatch/1.16.5 cpython/3.12.3 HTTPX/0.28.1

Release history Release notifications | RSS feed

This release

1.4.0 This release

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.4

2 release files

0.6.3

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

1 release file

0.3.1

1 release file

0.3

1 release file

0.2.4

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.5

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

2 release files

0.1.1

2 release files

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