Properties

• scan_id UUID of the Scan holding this Run

• experiment_id UUID of the Experiment of this Run

• order Order of this Run

• parameters Parameters of this Run

• status Status of this Run

Methods

update

update(
   status: Union[RunStatus, str]
)

Description

Update this run.

Examples

run.update(status=RunStatus.TERMINATED)

end

end()

Description

End a run

Examples

run.end()

get_script

get_script()

Description

Retrieve the script of this run.

Returns

A ScanFile object

list_data_files

list_data_files()

Description

List all data files of this run

Examples

files = run.list_data_files()

Returns

List of ScanFile object

install_requirements

install_requirements()

Description

Install requirements from the run requirements dictionary.

Examples

run.install_requirements()

get_experiment

get_experiment()

Description

Retrieve linked experiment

Examples

my_experiment = run.get_experiment()

Returns

An Experiment object linked to this run

delete

delete()

Description

Delete this run from the platform.

DANGER ZONE: Be very careful here!

Examples

run.delete()