api.rst

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.

cli-help.txt

The FlowProject

flow

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

FlowProject

@flow.cmd

cmd

@flow.with_job

with_job

@flow.directives

directives

flow.run()

run

flow.init()

init

flow.get_environment()

get_environment