Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gwenwindflower authored Mar 10, 2023
1 parent 3cd93be commit 0806cb6
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ pip install jafgen

## Use

`jafgen` takes one argument, years, which sets the length of time the simulation generates synthetic data for.
`jafgen` takes two optional arguments:
- `--years` sets the length of time the simulation generates synthetic data for. It defaults to 2.
- `--prefix` sets a prefix for the generated files in the format `[prefix]_[file_name].csv`. It defaults to `raw`.

```shell
# generate a simulation spanning 3 years from 2016-2019
Expand Down

0 comments on commit 0806cb6

Please sign in to comment.