matflow#

Module attributes

app

Functions

`cancel`	Cancel the execution of a workflow submission.
`get_OS_info`	Get information about the operating system.
`get_known_submissions`	Retrieve information about active and recently inactive finished MatFlow workflows.
`get_shell_info`	Get information about a given shell and the operating system.
`make_and_submit_demo_workflow`	Generate and submit a new MatFlow workflow from a file or string containing a workflow template parametrisation.
`make_and_submit_workflow`	Generate and submit a new MatFlow workflow from a file or string containing a workflow template parametrisation.
`make_demo_workflow`	Generate a new MatFlow workflow from a builtin demo workflow template.
`make_workflow`	Generate a new MatFlow workflow from a file or string containing a workflow template parametrisation.
`run_hpcflow_tests`	Run hpcflow test suite.
`run_tests`	Run MatFlow test suite.
`show`	Show information about running MatFlow workflows.
`show_legend`	"Output a legend for the jobscript-element and EAR states that are displayed by the show command.
`submit_workflow`	Submit an existing MatFlow workflow.

Classes

`Action`
`ActionEnvironment`
`ActionRule`	Class to represent a rule/condition that must be True if an action is to be included.
`ActionScope`	Class to represent the identification of a subset of task schema actions by a filtering process.
`ActionScopeType`
`Command`
`CommandFilesList`	A list-like container for command files with dot-notation access by label.
`DirectPosix`
`DirectWindows`
`Element`
`ElementAction`
`ElementActionRun`
`ElementFilter`
`ElementGroup`
`ElementInputFiles`
`ElementInputs`
`ElementIteration`
`ElementOutputFiles`
`ElementOutputs`
`ElementParameter`
`ElementPropagation`	Class to represent how a newly added element set should propagate to a given downstream task.
`ElementRepeats`
`ElementResources`
`ElementSet`	Class to represent a parametrisation of a new set of elements.
`Elements`
`Environment`
`EnvironmentsList`	A list-like container for environments with dot-notation access by name.
`Executable`
`ExecutableInstance`
`ExecutablesList`	A list-like container for environment executables with dot-notation access by executable label.
`FileNameExt`
`FileNameSpec`
`FileNameStem`
`FileSpec`
`GroupList`	A list-like container for the task schema group list with dot-notation access by group name.
`InputFile`
`InputFileGenerator`
`InputFileGeneratorSource`
`InputSource`
`InputSourceType`
`InputValue`	param parameter: Parameter whose value is to be specified
`Jobscript`
`Loop`
`NumCores`
`OutputFileParser`	param output: The singular output parsed by this parser. Not to be confused with outputs (plural).
`OutputFileParserSource`
`OutputLabel`	Class to represent schema input labels that should be applied to a subset of task outputs
`Parameter`
`ParameterPath`
`ParameterPropagationMode`
`ParameterValue`
`Parameters`
`ParametersList`	A list-like container for parameters with dot-notation access by parameter type.
`ResourceList`
`ResourceSpec`	Class to represent specification of resource requirements for a (set of) actions.
`Rule`	Class to represent a testable condition on an element iteration or run.
`RunDirAppFiles`	A class to encapsulate the naming/recognition of app-created files within run directories.
`SGEPosix`	Notes
`SchemaInput`	A Parameter as used within a particular schema, for which a default value may be applied.
`SchemaOutput`	A Parameter as outputted from particular task.
`SchemaParameter`
`SlurmPosix`	Notes
`SubParameter`
`Submission`
`Task`	Parametrisation of an isolated task for which a subset of input values are given "locally".
`TaskInputParameters`	For retrieving schema input parameters across all elements.
`TaskList`	A list-like container for a task-like list with dot-notation access by task unique-name.
`TaskObjective`
`TaskOutputParameters`	For retrieving schema output parameters across all elements.
`TaskSchema`	Class to represent the inputs, outputs and implementation mechanism of a given task.
`TaskSchemasList`	A list-like container for a task schema list with dot-notation access by task schema unique-name.
`TaskSourceType`
`TaskTemplateList`	A list-like container for a task-like list with dot-notation access by task unique-name.
`ValuePerturbation`
`ValueSequence`
`Workflow`
`WorkflowBlueprint`	Pre-built workflow templates that are simpler to parametrise (e.g.
`WorkflowLoop`	Class to represent a Loop that is bound to a Workflow.
`WorkflowLoopList`
`WorkflowTask`	Class to represent a Task that is bound to a Workflow.
`WorkflowTaskList`
`WorkflowTemplate`	Class to represent initial parametrisation of a MatFlow workflow, with limited validation logic.

`matflow.cli`
`matflow.param_classes`	Note: this sub-package is not called parameters because it would conflict with matflow.parameters, which is a list-like container of Parameter objects.
`matflow.tests`