Run

Run


update

Signature

update(
   status: Union[RunStatus, str]
)

Description

Update this run.

Examples

    run.update(status=RunStatus.TERMINATED)

end

Signature

end()

Description

End a run

Examples

    run.end()

get_script

Signature

get_script()

Description

Retrieve the script of this run.

Returns

A ScanFile object


list_data_files

Signature

list_data_files()

Description

List all data files of this run

Examples

    files = run.list_data_files()

Returns

List of ScanFile object


install_requirements

Signature

install_requirements()

Description

Install requirements from the run requirements dictionary.

Examples

    run.install_requirements()

get_experiment

Signature

get_experiment()

Description

Retrieve linked experiment

Examples

    my_experiment = run.get_experiment()

Returns

An Experiment object linked to this run


delete

Signature

delete()

Description

Delete this run from the platform.

:warning: DANGER ZONE: Be very careful here!

Examples

    run.delete()