matflow.submit_workflow#

matflow.submit_workflow(workflow_path, JS_parallelism=None, wait=False, return_idx=False, tasks=None)#

Submit an existing MatFlow workflow.

Parameters:
  • workflow_path (PathLike) – Path to an existing workflow

  • 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.

  • tasks (List[int] | None) – List of task indices to include in this submission. By default all tasks are included.

  • wait (bool | None) –

  • return_idx (bool | None) –

Return type:

Dict[int, int]