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 | Literal['direct', 'scheduled'] | None) – If True, allow multiple jobscripts to execute simultaneously. If ‘scheduled’/’direct’, only allow simultaneous execution of scheduled/direct jobscripts. Raises if set to True, ‘scheduled’, or ‘direct’, 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, for scheduled jobscripts only.

  • wait (bool) – Whether to wait for the submission to complete.

  • return_idx (bool) – Whether to return the index information.

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

Returns:

Mapping of submission handles, if requested by return_idx parameter.

Return type:

dict[int, list[int]]