matflow.JobscriptBlock

class matflow.JobscriptBlock(index, task_insert_IDs, task_loop_idx, task_actions=None, task_elements=None, EAR_ID=None, dependencies=None, jobscript=None)

Bases: JobscriptBlock

A rectangular block of element-actions to run within a jobscript.

Parameters:

• task_insert_IDs (list[int]) – The task insertion IDs.

• task_actions (list[tuple]) – The actions of the tasks. task insert ID, action_idx, index into task_loop_idx for each JS_ACTION_IDX

• task_elements (dict[int, list[int]]) – The elements of the tasks. Maps JS_ELEMENT_IDX to list of TASK_ELEMENT_IDX for each TASK_INSERT_ID

• EAR_ID (NDArray | None) – Element action run information.

• task_loop_idx (list[dict]) – Description of what loops are in play.

• dependencies (dict[tuple[int, int], dict]) – Description of dependencies. Keys are tuples of (jobscript index, jobscript-block index) of the dependency.

• index (int) – The index of the block within the parent jobscript.

• jobscript (Jobscript) – The parent jobscript.

Methods

from_json_like	Make an instance of this class from JSON (or YAML) data.
get_task_loop_idx_array	Get an array of task loop indices.
task_element_indices	Yield tuples of task insert ID and task element index for a given jobscript element index.
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.
write_EAR_ID_file	Write a text file with num_elements lines and num_actions delimited tokens per line, representing whether a given EAR must be executed.

Attributes

EAR_ID	The array of EAR IDs in this jobscript-block.
all_EARs	Description of EAR information for this jobscript-block.
dependencies	The dependency descriptor.
index
num_actions	The maximal number of actions in the jobscript-block.
num_elements	The maximal number of elements in the jobscript-block.
submission
task_actions	The IDs of actions of each task in this jobscript-block.
task_elements	The IDs of elements of each task in this jobscript-block.
task_insert_IDs	The insertion IDs of tasks in this jobscript-block.
task_loop_idx	The description of where various task loops are.
workflow	The associated workflow.

property EAR_ID: NDArray

The array of EAR IDs in this jobscript-block.

property all_EARs: Sequence[ElementActionRun]

Description of EAR information for this jobscript-block.

property dependencies: Mapping[tuple[int, int], ResolvedJobscriptBlockDependencies]

The dependency descriptor.

classmethod from_json_like(json_like, shared_data=None)

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

Parameters:

• json_like – The data to deserialise.

• shared_data – Shared context data.

Return type:

The deserialised object.

get_task_loop_idx_array()

Get an array of task loop indices.

Return type:

NDArray

property index: int

property num_actions: int

The maximal number of actions in the jobscript-block.

property num_elements: int

The maximal number of elements in the jobscript-block.

property submission: Submission

property task_actions: NDArray

The IDs of actions of each task in this jobscript-block.

task_element_indices(js_elem_idx)

Yield tuples of task insert ID and task element index for a given jobscript element index.

Parameters:

js_elem_idx (int) –

Return type:

Iterator[tuple[int, int]]

property task_elements: Mapping[int, Sequence[int]]

The IDs of elements of each task in this jobscript-block.

property task_insert_IDs: Sequence[int]

The insertion IDs of tasks in this jobscript-block.

property task_loop_idx: Sequence[Mapping[str, int]]

The description of where various task loops are.

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]

property workflow: Workflow

The associated workflow.

write_EAR_ID_file(fp)

Write a text file with num_elements lines and num_actions delimited tokens per line, representing whether a given EAR must be executed.

Parameters:

fp (TextIO) –