openlifu.plan.run.Run

class openlifu.plan.run.Run(id: Annotated[str | None, OpenLIFUFieldData('Run ID', 'ID of the run')] = None, name: Annotated[str | None, OpenLIFUFieldData('Run name', 'Name of the run')] = None, success_flag: Annotated[bool | None, OpenLIFUFieldData('Success?', 'True when run was successful, False otherwise')] = None, note: Annotated[str | None, OpenLIFUFieldData('Run notes', 'Large text containing notes about the run')] = None, session_id: Annotated[str | None, OpenLIFUFieldData('Session ID', 'Session ID')] = None, solution_id: Annotated[str | None, OpenLIFUFieldData('Solution ID', 'Solution ID')] = None)

Bases: object

Class representing a run

static from_file(filename)

Create a Run from a file

Parameters:

filename – Name of the file to read

Returns:

Run object

static from_json(json_string: str) → Run

Load a Run from a json string

id: Annotated[str | None, OpenLIFUFieldData('Run ID', 'ID of the run')] = None

ID of the run

name: Annotated[str | None, OpenLIFUFieldData('Run name', 'Name of the run')] = None

Name of the run

note: Annotated[str | None, OpenLIFUFieldData('Run notes', 'Large text containing notes about the run')] = None

Large text containing notes about the run

session_id: Annotated[str | None, OpenLIFUFieldData('Session ID', 'Session ID')] = None

Session ID

solution_id: Annotated[str | None, OpenLIFUFieldData('Solution ID', 'Solution ID')] = None

Solution ID

success_flag: Annotated[bool | None, OpenLIFUFieldData('Success?', 'True when run was successful, False otherwise')] = None

True when run was successful, False otherwise

to_dict()

Convert the run to a dictionary

Returns:

Dictionary of run parameters

to_file(filename)

Save the Run to a file

Parameters:

filename – Name of the file

to_json(compact: bool) → str

Serialize a Run to a json string

Parameters:

compact – if enabled then the string is compact (not pretty). Disable for pretty.

Returns: A json string representing the complete Run object.