hpcflow.sdk.core.environment.NumCores#

class hpcflow.sdk.core.environment.NumCores(start, stop, step=1)#

Bases: JSONLike

A range of cores supported by an executable instance.

Parameters:

  • start (int) – The minimum number of cores supported.

  • stop (int) – The maximum number of cores supported.

  • step (int) – The step in the number of cores supported. Defaults to 1.

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

step

The step in the number of cores supported.

start

The minimum number of cores supported.

stop

The maximum number of cores supported.
classmethod from_json_like(json_like, shared_data=None)#

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

Parameters:

  • json_like (str | Mapping[str, JSONed] | Sequence[Mapping[str, JSONed]] | None) – The data to deserialise.

  • shared_data (Mapping[str, ObjectList[JSONable]] | None) – Shared context data.

Return type:

The deserialised object.

start: int#

The minimum number of cores supported.

step: int = 1#

The step in the number of cores supported. Normally 1.

stop: int#

The maximum number of cores supported.

to_dict()#

Serialize this object as a dictionary.

Return type:

dict[str, Any]

to_json_like(dct=None, shared_data=None, exclude=(), 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:

  • dct (dict[str, JSONable] | None) –

  • shared_data (_JSONDeserState) –

  • exclude (Container[str | None]) –

  • path (list | None) –

Return type:

tuple[JSONDocument, _JSONDeserState]