run_sequence

async caqtus.experiment_control.sequence_execution.run_sequence(

sequence: PureSequencePath,

session_maker: StorageManager,

shot_retry_config: ShotRetryConfig | None,

global_parameters: ParameterNamespace | None,

device_configurations: Mapping[DeviceName, DeviceConfiguration] | None,

device_manager_extension: DeviceManagerExtensionProtocol,

shot_runner_factory: ShotRunnerFactory = create_shot_runner,

shot_compiler_factory: ShotCompilerFactory = create_shot_compiler,

) → None

Manages the execution of a sequence.

Parameters:

• sequence – The sequence to run.

• session_maker – A factory for creating experiment sessions. This is used to connect to the storage in which to find the sequence.

• shot_retry_config – Specifies how to retry a shot if an error occurs. If an error occurs when the shot runner is running a shot, it will be caught by the sequence manager and the shot will be retried according to the configuration in this object.

• global_parameters –

  The global parameters to use to run the sequence.

  These parameters will be saved as the global parameters for the sequence when it is prepared.

  If None, the sequence manager will use the default global parameters stored in the session.

• device_configurations –

  The device configurations to use to run the sequence.

  These configurations will be saved as the configurations used for the sequence when it is prepared.

  If None, the sequence manager will use the default device configurations.

• device_manager_extension – Used to instantiate the device components.

• shot_runner_factory – A function that can be used to create an object to run shots.

• shot_compiler_factory – A function that can be used to create an object to compile shots.