Skip to content

Installation

Requirements

  • Python ≥ 3.10
  • A C compiler (required by h5py) — present by default on Linux and macOS

From PyPI

pip install metacooler
uv add metacooler

Development install

Clone the repository and install with all development dependencies:

git clone https://github.com/js2264/metacooler
cd metacooler
uv sync

The development toolchain (ruff, pytest, pre-commit, ty) is declared as a dependency group, which uv sync installs by default. With pip ≥ 25.1, the equivalent is pip install -e . --group dev.

Optional dependencies

Documentation

The documentation site is built with Zensical and mkdocstrings. To build and preview it locally:

pip install "metacooler[docs]"   # or: uv sync --extra docs
zensical serve                   # live preview at http://localhost:8000
zensical build                   # render the static site into ./site

Verifying the install

metacooler --version