Unit Testing

Unit testing PM.

Here we document how unit testing is performed for PM, and provide an overview of what sort of tests are performed. Unit tests for PM are stored in a separate repository called principia-materia-tests.

PM performs unit testing with Pytest, which is a standard framework for unit testing within python. All unit tests may be run by going into the repo, installing the required dependencies, and executing pytest.

git clone git@github.com:marianettigroup/principia-materia-tests.git
cd principia-materia-test
pip install requirements.txt
pytest

An individual test can be run by changing into a directory and running pytest on a specific test. For example,

cd tests/translation_group
pytest test_translation_group.py

Last modified January 20, 2023: adding a description of unit testing. (98b1da4)