How to install the row crate // Lib.rs

Row is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install row

It will make the row command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall row uninstalls.

Adding `row` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add row

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

row = "1.0.0"

The row library will be automatically available globally. Read the row library documentation.

Back to the crate overview.

Readme

Row

Row is a command line tool that helps you manage workflows on HPC resources. Define actions in a workflow configuration file that apply to groups of directories in your workspace. Submit actions to your cluster's scheduler. Row tracks which actions have been submitted on which directories so that you don't submit the same work twice. Once a job completes, subsequent actions become eligible allowing you to process your entire workflow to completion over many submissions.

The name is row as in "row, row, row your boat".

Notable features:

Support arbitrary directories and signac workspaces.
Define your workflow in a configuration file.
Execute actions via user-defined shell commands.
Flexible group definitions:
- Select directories with conditions on their value.
- Split directories by their value and/or into fixed size groups.
- Construct groups of any eligible directories or require that the entire matching group is submitted whole.
Execute groups in serial or parallel.
Schedule CPU and GPU resources.
Multiple users can operate the same workflow.
Automatically determine the partition based on the job's resources and size.
Built-in configurations for many national and university HPC systems.
Add custom cluster definitions for your resources.
Row is fast.

Demonstration

$ row submit --action=step1 -n 1
[1/1] Submitting action 'step1' on directory dir12 and 3 more (0ms).
Row submitted job 5095791.

$ row show status
Action     Completed Submitted Eligible Waiting Remaining cost
initialize        50         0       50       0    8 CPU-hours
step1              4         4       42      50   2K CPU-hours
step2              0         0        4      96  800 GPU-hours

$ row show directories --action step1 -n 3 --value="/value"
Directory Status    Job ID        /value
dir1      completed                  116
dir10     completed                  952
dir100    completed                  139
dir11     completed                  998

dir12     submitted anvil/5095791    950
dir13     submitted anvil/5095791    107
dir14     submitted anvil/5095791    127
dir15     submitted anvil/5095791    122

dir16     eligible                   682
dir17     eligible                   816
dir18     eligible                   803
dir19     eligible                   691

Resources

Documentation: Tutorial, command line interface documentation, and configuration file specifications.
Row discussion board: Ask the row user community for help.
signac: Python package to help you manage your workspace.

History

Row is a spiritual successor to signac-flow.

Installing the command-line executable

Adding row library as a dependency

Adding `row` library as a dependency