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`	An atomic component of a workflow that will be enacted within an iteration structure.
`ActionEnvironment`	The environment that an action is enacted within.
`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`	Types of action scope.
`Command`	A command that may be run within a workflow action.
`CommandFilesList`	A list-like container for command files with dot-notation access by label.
`DirectPosix`	A direct scheduler for POSIX systems.
`DirectWindows`	A direct scheduler for Windows.
`Element`	A basic component of a workflow.
`ElementAction`	An abstract representation of an element's action at a particular iteration and the runs that enact that element iteration.
`ElementActionRun`	The Element Action Run (EAR) is an atomic unit of an enacted workflow, representing one unit of work (e.g., particular submitted job to run a program) within that overall workflow.
`ElementFilter`	A filter for iterations.
`ElementGroup`	A grouping rule for element iterations.
`ElementInputFiles`	The input files to an element.
`ElementInputs`	The inputs to an element.
`ElementIteration`	A particular iteration of an element.
`ElementOutputFiles`	The output files from an element.
`ElementOutputs`	The outputs from an element.
`ElementParameter`	A parameter to an `Element`.
`ElementPropagation`	Class to represent how a newly added element set should propagate to a given downstream task.
`ElementRepeats`	A repetition rule.
`ElementResources`	The resources an element requires.
`ElementSet`	Class to represent a parameterisation of a new set of elements.
`Elements`	The elements of a task.
`Environment`	An execution environment that contains a number of executables.
`EnvironmentsList`	A list-like container for environments with dot-notation access by name.
`Executable`	A program managed by the environment.
`ExecutableInstance`	A particular instance of an executable that can support some mode of operation.
`ExecutablesList`	A list-like container for environment executables with dot-notation access by executable label.
`FileNameExt`	The extension of a file name.
`FileNameSpec`	The name of a file handled by a workflow, or a pattern that matches multiple files.
`FileNameStem`	The stem of a file name.
`FileSpec`	A specification of a file handled by a workflow.
`GroupList`	A list-like container for the task schema group list with dot-notation access by group name.
`InputFile`	An input file.
`InputFileGenerator`	Represents a script that is run to generate input files for an action.
`InputFileGeneratorSource`	The source of code for use in an input file generator.
`InputSource`	An input source to a workflow task.
`InputSourceType`	The types if input sources.
`InputValue`	An input value to a task.
`Jobscript`	A group of actions that are submitted together to be executed by the underlying job management system as a single unit.
`Loop`	A loop in a workflow template.
`NumCores`	A range of cores supported by an executable instance.
`OutputFileParser`	Represents a script that is run to parse output files from an action and create outputs.
`OutputFileParserSource`	The source of code for use in an output file parser.
`OutputLabel`	Schema input labels that should be applied to a subset of task outputs.
`Parameter`	A general parameter to a workflow task.
`ParameterPath`	Path to a parameter.
`ParameterPropagationMode`	How a parameter is propagated.
`ParameterValue`	The value handler for a parameter.
`Parameters`	The parameters of a (workflow-bound) task.
`ParametersList`	A list-like container for parameters with dot-notation access by parameter type.
`ResourceList`	A list-like container for resources.
`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`	A scheduler that uses SGE.
`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`	A parameter bound in a schema.
`SlurmPosix`	A scheduler that uses SLURM.
`SubParameter`	A parameter that is a component of another parameter.
`Submission`	A collection of jobscripts to be submitted to a scheduler.
`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`	A thing that a task is attempting to achieve.
`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`	The types of task-based input sources.
`TaskTemplateList`	A list-like container for a task-like list with dot-notation access by task unique-name.
`ValuePerturbation`	A perturbation applied to a value.
`ValueSequence`	A sequence of values.
`Workflow`	A concrete workflow.
`WorkflowBlueprint`	Pre-built workflow templates that are simpler to parameterise.
`WorkflowLoop`	Class to represent a `Loop` that is bound to a `Workflow`.
`WorkflowLoopList`	A list-like container for workflow loops with dot-notation access by name.
`WorkflowTask`	Represents a `Task` that is bound to a `Workflow`.
`WorkflowTaskList`	A list-like container for workflow tasks with dot-notation access by unique name.
`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`