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.NAMES
FlowProject.OPERATION_STATUS_SYMBOLS
FlowProject.PRETTY_OPERATION_STATUS_SYMBOLS
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.map_scheduler_jobs
FlowProject.next_operation
FlowProject.next_operations
FlowProject.operation
FlowProject.operations
FlowProject.post
FlowProject.pre
FlowProject.run
FlowProject.run_operations
FlowProject.scheduler_jobs
FlowProject.script
FlowProject.submit
FlowProject.submit_operations
FlowProject.update_aliases

@flow.cmd

@flow.with_job

@flow.directives

flow.run()

flow.init()

flow.get_environment()