hpcflow.api package#

Submodules#

hpcflow.api.config module#

Module contents#

hpcflow.api.make_workflow(app, template_file_or_str, is_string=False, template_format='yaml', path=None, name=None, overwrite=False, store='zarr', ts_fmt=None, ts_name_fmt=None)#

Generate a new hpcflow workflow from a file or string containing a workflow template parametrisation.

Parameters

  • template_path_or_str – Either a path to a template file in YAML or JSON format, or a YAML/JSON string.

  • is_string (Optional[bool]) – Determines if passing a file path or a string.

  • template_format (Optional[str]) – If specified, one of “json” or “yaml”. This forces parsing from a particular format.

  • path (Optional[PathLike]) – The directory in which the workflow will be generated. The current directory if not specified.

  • name (Optional[str]) – The name of the workflow. If specified, the workflow directory will be path joined with name. If not specified the workflow template name will be used, in combination with a date-timestamp.

  • overwrite (Optional[bool]) – If True and the workflow directory (path + name) already exists, the existing directory will be overwritten.

  • store (Optional[str]) – The persistent store type to use.

  • ts_fmt (Optional[str]) – The datetime format to use for storing datetimes. Datetimes are always stored in UTC (because Numpy does not store time zone info), so this should not include a time zone name.

  • ts_name_fmt (Optional[str]) – The datetime format to use when generating the workflow name, where it includes a timestamp.

  • app (App) –

  • template_file_or_str (Union[PathLike, str]) –

Return type

Workflow

class hpcflow.api.Task(schemas, repeats=None, resources=None, inputs=None, input_files=None, sequences=None, input_sources=None, nesting_order=None, element_sets=None, sourceable_elem_iters=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]]) –

  • nesting_order (Optional[List]) –

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

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

previous

hpcflow package

next

hpcflow.app package