01 / getting started

Installation

Set up a source checkout with the same dependencies used by the test suite and examples.

Edit this pageUpdated with the source

Supported environment

Use Python 3.10 through 3.13. The core install requires NumPy 1.21 or newer and SciPy 1.10 or newer. The project is pre-1.0 and is currently installed from source.

git clone https://github.com/sachncs/reachq.git
cd reachq
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate
python -m pip install -e ".[dev]"

Verify the checkout

python -c "import reachq; print(reachq.__version__)"
reachq --help
pytest -q

The package build and wheel smoke test are also run in CI. A published PyPI installation path will be documented when a real release artifact exists.