Installation#

This page explains the supported environments and shows three ways to install SynPlanner.

Supported environments#

Python: >=3.10,<3.15 (CPython). The publishing workflow builds with Python 3.12.
OS/arch: developed and CI-tested on Linux x86_64 and MacOS arm64. Other platforms may work, but Docker is recommended for maximum portability.

What you get after install#

CLI entrypoint: synplan
Python API: import synplan
Data and weights are not bundled. Fetch them with synplan download_preset --preset synplanner-article --save_to synplan_data or follow Data download.

Install with pip (recommended)#

Use a virtual environment.

pip install SynPlanner

Verify:

synplan --version
synplan --help
python -c "import synplan, sys; print('synplan', synplan.__version__)"

Install with Docker (portable)#

Build and run the CLI inside a container. The provided Dockerfile targets Linux/AMD64.

docker build --platform linux/amd64 -t synplan:latest-cli-amd64 -f cli.Dockerfile .
docker run --rm --platform linux/amd64 -it synplan:latest-cli-amd64 --help

From source with uv (dev)#

git clone https://github.com/Laboratoire-de-Chemoinformatique/SynPlanner.git
cd SynPlanner/
uv sync --extra cpu   # add "--group docs --group dev" if you need docs or dev extras
uv run synplan --help

Limitations and notes#

Wheels are published from Linux. If you experience platform issues on macOS/Windows, prefer Docker or a Linux environment (e.g., WSL2).
Example data and model weights are not included; download them with the CLI (see Data download).
To run the full planning quickstart in 10 minutes, continue to 10 minutes to SynPlanner.