m3resp.ProcessingStep#

class m3resp.ProcessingStep(name, input_keys=<factory>, output_keys=<factory>, parameters=<factory>, software='m3resp', version=None, optional_package_versions=<factory>, timestamp=<factory>, status='succeeded')[source]#

A record of one executed processing operation.

Variables:

name (str) – Operation name.
input_keys (list[str]) – Names of values read by the step.
output_keys (list[str]) – Names of values written by the step.
parameters (dict[str, Any]) – Settings used for the operation.
software (str) – Software name; defaults to m3resp.
version (str | None) – Optional software version.
optional_package_versions (dict[str, str | None]) – Installed versions of declared optional packages, or None when a version is unavailable.
timestamp (str) – ISO 8601 UTC timestamp; defaults to the current time.
status (str) – Outcome of the step, such as succeeded, failed or cancelled.

Parameters:

name (str)
input_keys (list[str])
output_keys (list[str])
parameters (dict[str, Any])
software (str)
version (str | None)
optional_package_versions (dict[str, str | None])
timestamp (str)
status (str)

Methods

to_dict

Attributes

`software`
`status`	Step outcome, such as succeeded, failed or cancelled.
`version`
`name`
`input_keys`
`output_keys`
`parameters`
`optional_package_versions`	Installed version of each optional upstream package (e.g. `resurfemg`, `eitprocessing`) this step's operation declared a dependency on, or `None` if that package wasn't importable when the step ran.
`timestamp`

input_keys: list[str]#

name: str#

optional_package_versions: dict[str, str | None]#: Installed version of each optional upstream package (e.g. resurfemg, eitprocessing) this step’s operation declared a dependency on, or None if that package wasn’t importable when the step ran. Without this, exact reconstruction of a step’s numeric output isn’t possible even with deterministic code, since an upstream library upgrade between runs can change results under the same operation name and parameters.

output_keys: list[str]#

parameters: dict[str, Any]#

software: str = 'm3resp'#

status: str = 'succeeded'#: Step outcome, such as succeeded, failed or cancelled.

timestamp: str#

to_dict()[source]#

Return type:: dict[str, Any]

version: str | None = None#