Installation

中文

Install from PyPI

Python 3.10+ is required. Version 0.0.2 is available on PyPI:

python -m pip install homology-operator==0.0.2

No Rust compiler is needed for this OS-independent reference wheel.

Install from source

Alternatively, clone the repository:

git clone https://github.com/proffitteoy/homology-operator.git
cd homology-operator
python -m pip install .

The reference uses only the standard library; Rust, NumPy, and GUDHI are optional.

Virtual environments

Windows:

python -m venv .venv
.venv\Scripts\python.exe -m pip install .
.venv\Scripts\python.exe examples/single_scale.py

Linux:

python3 -m venv .venv
.venv/bin/python -m pip install .
.venv/bin/python examples/single_scale.py

Development with uv:

uv sync --locked --python 3.10
uv run --locked python examples/single_scale.py

The example prints JSON with identities, solver and validation records, and readouts. Continue with the quickstart.

Optional Rust extension

Build and install a matching release wheel separately. See platform support and native and batch operations. Installing the reference does not establish native availability.