matflow.ElementSet#

class matflow.ElementSet(inputs=None, input_files=None, sequences=None, resources=None, repeats=None, groups=None, input_sources=None, nesting_order=None, env_preset=None, environments=None, sourceable_elem_iters=None, allow_non_coincident_task_sources=False, merge_envs=True)#

Bases: ElementSet

Class to represent a parametrisation of a new set of elements.

Methods

ensure_element_sets

from_json_like

get_defined_parameter_types

get_defined_sub_parameter_types

get_locally_defined_inputs

get_sequence_by_path

get_sequence_from_path

get_task_dependencies

Get upstream tasks that this element set depends on.

is_input_type_provided

Check if an input is provided locally as an InputValue or a ValueSequence.

prepare_persistent_copy

Return a copy of self, which will then be made persistent, and save copies of attributes that may be changed during integration with the workflow.

to_dict

to_json_like

Attributes

app

defined_input_types

elem_iter_IDs

element_iterations

element_local_idx_range

Used to retrieve elements belonging to this element set.

elements

index

input_types

task

task_template

undefined_input_types

Parameters:
  • inputs (Optional[List[app.InputValue]]) –

  • input_files (Optional[List[app.InputFile]]) –

  • sequences (Optional[List[app.ValueSequence]]) –

  • resources (Optional[Dict[str, Dict]]) –

  • repeats (Optional[List[Dict]]) –

  • groups (Optional[List[app.ElementGroup]]) –

  • input_sources (Optional[Dict[str, app.InputSource]]) –

  • nesting_order (Optional[List]) –

  • env_preset (Optional[str]) –

  • environments (Optional[Dict[str, Dict[str, Any]]]) –

  • sourceable_elem_iters (Optional[List[int]]) –

  • allow_non_coincident_task_sources (Optional[bool]) –

  • merge_envs (Optional[bool]) –

app = App(name='MatFlow', version='0.3.0a129')#
property defined_input_types#
property elem_iter_IDs#
property element_iterations#
property element_local_idx_range#

Used to retrieve elements belonging to this element set.

property elements#
classmethod ensure_element_sets(inputs=None, input_files=None, sequences=None, resources=None, repeats=None, groups=None, input_sources=None, nesting_order=None, env_preset=None, environments=None, allow_non_coincident_task_sources=None, element_sets=None, sourceable_elem_iters=None)#
classmethod from_json_like(json_like, shared_data=None)#
Parameters:
  • json_like (Union[Dict, List]) –

  • shared_data (Optional[Dict[str, ObjectList]]) –

get_defined_parameter_types()#
get_defined_sub_parameter_types()#
get_locally_defined_inputs()#
get_sequence_by_path(path)#
get_sequence_from_path(sequence_path)#
get_task_dependencies(as_objects=False)#

Get upstream tasks that this element set depends on.

property index#
property input_types#
is_input_type_provided(labelled_path)#

Check if an input is provided locally as an InputValue or a ValueSequence.

Parameters:

labelled_path (str) –

Return type:

bool

prepare_persistent_copy()#

Return a copy of self, which will then be made persistent, and save copies of attributes that may be changed during integration with the workflow.

property task#
property task_template#
to_dict()#
to_json_like(dct=None, shared_data=None, exclude=None, path=None)#
property undefined_input_types#