models | Conductor Quantum

Module Contents

Classes

Name	Description
`BaseModelWithConfig`	None
`Electrode`	None
`PadType`	Pad type
`GateType`	str(object=”) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
`ContactType`	str(object=”) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
`GPIOType`	str(object=”) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
`InstrumentType`	str(object=”) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
`Gate`	Gate pads for inductive channels on the device
`Contact`	Contact pads for conductive channels on the device
`GPIO`	General Purpose Input/Output pins for digital signals
`RoutineConfig`	None
`BaseInstrumentConfig`	Base instrument configuration with discriminator.
`MeasurementInstrumentConfigMixin`	Mixin for instruments with measurement capabilities.
`ControlInstrumentConfigMixin`	Mixin for instruments with control capabilities.
`MeasurementInstrumentConfig`	Instrument configuration for measurement instruments with required timing parameters.
`ControlInstrumentConfig`	Instrument configuration for control instruments.
`GeneralInstrumentConfig`	Instrument configuration for general instruments with both control and measurement capabilities.
`BreakoutBoxInstrumentConfig`	Instrument configuration for breakout box instruments.
`DeviceGroup`	Logical grouping of pads within a device.
`DeviceConfig`	Configuration for a quantum device (Device Under Test).

Data

PYDANTIC_VERSION_MINOR_TUPLE PYDANTIC_V2 InstrumentConfig

API

1 stanza.models.PYDANTIC_VERSION_MINOR_TUPLE

Value: tuple(...)

1 stanza.models.PYDANTIC_V2

Value: None

1 class stanza.models.BaseModelWithConfig

Bases: pydantic.BaseModel

1 class stanza.models.Electrode

Bases: pydantic.BaseModel

1 control_channel: int | None

Value: Field(...)

1 measure_channel: int | None

Value: Field(...)

1 breakout_channel: int | None

Value: Field(...)

1 v_lower_bound: float | None

Value: None

1 v_upper_bound: float | None

Value: None

1 validate_control_channel_required_when_no_measure_channel() -> stanza.models.Electrode

1 validate_control_channel_requires_v_bounds() -> stanza.models.Electrode

1 class stanza.models.PadType

Bases: str, enum.Enum

Pad type

Initialization

Initialize self. See help(type(self)) for accurate signature.

1 GATE

Value: GATE

1 CONTACT

Value: CONTACT

1 GPIO

Value: GPIO

1 ALL

Value: ALL

1 __str__() -> str

1 class stanza.models.GateType

Bases: str, enum.Enum

1 PLUNGER

Value: PLUNGER

1 BARRIER

Value: BARRIER

1 RESERVOIR

Value: RESERVOIR

1 SCREEN

Value: SCREEN

1 class stanza.models.ContactType

Bases: str, enum.Enum

1 SOURCE

Value: SOURCE

1 DRAIN

Value: DRAIN

1 class stanza.models.GPIOType

Bases: str, enum.Enum

1 INPUT

Value: INPUT

1 OUTPUT

Value: OUTPUT

1 class stanza.models.InstrumentType

Bases: str, enum.Enum

1 CONTROL

Value: CONTROL

1 MEASUREMENT

Value: MEASUREMENT

1 GENERAL

Value: GENERAL

1 BREAKOUT_BOX

Value: BREAKOUT_BOX

1 class stanza.models.Gate

Bases: stanza.models.Electrode

Gate pads for inductive channels on the device

1 type: stanza.models.GateType

Value: None

1 class stanza.models.Contact

Bases: stanza.models.Electrode

Contact pads for conductive channels on the device

1 type: stanza.models.ContactType

Value: None

1 class stanza.models.GPIO

Bases: stanza.models.Electrode

General Purpose Input/Output pins for digital signals

1 type: stanza.models.GPIOType

Value: None

1 class stanza.models.RoutineConfig

Bases: stanza.models.BaseModelWithConfig

1 name: str

Value: None

1 group: str | None

Value: None

1 parameters: dict[str, typing.Any] | None

Value: None

1 routines: list[stanza.models.RoutineConfig] | None

Value: None

1 convert_to_number() -> stanza.models.RoutineConfig

Convert float values to int if they have no fractional part.

1 class stanza.models.BaseInstrumentConfig

Bases: stanza.models.BaseModelWithConfig

Base instrument configuration with discriminator.

1 name: str

Value: None

1 ip_addr: str | None

Value: None

1 serial_addr: str | None

Value: None

1 port: int | None

Value: None

1 type: stanza.models.InstrumentType

Value: None

1 breakout_line: int | None

Value: None

1 driver: str | None

Value: Field(...)

1 check_comm_type() -> stanza.models.BaseInstrumentConfig

1 class stanza.models.MeasurementInstrumentConfigMixin

Bases: pydantic.BaseModel

Mixin for instruments with measurement capabilities.

1 measurement_duration: float

Value: Field(...)

1 sample_time: float

Value: Field(...)

1 conversion_factor: float

Value: Field(...)

1 machine_type: str | None

Value: Field(...)

1 cluster_name: str | None

Value: Field(...)

1 measurement_channels: list[int] | None

Value: Field(...)

1 connection_headers: dict[str, str] | None

Value: Field(...)

1 octave: str | None

Value: Field(...)

1 validate_timing_constraints() -> stanza.models.MeasurementInstrumentConfigMixin

Validate logical constraints between timing parameters.

1 class stanza.models.ControlInstrumentConfigMixin

Bases: pydantic.BaseModel

Mixin for instruments with control capabilities.

1 slew_rate: float

Value: Field(...)

1 conversion_factor: float

Value: Field(...)

1 class stanza.models.MeasurementInstrumentConfig

Bases: stanza.models.MeasurementInstrumentConfigMixin, stanza.models.BaseInstrumentConfig

Instrument configuration for measurement instruments with required timing parameters.

1 type: typing.Literal[stanza.models.InstrumentType]

Value: None

1 class stanza.models.ControlInstrumentConfig

Bases: stanza.models.ControlInstrumentConfigMixin, stanza.models.BaseInstrumentConfig

Instrument configuration for control instruments.

1 type: typing.Literal[stanza.models.InstrumentType]

Value: None

1 class stanza.models.GeneralInstrumentConfig

Bases: stanza.models.ControlInstrumentConfigMixin, stanza.models.MeasurementInstrumentConfigMixin, stanza.models.BaseInstrumentConfig

Instrument configuration for general instruments with both control and measurement capabilities.

1 model_config

Value: ConfigDict(...)

1 type: typing.Literal[stanza.models.InstrumentType]

Value: None

1 class stanza.models.BreakoutBoxInstrumentConfig

Bases: stanza.models.BaseInstrumentConfig

Instrument configuration for breakout box instruments.

1 model_config

Value: ConfigDict(...)

1 type: typing.Literal[stanza.models.InstrumentType]

Value: None

1 stanza.models.InstrumentConfig

Value: None

1 class stanza.models.DeviceGroup

Bases: pydantic.BaseModel

Logical grouping of pads within a device.

1 name: str | None

Value: None

1 gates: list[str]

Value: Field(...)

1 contacts: list[str] | None

Value: None

1 gpios: list[str] | None

Value: None

1 class stanza.models.DeviceConfig

Bases: pydantic.BaseModel

Configuration for a quantum device (Device Under Test).

1 model_config

Value: ConfigDict(...)

1 name: str

Value: None

1 gates: dict[str, stanza.models.Gate]

Value: None

1 contacts: dict[str, stanza.models.Contact]

Value: None

1 gpios: dict[str, stanza.models.GPIO]

Value: None

1 groups: dict[str, stanza.models.DeviceGroup]

Value: None

1 routines: list[stanza.models.RoutineConfig]

Value: []

1 instruments: list[stanza.models.InstrumentConfig]

Value: None

1 validate_unique_channels() -> stanza.models.DeviceConfig

Ensure that all channels are unique across gates, contacts, and gpios

1 validate_groups() -> stanza.models.DeviceConfig

1 _validate_routine_group(
2     routine: stanza.models.RoutineConfig,
3     available_groups: set[str],
4     path: str = ''
5 ) -> stanza.models.DeviceConfig

1 validate_routine_groups() -> stanza.models.DeviceConfig

Validate that routine groups exist if specified.

1 validate_required_instruments() -> stanza.models.DeviceConfig