hpcflow.app.ElementAction#

class hpcflow.app.ElementAction(element_iteration, action_idx, runs)#

Bases: ElementAction

An abstract representation of an element’s action at a particular iteration and the runs that enact that element iteration.

Parameters:
  • element_iteration – The iteration

  • action_idx – The action index.

  • runs – The list of run indices.

Methods

get

Get the value of a parameter.

get_data_idx

Get the data index for some path/run.

get_parameter_names

Get parameter types associated with a given prefix.

get_parameter_sources

Get information about where parameters originated.

Attributes

action

The abstract task that this is a concrete model of.

action_idx

The index of the action.

app

element

The element for this action.

element_iteration

The iteration for this action.

input_files

The input files to this action.

inputs

The inputs to this action.

num_runs

The number of runs associated with this action.

output_files

The output files from this action.

outputs

The outputs from this action.

runs

The EARs that this action is enacted by.

task

The task that this action is an instance of.

property action#

The abstract task that this is a concrete model of.

property action_idx#

The index of the action.

app = BaseApp(name='hpcFlow', version='0.2.0a181')#
property element#

The element for this action.

property element_iteration#

The iteration for this action.

get(path=None, run_idx=-1, default=None, raise_on_missing=False, raise_on_unset=False)#

Get the value of a parameter.

Parameters:
  • path (str) –

  • run_idx (int) –

  • default (Any) –

  • raise_on_missing (bool) –

  • raise_on_unset (bool) –

get_data_idx(path=None, run_idx=-1)#

Get the data index for some path/run.

Parameters:
  • path (str) –

  • run_idx (int) –

get_parameter_names(prefix)#

Get parameter types associated with a given prefix.

For inputs, labels are ignored. See Action.get_parameter_names() for more information.

Parameters:

prefix (str) – One of “inputs”, “outputs”, “input_files”, “output_files”.

Return type:

List[str]

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

Get information about where parameters originated.

Parameters:
  • path (str) –

  • run_idx (int) –

  • typ (str) –

  • as_strings (bool) –

  • use_task_index (bool) –

property input_files#

The input files to this action.

property inputs#

The inputs to this action.

property num_runs#

The number of runs associated with this action.

property output_files#

The output files from this action.

property outputs#

The outputs from this action.

property runs#

The EARs that this action is enacted by.

property task#

The task that this action is an instance of.