Migrating from signac-flow

Row is a spiritual successor to signac-flow. Many concepts and common usage patters map directly from signac-flow to row.

Concepts:

flow	row
job	directory
cluster job	job
statepoint	value
operation	`action` in `workflow.toml`
group	A command may perform multiple steps.
label	Not implemented.
hooks	Not implemented.
environments	`clusters.toml`
`project.py`	`workflow.toml` combined with `actions.py`

Commands:

flow	row
`project.py status`	`row show status`
`project.py status --detailed`	`row show directories --action action`
`project.py run`	`row submit --cluster=none`
`project.py run --parallel`	A command may execute group members in parallel.
`project.py exec ...`	Execute your action's command in the shell.
`project.py submit`	`row submit`
`project.py submit --partition <PARTITION>`	`row submit` automatically selects appropriate partitions.
`project.py submit -n <N>`	`row submit -n <N>`
`project.py submit --pretend`	`row submit --dry-run`
`project.py submit --bundle <N>`	`group` in `workflow.toml`
`project.py submit --bundle <N> --parallel`	A command may execute group members in parallel.
`project.py submit -o <PATTERN>`	`row submit --action <PATTERN>`
`project.py <command> -j [JOB_ID1] [JOB_ID2] ...`	`row <command> [JOB_ID1] [JOB_ID2] ...`
`project.py <command> -f <FILTER>`	`row <command> $(signac find <FILTER>)`
`project.py <command> -j a1234`	`row <command> a1234`TAB

important

Enable tab completion before attempting to use TAB to complete action or directory names.

Conditions:

flow	row
postcondition: `isfile`	`products`
postcondition: others	Not implemented.
precondition: `after`	`previous_actions`
precondition: state point comparison	`include`
precondition: others	Not implemented.
aggregation	`group` in `workflow.toml`
aggregation: `select`	`include`
aggregation: `sort_by`	`sort_by`
aggregation: `groupby`	`sort_by` and `split_by_sort_key=true`
aggregation: `groupsof`	`maximum_size`

Execution:

flow	row
`operation(cmd=...)`	command in `workflow.toml`
directives: `executable`	`command = "<executable> actions.py {directories}"`
directives: `np`, `ngpu`, `omp_num_threads`, `walltime`	resources in `workflow.toml`
directives: Launch with MPI	`launchers` `= ["mpi"]`
directives: Launch with OpenMP	`launchers` `= ["openmp"]`
template job script: `script.sh`	`submit_options` in `workflow.toml`

Development of row is led by the Glotzer Group at the University of Michigan.

Keyboard shortcuts