Installation

MAMUT targets Python 3.12. The repository pins the local development runtime in .python-version and resolves dependencies with uv.

Install From PyPI

pip install mamut

Install From Source

Clone the repository and install the package in editable mode:

git clone https://github.com/przybytniowskaj/Mamut.git
cd Mamut
uv sync --all-groups

Development Environment

For repository development, keep the environment synchronized with uv.lock:

uv sync --all-groups

Documentation builds render the walkthrough notebook with nbsphinx, which requires the external pandoc executable. Install it through your operating system package manager before building docs (for example, dnf install pandoc on Fedora or apt install pandoc on Ubuntu).

Common validation commands:

uv run deptry .
scripts/audit_dependencies.sh
uv run pytest
uv run pre-commit run --all-files
uv run make -C docs html

Next Steps

After installation, continue with the Quickstart to fit a first model and inspect the generated outputs.