hpcflow.app.ElementIteration#

class hpcflow.app.ElementIteration(index, element, data_idx, EARs_initialised, actions, global_idx, schema_parameters, loop_idx)#

Bases: ElementIteration

Methods

get

Get element data from the persistent store.

get_EAR_dependencies

Get EARs that this element iteration depends on (excluding EARs of this element iteration).

get_data_idx

param action_idx:

The index of the action within the schema.

get_dependent_EARs

Get EARs of downstream iterations and tasks that depend on this element iteration.

get_dependent_element_iterations

Get elements iterations of downstream iterations and tasks that depend on this element iteration.

get_dependent_elements

Get elements of downstream tasks that depend on this element iteration.

get_dependent_tasks

Get downstream tasks that depend on this element iteration.

get_element_dependencies

Get elements that this element iteration depends on.

get_element_iteration_dependencies

Get element iterations that this element iteration depends on.

get_input_dependencies

Get locally defined inputs/sequences/defaults from other tasks that this element iteration depends on.

get_parameter_names

get_parameter_sources

param use_task_index:

If True, use the task index within the workflow, rather than the task insert

get_task_dependencies

Get tasks (insert ID or WorkflowTask objects) that this element iteration depends on.

Attributes

EARs_initialised

Whether or not the EARs have been initialised.

action_runs

Get a list of element action runs, where only the final run is taken for each element action.

actions

app

data_idx

The overall element iteration data index, before resolution of EARs.

element

global_idx

index

input_files

inputs

iteration_ID

loop_idx

output_files

outputs

schema_parameters

task

workflow

Parameters:

  • index (int) –

  • element (app.Element) –

  • data_idx (Dict) –

  • EARs_initialised (bool) –

  • actions (List[Dict]) –

  • global_idx (int) –

  • schema_parameters (List[str]) –

  • loop_idx (Dict) –

property EARs_initialised#

Whether or not the EARs have been initialised.

property action_runs: List[ElementActionRun]#

Get a list of element action runs, where only the final run is taken for each element action.

property actions: Dict[app.ElementAction]#
app = BaseApp(name='hpcFlow', version='0.2.0a44')#
property data_idx#

The overall element iteration data index, before resolution of EARs.

property element#
get(path=None, action_idx=None, run_idx=-1, default=None, raise_on_missing=False)#

Get element data from the persistent store.

Parameters:

  • path (str | None) –

  • action_idx (int | None) –

  • run_idx (int) –

  • default (Any | None) –

  • raise_on_missing (bool) –

Return type:

Any

get_EAR_dependencies(as_objects=False)#

Get EARs that this element iteration depends on (excluding EARs of this element iteration).

Parameters:

as_objects (bool | None) –

Return type:

List[EAR_ID | ElementActionRun]

get_data_idx(path=None, action_idx=None, run_idx=-1)#
Parameters:

  • action_idx (int | None) – The index of the action within the schema.

  • path (str | None) –

  • run_idx (int) –

Return type:

Dict[str, int]

get_dependent_EARs(as_objects=False)#

Get EARs of downstream iterations and tasks that depend on this element iteration.

Parameters:

as_objects (bool) –

Return type:

List[EAR_ID | ElementActionRun]

get_dependent_element_iterations(as_objects=False)#

Get elements iterations of downstream iterations and tasks that depend on this element iteration.

Parameters:

as_objects (bool) –

Return type:

List[IterationID | ElementIteration]

get_dependent_elements(as_objects=False)#

Get elements of downstream tasks that depend on this element iteration.

Parameters:

as_objects (bool) –

Return type:

List[ElementID | Element]

get_dependent_tasks(as_objects=False)#

Get downstream tasks that depend on this element iteration.

Parameters:

as_objects (bool) –

Return type:

List[int | WorkflowTask]

get_element_dependencies(as_objects=False)#

Get elements that this element iteration depends on.

Parameters:

as_objects (bool | None) –

Return type:

List[ElementID | Element]

get_element_iteration_dependencies(as_objects=False)#

Get element iterations that this element iteration depends on.

Parameters:

as_objects (bool) –

Return type:

List[IterationID | ElementIteration]

get_input_dependencies()#

Get locally defined inputs/sequences/defaults from other tasks that this element iteration depends on.

Return type:

Dict[str, Dict]

get_parameter_names(prefix)#
Parameters:

prefix (str) –

Return type:

List[str]

get_parameter_sources(path=None, action_idx=None, run_idx=-1, typ=None, as_strings=False, use_task_index=False)#
Parameters:

  • use_task_index (bool) – If True, use the task index within the workflow, rather than the task insert ID.

  • path (str | None) –

  • action_idx (int | None) –

  • run_idx (int) –

  • typ (str | None) –

  • as_strings (bool) –

Return type:

Dict[str, str | Dict[str, Any]]

get_task_dependencies(as_objects=False)#

Get tasks (insert ID or WorkflowTask objects) that this element iteration depends on.

Dependencies may come from either elements from upstream tasks, or from locally defined inputs/sequences/defaults from upstream tasks.

Parameters:

as_objects (bool) –

Return type:

List[int | WorkflowTask]

property global_idx: int#
property index#
property input_files: ElementInputFiles#
property inputs: ElementInputs#
property iteration_ID#
property loop_idx: Dict[str, int]#
property output_files: ElementOutputFiles#
property outputs: ElementOutputs#
property schema_parameters: List[str]#
property task#
property workflow#