{"id":27566,"library":"zhinst-toolkit","title":"Zurich Instruments Toolkit","description":"High-level API for Zurich Instruments devices, built on top of zhinst-core. Current version: 1.4.0. Released on a monthly cadence.","status":"active","version":"1.4.0","language":"python","source_language":"en","source_url":"https://github.com/zhinst/zhinst-toolkit","tags":["zhinst","zurich-instruments","quantum-computing","measurement"],"install":[{"cmd":"pip install zhinst-toolkit","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Low-level API required for device communication","package":"zhinst-core","optional":false}],"imports":[{"note":"Session is a class, not a module.","wrong":"import zhinst.toolkit.Session","symbol":"Session","correct":"from zhinst.toolkit import Session"},{"note":"Enum for device types, no common mistake.","wrong":null,"symbol":"DeviceTypes","correct":"from zhinst.toolkit import DeviceTypes"}],"quickstart":{"code":"from zhinst.toolkit import Session\n\nsession = Session('localhost')\nsession.connect_device('dev1234')\nprint(session.devices)","lang":"python","description":"Basic connection to a Zurich Instruments device."},"warnings":[{"fix":"Use `from zhinst.toolkit import Session` instead of `from zhinst.toolkit.connection import Connection`.","message":"In version 1.0.0, the API was restructured: Session is now the entry point, replacing the old `zhinst.toolkit.connection` approach.","severity":"breaking","affected_versions":"<1.0.0"},{"fix":"Use `session.connect_device('dev1234')` with the full device ID.","message":"The `session.connect_device(serial)` method is deprecated in favor of `session.connect_device(device_id)` in v1.4.0.","severity":"deprecated","affected_versions":">=1.4.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run `pip install zhinst-toolkit` in the correct Python environment.","cause":"zhinst-toolkit not installed or installed in wrong environment.","error":"ModuleNotFoundError: No module named 'zhinst.toolkit'"},{"fix":"Use `from zhinst.toolkit import Session` and ensure version >=1.0.0.","cause":"Importing the module instead of the class; old version of toolkit.","error":"AttributeError: module 'zhinst.toolkit' has no attribute 'Session'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}