Installation

Prerequisites

• Conda (Miniconda or Miniforge)
• Python 3.13+
• Linux or macOS (Windows users can try WSL2)

Environment setup

git clone <repo-url>
cd simACE
conda env create -f envs/environment.yml   # creates environment and installs simace + fitACE
conda activate simACE

Verify installation

pytest tests/           # unit tests, should complete in ~1s

Developer dependencies

The conda environment installs the developer dependencies from pyproject.toml. For an existing environment, install them manually with:

pip install -e ".[dev]"

This adds: mkdocs, mkdocs-material, mkdocstrings, ruff, pytest, snakemake, and snakefmt.

Building the docs locally

mkdocs serve       # live-reload at http://127.0.0.1:8000
mkdocs build       # static site in site/