API Reference¶
This is the API for the signac-flow application.
Command Line Interface¶
Some core signac-flow functions are—in addition to the Python interface—accessible
directly via the $ flow
command.
For more information, please see $ flow --help
.
usage: flow [-h] [--debug] [--version] {init} ...
flow provides the basic components to set up workflows for projects as part of
the signac framework.
positional arguments:
{init}
init Initialize a signac-flow project.
optional arguments:
-h, --help show this help message and exit
--debug Show traceback on error for debugging.
--version Display the version number and exit.
The FlowProject¶
Attributes
FlowProject.ALIASES |
|
FlowProject.add_operation |
|
FlowProject.classify |
|
FlowProject.completed_operations |
|
FlowProject.eligible_for_submission |
|
FlowProject.export_job_stati |
|
FlowProject.get_job_status |
|
FlowProject.label |
|
FlowProject.labels |
|
FlowProject.main |
|
FlowProject.next_operation |
|
FlowProject.next_operations |
|
FlowProject.operation |
|
FlowProject.operations |
|
FlowProject.post |
|
FlowProject.post.always |
|
FlowProject.post.copy_from |
|
FlowProject.post.false |
|
FlowProject.post.isfile |
|
FlowProject.post.never |
|
FlowProject.post.not_ |
|
FlowProject.post.true |
|
FlowProject.pre |
|
FlowProject.pre.after |
|
FlowProject.pre.always |
|
FlowProject.pre.copy_from |
|
FlowProject.pre.false |
|
FlowProject.pre.isfile |
|
FlowProject.pre.never |
|
FlowProject.pre.not_ |
|
FlowProject.pre.true |
|
FlowProject.run |
|
FlowProject.run_operations |
|
FlowProject.scheduler_jobs |
|
FlowProject.script |
|
FlowProject.submit |
|
FlowProject.submit_operations |
|
FlowProject.update_aliases |