Installation

gpmp-contrib is a Python package that depends on gpmp. The package metadata declares:

  • Python >= 3.9.

  • numpy.

  • scipy >= 1.12.0.

  • matplotlib.

  • gpmp >= 0.9.38.

Install the released package from PyPI with:

python -m pip install gpmp-contrib

For development, clone the repository and install it in editable mode:

git clone https://github.com/gpmp-dev/gpmp-contrib.git
cd gpmp-contrib
python -m pip install -e .

When testing a development checkout against a local gpmp checkout, install gpmp first in the same environment. gpmp selects the numerical backend at import time. ModelContainer methods accept backend objects and return NumPy prediction arrays by default. The detailed conversion rules are given in Numerical backend objects.

Minimal import check

import gpmp as gp
import gpmp.num as gnp
import gpmpcontrib as gpc

print(gp.__version__)
print(gpc.__version__)
x = gnp.asarray([[0.0], [1.0]])

Build the documentation

The documentation sources are in docs/source. Build the HTML pages with:

pip install -r docs/requirements.txt
cd docs
sphinx-build -M html source _build -E

The example result figures are generated by:

cd docs
python make_example_results.py

Figure-generation uses a non-interactive Matplotlib backend and writes PNG files in docs/source/_static/example_results.