Tirsvad
632fa61b89
Tests / Run the tests (pull_request) Successful in 42s
No issue closed: all issues of MIL-001 to MIL-004 are closed.
34 lines
902 B
Markdown
34 lines
902 B
Markdown
🌐 **English** · [Dansk](Usage.da) · [Bahasa Melayu](Usage.ms)
|
|
|
|
# Usage
|
|
|
|
## Run the program
|
|
|
|
With the virtual environment active, from the project folder:
|
|
|
|
```bash
|
|
python -m squirrel
|
|
```
|
|
|
|
The program reads `data/2018_Central_Park_Squirrel_Census_-_Squirrel_Data.csv`, prints the colour counts and writes `squirrel_count.csv`.
|
|
|
|
|
|
|
|
Use other files with `python -m squirrel <census file> <summary file>`. If the census file does not exist, the program prints `Census file not found` and exits with status 2.
|
|
|
|
## Run the tests
|
|
|
|
```bash
|
|
python -m pytest
|
|
```
|
|
|
|
|
|
|
|
## Build the source documentation
|
|
|
|
```bash
|
|
doxygen Doxyfile
|
|
```
|
|
|
|
Open `docs/doxygen/html/index.html`.
|