matflow.submit_workflow#

matflow.submit_workflow(workflow_path, JS_parallelism=None, min_jobscripts=True, modify_js=False, wait=False, return_idx=False, tasks=None, quiet=False, timeit=False)#

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.

  • min_jobscripts (bool) – If True (the default), minimise the total number of jobscripts by performing as many merges as possible. This may merge otherwise independent jobscripts, such that they are run sequentially rather than in parallel.

  • modify_js (bool) – If True, pause before submitting each jobscript, print the new jobscript’s path and await confirmation before continuing submission. This allows ad hoc modifications to the jobscript to be made.

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

  • quiet (bool) – If True, do not print anything about submission.

  • timeit (bool) – Time run execution function pathways as the code executes and write out a summary to the app-std file. Only functions decorated by TimeIt.decorator are included.

Returns:

Mapping of submission handles, if requested by return_idx parameter.

Return type:

dict[int, list[int]]