Skip to content

Commit

Permalink
add usage
Browse files Browse the repository at this point in the history
  • Loading branch information
cmarshak committed Nov 19, 2024
1 parent 0a11e19 commit ee3bc1c
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,15 @@ conda activate dist-s1-env
python -m ipykernel install --user --name dist-s1-env
```

## Usage

```
dist-s1 --runconfig_yml_path <path/to/runconfig.yml>
```

See `tests/test_main.py` for an example of how to use the CLI with sample data.


## Docker

### Local Usage
Expand Down

0 comments on commit ee3bc1c

Please sign in to comment.