Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Mention where to look for documentation on the CSV formats.
  • Loading branch information
p00ya committed Apr 25, 2023
1 parent 67554fa commit fc270c5
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ The `climbing_ratings` module can be run as an estimation script. It reads in a
python3 -m climbing_ratings data
```

To understand the format for the data files, see the documentation in `climbing_ratings/__main__.py` and the examples in `tests/testdata`.

For legacy reasons, the `02-run_estimation.py` script provides a stub as an alternate way to call the estimation script.

It will typically run in less than 5 seconds per 100,000 ascents (measured on an Intel Core i5-8210Y).
Expand Down

0 comments on commit fc270c5

Please sign in to comment.