hpcflow.sdk.persistence.zarr.ZarrStoreEAR

class hpcflow.sdk.persistence.zarr.ZarrStoreEAR(id_, is_pending, elem_iter_ID, action_idx, commands_idx, data_idx, submission_idx=None, skip=False, success=None, start_time=None, end_time=None, snapshot_start=None, snapshot_end=None, exit_code=None, metadata=None, run_hostname=None)

Bases: StoreEAR

Represents an element action run in a Zarr persistent store.

Methods

decode	Initialise a ZarrStoreEAR from persistent EAR data
encode	Prepare store EAR data for the persistent store.
to_dict	Prepare data for the user-facing ElementActionRun object.
update	Return a shallow copy, with specified data updated.

Attributes

end_time	When this EAR finished, if known.
exit_code	The exit code of the underlying executable, if known.
metadata	Metadata concerning e.g.
run_hostname	Where this EAR was submitted to run, if known.
skip	Whether to skip this EAR.
snapshot_end	Snapshot of files at EAR end, if recorded.
snapshot_start	Snapshot of files at EAR start, if recorded.
start_time	When this EAR started, if known.
submission_idx	Which submission contained this EAR, if known.
success	Whether this EAR was successful, if known.
id_	The ID of this element action run.
is_pending	Whether the element action run has changes not yet persisted.
elem_iter_ID	What element iteration owns this EAR.
action_idx	The task schema action associated with this EAR.
commands_idx	The indices of the commands in the EAR.
data_idx	Maps parameter names within this EAR to parameter data indices.

Parameters:

• id_ (int) –

• is_pending (bool) –

• elem_iter_ID (int) –

• action_idx (int) –

• commands_idx (List[int]) –

• data_idx (Dict[str, int]) –

• submission_idx (int | None) –

• skip (bool | None) –

• success (bool | None) –

• start_time (datetime | None) –

• end_time (datetime | None) –

• snapshot_start (Dict | None) –

• snapshot_end (Dict | None) –

• exit_code (int | None) –

• metadata (Dict[str, Any]) –

• run_hostname (str | None) –

action_idx: int

The task schema action associated with this EAR.

commands_idx: List[int]

The indices of the commands in the EAR.

data_idx: Dict[str, int]

Maps parameter names within this EAR to parameter data indices.

classmethod decode(EAR_dat, attrs, ts_fmt)

Initialise a ZarrStoreEAR from persistent EAR data

Parameters:

• EAR_dat (List) –

• attrs (Dict) –

• ts_fmt (str) –

Return type:

ZarrStoreEAR

elem_iter_ID: int

What element iteration owns this EAR.

encode(attrs, ts_fmt)

Prepare store EAR data for the persistent store.

This method mutates attrs.

Parameters:

• attrs (Dict) –

• ts_fmt (str) –

Return type:

Tuple[List, Tuple[datetime64]]

end_time: datetime | None = None

When this EAR finished, if known.

exit_code: int | None = None

The exit code of the underlying executable, if known.

id_: int

The ID of this element action run.

is_pending: bool

Whether the element action run has changes not yet persisted.

metadata: Dict[str, Any] = None

Metadata concerning e.g. the state of the EAR.

run_hostname: str | None = None

Where this EAR was submitted to run, if known.

skip: bool | None = False

Whether to skip this EAR.

snapshot_end: Dict | None = None

Snapshot of files at EAR end, if recorded.

snapshot_start: Dict | None = None

Snapshot of files at EAR start, if recorded.

start_time: datetime | None = None

When this EAR started, if known.

submission_idx: int | None = None

Which submission contained this EAR, if known.

success: bool | None = None

Whether this EAR was successful, if known.

to_dict()

Prepare data for the user-facing ElementActionRun object.

Return type:

Dict

update(submission_idx=None, skip=None, success=None, start_time=None, end_time=None, snapshot_start=None, snapshot_end=None, exit_code=None, run_hostname=None)

Return a shallow copy, with specified data updated.

Parameters:

• submission_idx (int | None) –

• skip (bool | None) –

• success (bool | None) –

• start_time (datetime | None) –

• end_time (datetime | None) –

• snapshot_start (Dict | None) –

• snapshot_end (Dict | None) –

• exit_code (int | None) –

• run_hostname (str | None) –

Return type:

AnySEAR