README.md

Analyze plant data

Data source:

Vesala, Risto, Rikkinen, Aleksi, Pellikka, Petri, Rikkinen, Jouko, & Arppe, Laura. (2023). You eat what you find – local patterns in vegetation structure control diets of African fungus-growing termites [Data set]. https://doi.org/10.5061/dryad.2ngf1vhq0

Setup

The exam.py is intended to be modified as a jupyter notebook. The notebook format .ipynb, however, is not very convenient for configuration management, testing, and giving feedback via the usual "pull-request" mechanism provided by Github. Thus, this repository uses jupytext to pair a pure Python file with a notebook with the same name. The notebook is automatically created when you open the Python file with jupyter, and the two files are kept in sync. Do not add exercise.ipynb to the files managed by git.

To start, you need the following actions:

python -m venv VIRTUAL_ENVIRONMENT
# remember to activate the virtual environment according to your operating system rules
pip install -r requirements.txt
jupyter notebook

Then you can open the exam.py as a notebook in the browser.

Test

You can execute tests locally on the python file:

mypy exam.py
python -m doctest exam.py