Skip to content

Python ToolkitΒΆ

The python toolkit API is the main python API. It is a wrapper around the low level zhinst.core python API.

The toolkit API is available through the zhinst.toolkit module. zhinst.toolkit is published under the MIT License and is available on GitHub https://github.com/zhinst/zhinst-toolkit (including the examples).

The core of toolkit is the zhinst.toolkit.nodetree. It is also the main difference compared to the lower level zhinst.core API. A detailed introduction can be found in the Descriptions and Guidelines section.

Components Function/Class/Module
Client Session zhinst.toolkit.Session
Device Classes zhinst.toolkit.driver.devices
Module Classes zhinst.toolkit.driver.modules
Node Tree zhinst.toolkit.nodetree
Errors zhinst.toolkit.exceptions
Sequence zhinst.toolkit.sequence
Waveform zhinst.toolkit.waveform
Command Table zhinst.toolkit.command_table