matflow.Submission#

class matflow.Submission(index, jobscripts, workflow=None, submission_parts=None, JS_parallelism=None, environments=None)#

Bases: Submission

Methods

`cancel`
`from_json_like`
`get_active_jobscripts`	Get jobscripts that are active on this machine, and their active states.
`get_end_time`	Get the end time of a given submission part.
`get_start_time`	Get the start time of a given submission part.
`get_unique_schedulers`	Get unique schedulers and which of this submission's jobscripts they correspond to.
`get_unique_schedulers_of_jobscripts`	Get unique schedulers and which of the passed jobscripts they correspond to.
`get_unique_shells`	Get unique shells and which jobscripts they correspond to.
`submit`	Generate and submit the jobscripts of this submission.
`to_dict`
`to_json_like`

Attributes

`EARs_by_elements`
`JS_parallelism`
`abort_EARs_file_name`
`abort_EARs_file_path`
`all_EAR_IDs`
`all_EARs`
`app`
`end_time`	Get the final non-None end time over all submission parts.
`environments`
`index`
`jobscript_indices`	All associated jobscript indices.
`jobscripts`
`needs_submit`
`outstanding_jobscripts`	Jobscript indices that have not yet been successfully submitted.
`path`
`start_time`	Get the first non-None start time over all submission parts.
`status`
`submission_parts`
`submitted_jobscripts`	Jobscript indices that have been successfully submitted.
`workflow`

Parameters:

index (int) –
jobscripts (List[app.Jobscript]) –
workflow (Optional[app.Workflow]) –
submission_parts (Optional[Dict]) –
JS_parallelism (Optional[bool]) –
environments (Optional[app.EnvironmentsList]) –

property EARs_by_elements#

property JS_parallelism#

property abort_EARs_file_name#

property abort_EARs_file_path#

property all_EAR_IDs#

property all_EARs#

app = App(name='MatFlow', version='0.3.0a129')#

cancel()#

property end_time#: Get the final non-None end time over all submission parts.

property environments: EnvironmentsList#

classmethod from_json_like(json_like, shared_data=None)#

Parameters:

json_like (Union[Dict, List]) –
shared_data (Optional[Dict[str, ObjectList]]) –

get_active_jobscripts(as_json=False)#

Get jobscripts that are active on this machine, and their active states.

Parameters:: as_json (bool) –
Return type:: List[Tuple[int, Dict[int, JobscriptElementState]]]

get_end_time(submit_time)#

Get the end time of a given submission part.

Parameters:: submit_time (str) –
Return type:: Union[datetime, None]

get_start_time(submit_time)#

Get the start time of a given submission part.

Parameters:: submit_time (str) –
Return type:: Union[datetime, None]

get_unique_schedulers()#

Get unique schedulers and which of this submission’s jobscripts they correspond to.

Return type:: Dict[Tuple[int], Scheduler]

static get_unique_schedulers_of_jobscripts(jobscripts)#

Get unique schedulers and which of the passed jobscripts they correspond to.

Uniqueness is determines only by the Scheduler.unique_properties tuple.

Parameters:: jobscripts (List[Jobscript]) –
Return type:: Dict[Tuple[Tuple[int, int]], Scheduler]

get_unique_shells()#

Get unique shells and which jobscripts they correspond to.

Return type:: Dict[Tuple[int], Shell]

property index: int#

property jobscript_indices: Tuple[int]#: All associated jobscript indices.

property jobscripts: List#

property needs_submit#

property outstanding_jobscripts: Tuple[int]#: Jobscript indices that have not yet been successfully submitted.

property path#

property start_time#: Get the first non-None start time over all submission parts.

property status#

property submission_parts: List[Dict]#

submit(status, ignore_errors=False, print_stdout=False, add_to_known=True)#

Generate and submit the jobscripts of this submission.

Parameters:

ignore_errors (bool | None) –
print_stdout (bool | None) –
add_to_known (bool | None) –

Return type:

List[int]

property submitted_jobscripts: Tuple[int]#: Jobscript indices that have been successfully submitted.

to_dict()#

to_json_like(dct=None, shared_data=None, exclude=None, path=None)#

property workflow: List#