hpcflow.sdk.core.task.OutputLabel

class hpcflow.sdk.core.task.OutputLabel(parameter, label, where=None)

Bases: JSONLike

Schema input labels that should be applied to a subset of task outputs.

Parameters:

• parameter (str) – Name of a parameter.

• label (str) – Label to apply to the parameter.

• where (ElementFilter) – Optional filtering rule

Methods

from_json_like	Make an instance of this class from JSON (or YAML) data.
to_dict	Serialize this object as a dictionary.
to_json_like	Serialize this object as an object structure that can be trivially converted to JSON.

Attributes

parameter	Name of a parameter.
label	Label to apply to the parameter.
where	Filtering rule.

classmethod from_json_like(json_like, shared_data=None)

Make an instance of this class from JSON (or YAML) data.

Parameters:

• json_like (Union[Dict, List]) – The data to deserialise.

• shared_data (Optional[Dict[str, ObjectList]]) – Shared context data.

Return type:

The deserialised object.

label

Label to apply to the parameter.

parameter

Name of a parameter.

to_dict()

Serialize this object as a dictionary.

to_json_like(dct=None, shared_data=None, exclude=None, path=None)

Serialize this object as an object structure that can be trivially converted to JSON. Note that YAML can also be produced from the result of this method; it just requires a different final serialization step.

where

Filtering rule.