ExperimentRunService

Service used to run experiment

CREATE_CLI_FOR_EXPERIMENT - @classmethod

Run an experiment in a non-blocking way through the cli.

Parameters:

Name	Type	Default value	Description
experiment	`Experiment`
user	`User`		The user who is running the experiment. if not provided, the system will try the get the currently authenticated user `gws.user.`

Return type:

SysProc

CREATE_CLI_FOR_EXPERIMENT_PROCESS - @classmethod

Run an experiment in a non-blocking way through the cli.

Parameters:

Name	Type	Description
experiment	`Experiment`
protocol_model	`ProtocolModel`
process_instance_name	`str`
user	`User`	The user who is running the experiment. if not provided, the system will try the get the currently authenticated user `gws.user.`

Return type:

SysProc

GET_ALL_RUNNING_EXPERIMENTS - @classmethod

Return type:

List

RUN_EXPERIMENT - @classmethod

Run the experiment

Parameters:

Name	Type	Default value	Description
experiment	`Experiment`

Return type:

Experiment

RUN_EXPERIMENT_IN_CLI - @classmethod

Method called by the cli sub process to run the experiment

Parameters:

Name	Type	Default value	Description
experiment_id	`str`

RUN_EXPERIMENT_PROCESS_IN_CLI - @classmethod

Method called by the cli sub process to run the experiment

Parameters:

Name	Type	Default value	Description
experiment_id	`str`
protocol_model_id	`str`
process_name	`str`

STOP_ALL_RUNNING_EXPERIMENT - @classmethod

STOP_EXPERIMENT - @classmethod

Parameters:

Name	Type	Default value	Description
id	`str`

Return type:

Experiment