Skip to content

mupif/mupif-accel

Repository files navigation

MuPIF accelerated

Repository with compiled acceleration add-ons for MuPIF, including CI machinery for distribution of wheels from PyPi. Installation should be as simple as pip3 install mupif-accel (or python3 -m pip install mupif-accel.

Developer notes

Automatic compilation of binary packages (wheels) is done with cibuildwheel and scikit-build. The machinery is described in setup.py, pyproject.toml and .github/workflows/wheels.yml.

Compile-time dependencies are two header-only libraries: Eigen and pybind11, which are pulled over the wire by CMake at build-time.

Wheels are build after every push, Release to PyPI is done by

  • setting version number in setup.py (this version is authoritative for PyPI package version number);
  • tagging the commit locally (e.g. git tag v0.0.2);
  • pushing the tag upstream (git push origin --tags);
  • this should trigger CI rebuild followed by upload to PyPI.