hpcflow.app.TaskObjective#

class hpcflow.app.TaskObjective(name)#

Bases: TaskObjective

A thing that a task is attempting to achieve.

Parameter#

name: str

The name of the objective. A valid Python identifier.

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

app

name

The name of the objective.
app = BaseApp(name='hpcFlow', version='0.2.0a180')#
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.

name: str#

The name of the objective. A valid Python identifier.

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.

Parameters:

name (str) –