Registry / data / zhinst-toolkit

zhinst-toolkit

library1.4.0pypypi✓ verified 84d ago

High-level API for Zurich Instruments devices, built on top of zhinst-core. Current version: 1.4.0. Released on a monthly cadence.

data

pip install zhinst-toolkit

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ZHINST-TOOLKIT

zhinst-toolkit

datapythonv1.4.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Session

✓ from zhinst.toolkit import Session

✗ import zhinst.toolkit.Session

Session is a class, not a module.

DeviceTypes

✓ from zhinst.toolkit import DeviceTypes

Enum for device types, no common mistake.

Basic connection to a Zurich Instruments device.

from zhinst.toolkit import Session session = Session('localhost') session.connect_device('dev1234') print(session.devices)

Debug

Known issues

breakingIn version 1.0.0, the API was restructured: Session is now the entry point, replacing the old `zhinst.toolkit.connection` approach.

fix

Use `from zhinst.toolkit import Session` instead of `from zhinst.toolkit.connection import Connection`.

affects: <1.0.0

deprecatedThe `session.connect_device(serial)` method is deprecated in favor of `session.connect_device(device_id)` in v1.4.0.

fix

Use `session.connect_device('dev1234')` with the full device ID.

affects: >=1.4.0

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'zhinst.toolkit'

zhinst-toolkit not installed or installed in wrong environment.

fix

Run `pip install zhinst-toolkit` in the correct Python environment.

AttributeError: module 'zhinst.toolkit' has no attribute 'Session'

Importing the module instead of the class; old version of toolkit.

fix

Use `from zhinst.toolkit import Session` and ensure version >=1.0.0.

Upgrade

Version history

1.4.0latest on PyPI · released Apr 29, 2026

Audit

Dependencies

zhinst-corerequiredLow-level API required for device communication

Agent activity

47 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/zhinst/zhinst-toolkit ↗

packagehttps://pypi.org/project/zhinst-toolkit/ ↗

homepagehttps://zhinst.tools ↗