Skip to content

Commit

Permalink
short description of use of cli in the new python ver
Browse files Browse the repository at this point in the history
  • Loading branch information
djdebonis committed Aug 5, 2020
1 parent 1594126 commit fed981f
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,20 @@ Contributions are welcome. There are many aspects of this project to improve, pl
## license
This software is released as-is, with no guarantee nor warranty. For more details, please see [LICENSE](/info/LICENSE.txt).

## python cli

after you have installed the repository and necessary modules (more on this later),first create a fake dataset to run the simulation on using:

```bash
python3 fakeData.py --farms 100 --year 2020 --output data/fakeData.csv
```

Feel free to replace arguments to suit your taste. The arguments above are the defaults that will be ran without specification.

After you've created this dataset, run the simulation using:

```bash
python3 simulateCoOp.py --farm data/fakeData.csv --years 30 --ouptut testNewFarm.png
```

once again, these are the default arguments.

0 comments on commit fed981f

Please sign in to comment.