hpcflow.api package#

Submodules#

hpcflow.api.config module#

Module contents#

hpcflow.api.make_workflow(app, template_file, dir)#

Generate a new hpcflow workflow.

Parameters

  • template_file – Path to YAML file workflow template.

  • dir – Directory into which the workflow will be generated.

Return type

Workflow

class hpcflow.api.Task(schemas, repeats=None, resources=None, inputs=None, input_files=None, sequences=None, input_sources=None, input_source_mode=None, nesting_order=None, element_sets=None, sourceable_elements=None)#
Parameters

  • schemas (Union[TaskSchema, str, List[TaskSchema], List[str]]) –

  • repeats (Optional[Union[int, List[int]]]) –

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

  • inputs (Optional[List[InputValue]]) –

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

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

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

  • input_source_mode (Optional[Union[str, InputSourceType]]) –

  • nesting_order (Optional[List]) –

  • element_sets (Optional[List[ElementSet]]) –

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

previous

hpcflow package

next

hpcflow.app package