RunDefinition

class RunDefinition(*, additional_run_properties, hard_sweeps, components, default_data_parameters, default_sweep_parameters, run_id, username, experiment_name, experiment_label, options, software_version_set_id, sweep_definition)

Bases: RunBase, RunConfigurationBase

The content of the run object when creating it.

Module: iqm.station_control.interface.models.run

Attributes

sweep_definition	The content of the associated sweep stored in the database.
run_id	Unique identifier of the run.
username	User who defined the run.
experiment_name	Identifier of the Experiment (Experiment.name).
experiment_label	Freeform label of the Experiment.
options	Experiment-specific options or toggles that generated the run.
software_version_set_id	Unique identifier of the software version set of the current Python runtime.
additional_run_properties	A free-form dictionary of data, used to store information that does not fall into other categories.
hard_sweeps	Maps SweepBase.return_parameters to "hardware sweep specification" which specifies how the data measured at each spot should be interpreted and shaped.
components	Components that participate in this run.
default_data_parameters	The subset of SweepBase.return_parameters that were added by default, not by the user.
default_sweep_parameters	The subset of SweepBase.sweeps parameters were added by default, not by the user.

Methods

Parameters:

• additional_run_properties (dict[str, Any] | None)

• hard_sweeps (dict[str, list[tuple[Sweep, ...]]] | None)

• components (list[str])

• default_data_parameters (list[str])

• default_sweep_parameters (list[str])

• run_id (UUID)

• username (str)

• experiment_name (str)

• experiment_label (str)

• options (dict[str, Any] | None)

• software_version_set_id (int | None)

• sweep_definition (SweepDefinition)

sweep_definition: SweepDefinition

The content of the associated sweep stored in the database.