SLIPO model for Jupyter notebooks

class slipoframes.model.StepFile(process: dict, execution: dict, step_file: dict)[source]

A class that wraps the dict with step file data returned by the API

Parameters

  • process (dict) – Parent process data

  • execution (dict) – Process execution instance

  • step_file (dict) – Step file data

Returns

A StepFile object.

id

Get step file unique id

output_part_key

Get step file output part key

class slipoframes.model.Process(record: dict)[source]

A class that wraps the dict with process data returned by the API

Parameters

record (dict) – Process execution data

Returns

A Process object.

process

Get process dict

execution

Get execution dict

id

Get process unique id

version

Get process version

status

Get process status

files(format_size: bool = False)[source]

Get all operation files

Parameters

format_size (bool, optional) – If True, the file size is converted to a user friendly string (default False).

Returns

A pandas.DataFrame with all files

output(output_part_key=None) → slipoframes.model.StepFile[source]

Returns a StepFile for the default process output.

Parameters

output_part_key (str, optional) – The output part key of the output file. If value is not set, the default output part key for the specific SLIPO Toolkit component is used.

Returns

A StepFile. If the process has multiple output steps or the output part key does not exist, None is returned.