DEVELOPMENT.md

Development

MEOS uses the CMake and setuptools for the build system, and Catch2 and pytest for tests.

Building

cmake -B build -S .
cmake --build build

Testing

C++

cmake -B build/test -S test -DCMAKE_BUILD_TYPE=Release
cmake --build build/test --config Release
./build/test/libmeos-tests

Python

pip install .
pip install -r tests/python/requirements.txt
pytest

Building docs

C++ (Doxygen)

cmake -B build/docs -S documentation
cmake --build build/docs
cmake --build build/docs --target cppdocs

You can then proceed to host the docs locally, for example on http://0.0.0.0:8000/

python -m http.server --directory build/docs/doxygen/html

Python (Sphinx)

pip install .[docs]
cmake -B build/docs -S documentation
cmake --build build/docs
cmake --build build/docs --target pydocs

You can then proceed to host the docs locally, for example on http://0.0.0.0:8000/

python -m http.server --directory documentation/python/_build/html