pcdsutils.info.Run

class pcdsutils.info.Run(valid: bool = False, live: bool = False, num: int = 0, type: str = '', begin_time: str = '', end_time: str = '', params: ~typing.Dict[str, str] = <factory>, editable_params: ~typing.Dict[str, str] = <factory>, files: ~pcdsutils.info.RunFiles = <factory>)[source]

Run information.

Methods

from_logbook(experiment)

Get Run information given an experiment, queried from the logbook.

__init__(valid: bool = False, live: bool = False, num: int = 0, type: str = '', begin_time: str = '', end_time: str = '', params: ~typing.Dict[str, str] = <factory>, editable_params: ~typing.Dict[str, str] = <factory>, files: ~pcdsutils.info.RunFiles = <factory>) None

Methods

__init__([valid, live, num, type, ...])

from_logbook(experiment)

Get Run information given an experiment, queried from the logbook.

Attributes

begin_time

The run start time.

end_time

The run end time.

live

An in-progress run.

num

The run number.

type

The run type.

valid

Is this valid information, according to the logbook API?

params

Run parameter dictionary.

editable_params

Editable run parameter dictionary.

files

Files for this run.