Tests and Benchmarks¶
If you ended up here you probably think about fixing some bugs or contributing some code. Awesome! Just open a PR, and we will guide you through the process. The following section contains some more detailed information of the continues integration (CI) procedure we follow. In the end, each commit has to pass them before it can be merged into the main branch on GitHub.
The first step to develop code is to clone the GitHub repo locally:
git clone email@example.com:emsig/empymod.git
All requirements for the dev-toolchain are collected in the
requirements-dev.txt file, so you can install them all by running
pip install -r requirements_dev.txt
With this you have all the basic tools to run the tests, lint your code, build the documentation, and so on.
The CI elements are:
(1) to (6) are run automatically through GitHub actions when committing changes to GitHub. Any code change should pass these tests. Additionally, it is crucial that new code comes with the appropriate tests and documentation, and if applicable also with the appropriate benchmarks. However, you do not need any of that to start a PR - everything can go step-by-step!
Many of the tests are set up in the Makefile (only tested on Linux):
To install the current branch in editable mode:
To check linting:
To run pytest:
To build the documentation:
Or to list all the possibilities, simply run:
There is also a benchmark suite using airspeed velocity, located in the emsig/empymod-asv-repository. The results of my machine can be found in the emsig/empymod-bench, its rendered version at emsig.xyz/empymod-asv. They ensure that we do not slow than the computation by introducing regressions.