hpcflow.app.make_and_submit_demo_workflow#
- hpcflow.app.make_and_submit_demo_workflow(workflow_name, template_format=None, path=None, name=None, overwrite=False, store='zarr', ts_fmt=None, ts_name_fmt=None, JS_parallelism=None, wait=False)#
Generate and submit a new hpcFlow workflow from a file or string containing a workflow template parametrisation.
- Parameters:
workflow_name (str) – Name of the demo workflow to make.
template_format (str | None) – If specified, one of “json” or “yaml”. This forces parsing from a particular format.
path (PathLike | None) – The directory in which the workflow will be generated. The current directory if not specified.
name (str | None) – The name of the workflow. If specified, the workflow directory will be path joined with name. If not specified the WorkflowTemplate name will be used, in combination with a date-timestamp.
overwrite (bool | None) – If True and the workflow directory (path + name) already exists, the existing directory will be overwritten.
store (str | None) – The persistent store to use for this workflow.
ts_fmt (str | None) – 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 (str | None) – The datetime format to use when generating the workflow name, where it includes a timestamp.
JS_parallelism (bool | None) – If True, allow multiple jobscripts to execute simultaneously. Raises if set to True but the store type does not support the jobscript_parallelism feature. If not set, jobscript parallelism will be used if the store type supports it.
wait (bool | None) – If True, this command will block until the workflow execution is complete.
- Return type: