Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gwenwindflower committed Apr 7, 2024
1 parent f78ce2c commit 3208732
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,18 @@ pip install jafgen

## Use

`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`.
`jafgen` takes one argument:

- `[int]` Years to generate data for. The default is 1 year.

The following options are available:

- `--pre` sets a prefix for the generated files in the format `[prefix]_[file_name].csv`. It defaults to `raw`.

Generate a simulation spanning 3 years from 2016-2019 with a prefix of `cool`:

```shell
# generate a simulation spanning 3 years from 2016-2019
jafgen --years 3
jafgen 3 --pre cool
```

## Purpose
Expand Down

0 comments on commit 3208732

Please sign in to comment.