hpcflow.app.ElementFilter

class hpcflow.app.ElementFilter(rules=<factory>)

Bases: ElementFilter

A filter for iterations.

Parameters:

rules (list[Rule]) – The filtering rules to use.

Methods

filter	Apply the filter rules to select a subsequence of iterations.
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

app
rules	The filtering rules to use.

app = BaseApp(name='hpcFlow', version='0.2.0a180')

filter(element_iters)

Apply the filter rules to select a subsequence of iterations.

Parameters:

element_iters (List[ElementIteration]) –

Return type:

List[ElementIteration]

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.

rules: List[app.Rule]

The filtering rules to use.

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.