SweepDefinitionLite

Module: iqm.station_control.interface.models.sweep

class SweepDefinitionLite(*, sweep_id, dut_label, settings, sweeps, return_parameters, playlist)

Bases: object

Lightweight version of SweepDefinition.

Can be used when the full tree representation of the settings is not needed.

Attributes

qpu_runtime
sweep_id	Unique identifier of the sweep.
dut_label	DUT label of the device being used.
settings	Mapping of setting names to their values for initial settings to set before the sweep.
sweeps	Sweeps that define the swept parameters, i.e. a list of parallel sweeps, where the data values of all sweeps in the tuple are interleaved, and updated simultaneously during the sweep.
return_parameters	Parameters that will be queried from devices and saved for each spot (variable-tuple) of the N-dimensional sweep.
playlist	A Playlist that should be uploaded to the controllers.

Methods

Parameters:

• sweep_id (UUID)

• dut_label (str)

• settings (dict[str, Annotated[bool | str | int | float | complex | ndarray, PlainValidator(func=~exa.common.data.value.validate_value, json_schema_input_type=~typing.Any), PlainSerializer(func=~exa.common.data.value.serialize_value, return_type=PydanticUndefined, when_used=always), WithJsonSchema(json_schema={}, mode=None)] | list | None])

• sweeps (list[tuple[Sweep, ...]])

• return_parameters (list[str])

• playlist (Playlist | None)

sweep_id: UUID

Unique identifier of the sweep.

dut_label: str

DUT label of the device being used.

settings: dict[str, ~types.Annotated[bool | str | int | float | complex | ~numpy.ndarray, ~pydantic.functional_validators.PlainValidator(func=~exa.common.data.value.validate_value, json_schema_input_type=~typing.Any), ~pydantic.functional_serializers.PlainSerializer(func=~exa.common.data.value.serialize_value, return_type=PydanticUndefined, when_used=always), ~pydantic.json_schema.WithJsonSchema(json_schema={}, mode=None)] | list | None]

Mapping of setting names to their values for initial settings to set before the sweep. Must only contain non-None, non-readonly controller settings.

sweeps: list[tuple[Sweep, ...]]

Sweeps that define the swept parameters, i.e. a list of parallel sweeps, where the data values of all sweeps in the tuple are interleaved, and updated simultaneously during the sweep.

return_parameters: list[str]

Parameters that will be queried from devices and saved for each spot (variable-tuple) of the N-dimensional sweep. Each item must correspond to a setting name in settings.

playlist: Playlist | None

A Playlist that should be uploaded to the controllers.

Inheritance