zhinst-timing-models

26.4.0 verified Fri May 01 auth: no python

Feedback data latency model for Zurich Instruments PQSC, SHF, and HDAWG systems. Version 26.4.0, compatible with Python >=3.8. Follows the laboneq release cycle.

pip install zhinst-timing-models

Common errors

error ImportError: No module named zhinst_timing_models ↓

cause Tried to import with underscore instead of dot.

fix

Use: from zhinst.timing_models import TimingModel

error ModuleNotFoundError: No module named 'zhinst' ↓

cause zhinst-core not installed

fix

pip install zhinst-core

Warnings

gotcha The package is installed as zhinst-timing-models but import path uses dots: zhinst.timing_models. Common mistake: pip install zhinst-timing-models but then from zhinst_timing_models import ... fails. ↓

fix Use from zhinst.timing_models import TimingModel

deprecated Older versions (<26.0.0) used a different API with TimingConfig and LatencyCalculator. These have been replaced by a single TimingModel class. ↓

fix Update to >=26.0.0 and use TimingModel.

gotcha The data dictionary passed to TimingModel must contain all required keys for the specific instrument (PQSC, SHF, HDAWG). Missing keys will raise a KeyError. ↓

fix Refer to the official documentation for the exact schema required for each device type.

Imports

TimingModel

wrong

from zhinst_timing_models import TimingModel

correct

from zhinst.timing_models import TimingModel

Wrong package name: use zhinst.timing_models not zhinst_timing_models

Quickstart

Load instrument configuration and compute feedback latency.

from zhinst.timing_models import TimingModel

data = {/* ... instrument config ... */}
tmodel = TimingModel(data)
latency = tmodel.compute_latency()
print(latency)