Skip to content

Commit

Permalink
Add documentation page footer.
Browse files Browse the repository at this point in the history
  • Loading branch information
joaander committed May 10, 2024
1 parent 22dcedc commit eb2d63a
Show file tree
Hide file tree
Showing 4 changed files with 462 additions and 12 deletions.
34 changes: 24 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,35 @@
[![GitHub Actions](https://github.com/glotzerlab/row/actions/workflows/test.yaml/badge.svg?branch=trunk)](https://github.com/glotzerlab/row/actions/workflows/test.yaml)
[![Read the Docs](https://img.shields.io/readthedocs/row/latest.svg)](https://row.readthedocs.io/)
[![Contributors](https://img.shields.io/github/contributors-anon/glotzerlab/row.svg?style=flat)](https://row.readthedocs.io/en/latest/contributors.html)
[![License](https://img.shields.io/badge/license-BSD--3--Clause-green.svg)](LICENSE)
[![License](https://img.shields.io/badge/license-BSD--3--Clause-green.svg)](https://row.readthedocs.io/en/latest/license.html)

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 HPC **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.
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".
The name is **row** as in *"row, row, row your boat"*.

Notable features:
* Support both arbitrary directories and [signac](https://signac.io) workspaces.
* Execute actions via arbitrary shell commands.
* Support arbitrary directories and [signac](https://signac.io) 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.
* Execute groups in serial or parallel.
* Schedule CPU and GPU resources.
* Automatically determine the partition based on the batch job size.
* 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**.

TODO: better demo script to get output for README and row show documentation examples.

For example:
## Demonstration

```bash
> row show status
Action Completed Submitted Eligible Waiting Remaining cost
Expand All @@ -48,5 +51,16 @@ dir5 completed 0.4
dir6 completed 0.3
```

## Resources

- [Documentation](https://row.readthedocs.io/):
Tutorial, command line interface documentation, and configuration file specifications.
- [Row discussion board](https://github.com/glotzerlab/row/discussions/):
Ask the **row** user community for help.
- [signac](https://signac.io):
Python package to help you manage your workspace.

## History

**Row** is a spiritual successor to
[signac-flow](https://docs.signac.io/projects/flow/en/latest/).
2 changes: 0 additions & 2 deletions doc/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,3 @@ create-missing = false
# You also need to install https://github.com/Michael-F-Bryan/mdbook-linkcheck.
# [output.linkcheck]
# follow-web-links = true

# TODO: Add page footer.
79 changes: 79 additions & 0 deletions doc/src/images/umich-block-M.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit eb2d63a

Please sign in to comment.