path_finder
Retrosynthesis route finder — AiZynthFinder · Rxn-INSIGHT · Chemistry by Design
Yara Chahda · Corentin Portmann · Inès Ouchen Laksiri — EPFL 2026
User installation
Platform: Tested on macOS only. Linux should work but has not been tested.
Requirements: Miniconda or Anaconda
1. Create a dedicated environment
Python 3.10 is required — newer versions are not compatible with AiZynthFinder.
conda create -n path-finder-env python=3.10 -y
conda activate path-finder-env
2. Install RDKit
RDKit cannot be installed via pip — conda is required for this one step.
conda install -c conda-forge rdkit -y
3. Install Path Finder
pip install path-finder-retrosynthesis
4. Run the setup wizard
path-finder-setup
This automatically:
- copies the bundled datasets into
data/ - creates
data/config.ymlwith the correct paths
If the wizard fails at step 3 (model download): download the files manually from https://github.com/MolecularAI/aizynthfinder/releases and place them in
data/aizynthfinder/.Files needed:
uspto_model.onnx,uspto_templates.csv.gz,uspto_filter_model.onnx,zinc_stock.hdf5
5. Download the Rxn-INSIGHT USPTO database
Download uspto_rxn_insight.gzip from:
https://zenodo.org/records/10171745
Place it in data/uspto_rxn_insight.gzip.
This file enables reaction condition prediction for novel routes. Without it, only dataset and validated routes are shown.
6. Launch
path-finder
Open http://localhost:8501 in your browser.
Quick summary
conda create -n path-finder-env python=3.10 -y
conda activate path-finder-env
conda install -c conda-forge rdkit -y
pip install path-finder-retrosynthesis
path-finder-setup
# → place data/uspto_rxn_insight.gzip manually
path-finder
What the app does
Path Finder finds and ranks retrosynthesis routes for a target molecule using three sources:
| Section | Source | Conditions | Yield in scoring |
|---|---|---|---|
| 📚 Dataset | Curated Chemistry by Design routes | Real | Yes |
| ✅ Validated | AiZynthFinder + generic reactions (USPTO) | Real | Yes |
| 🤖 Predicted | AiZynthFinder + Rxn-INSIGHT | Predicted | No |
Routes are scored using a weighted 1/i² scheme across three user-chosen criteria: steps, yield, atom economy, E-factor, or safety.
Data files
The construction, sources and reconstruction procedure of toxicity_dataset.json are documented in SOURCES_AND_RECONSTRUCTION.md.
| File | Bundled | Description |
|---|---|---|
reaction_dataset.json |
✅ | Curated synthesis routes |
toxicity_dataset.json |
✅ | Safety scores for reagents and solvents |
generic_reactions.json |
✅ | 10 000 USPTO reactions for step validation |
data/aizynthfinder/ |
❌ | AiZynthFinder model files — downloaded by wizard |
data/config.yml |
❌ | Generated by wizard — do not commit |
data/uspto_rxn_insight.gzip |
❌ | Rxn-INSIGHT USPTO database — download manually |
Troubleshooting
| Problem | Solution |
|---|---|
path-finder-setup not found |
Make sure path-finder-env is activated: conda activate path-finder-env |
config.yml not found when launching |
Run path-finder-setup first |
| AiZynthFinder model download fails | Download manually from releases page and place in data/aizynthfinder/ |
| AiZynthFinder crash on launch | Open data/config.yml and make sure all paths are absolute and the files exist |
| Predicted routes disabled | Place data/uspto_rxn_insight.gzip (see step 5 above) |
| Slow search (~2 min) | Normal — AiZynthFinder MCTS is computationally intensive |
| Wrong Python version error | Make sure you created the environment with python=3.10 |
Developer setup
git clone https://github.com/YaraChahda/path_finder.git
cd path_finder
conda create -n path-finder-dev python=3.10 -y
conda activate path-finder-dev
conda install -c conda-forge rdkit -y
pip install -e .
path-finder-setup
path-finder
In the app's left sidebar, set the AiZynthFinder config field to
data/aizynthfinder/config.yml(the file written bypath-finder-setup). Pointing to the wrong file makes the search fail withAttributeError: 'list' object has no attribute 'split'.
Running tests
pytest tests/
Repository structure
This section describes the purpose of every file and folder so that new contributors can orient themselves quickly.
Root-level files
| File | Purpose |
|---|---|
pyproject.toml |
Package metadata, dependencies, and entry points for pip install |
path_finder-env.yml |
Conda environment — use this to recreate the full dev environment |
README.md |
This file |
LICENSE |
MIT licence |
mypy.ini |
Type-checking configuration — ignores RDKit and Rxn-INSIGHT stubs |
.gitignore |
Files excluded from git (config.yml, model files, pycache, dist/) |
.pre-commit-config.yaml |
Pre-commit hooks — checks for large files and merge conflicts |
.readthedocs.yml |
Automatic documentation build on readthedocs.org |
tox.ini |
Test automation configuration |
.github/workflows/
| File | Purpose |
|---|---|
publish.yml |
Automatically builds and uploads to PyPI when a git tag is pushed |
assets/
| File | Purpose |
|---|---|
banner.png |
Project banner displayed at the top of this README |
coverage-badge.svg |
Test coverage badge auto-generated by the CI pipeline |
data/
Working data directory — none of these files are committed to git.
| File / Folder | Purpose |
|---|---|
aizynthfinder/ |
AiZynthFinder model files downloaded by path-finder-setup |
config.yml |
AiZynthFinder config created by path-finder-setup — contains absolute paths specific to each machine |
reaction_dataset.json |
Main curated dataset (also bundled in the pip package) |
toxicity_dataset.json |
Safety scores (also bundled in the pip package) |
generic_reactions.json |
10 000 USPTO reactions for step validation (also bundled) |
uspto_rxn_insight.gzip |
Rxn-INSIGHT USPTO database — download manually, enables predicted routes |
docs/
| Folder / File | Purpose |
|---|---|
source/conf.py |
Sphinx documentation configuration |
source/index.md |
Documentation home page |
source/api/ |
Auto-generated API reference pages |
docs_out/ |
Generated Sphinx HTML output — do not edit manually, rebuilt with make html |
notebooks/
| File | Purpose |
|---|---|
report.ipynb |
Project report — introduction, methods, results, discussion, and live code demonstrations |
screenshots/ |
Screenshots of the Streamlit interface used as figures in the report |
scripts/
| File | Purpose |
|---|---|
convert_orderly_to_generic.py |
Converts the ORDerly-cleaned USPTO Parquet file into generic_reactions.json — run once to rebuild the generic dataset from scratch |
src/path_finder/
The installable Python package. All application logic lives here.
| File | Purpose |
|---|---|
__init__.py |
Package entry point — exposes find_best_routes and __version__ |
_about_.py |
Single source of truth for the version number |
app.py |
Streamlit front-end — tab layout, sidebar, route cards, search logic |
app_utensils.py |
UI helper functions used by app.py — score tables, scheme HTML, chart builders |
route_engine.py |
Chemistry backend — dataset loading, AiZynthFinder, Rxn-INSIGHT, scoring, and the main find_best_routes() entry point |
molecule_rendering.py |
RDKit Cairo rendering — mol_png() for Streamlit images, mol_b64_or_text_svg() for embedded HTML schemes |
app_layout.py |
All user-visible strings in English and French, plus the colour palette |
report_builder.py |
PDF generation using PIL — multi-page A4 report with metric cards, score table, and reaction step images |
launch.py |
Console entry points — path-finder (launches Streamlit) and path-finder-setup (setup wizard) |
assets/banner.png |
Banner bundled in the pip package |
data/ |
Datasets and config template bundled in the pip package, copied to data/ on first run |
tests/
| File | Purpose |
|---|---|
conftest.py |
Shared pytest fixtures (sample routes, mock datasets) |
test_route_engine.py |
Tests for scoring functions, dataset loading, SMILES canonicalisation, and route ranking |
test_molecule_rendering.py |
Tests for PNG rendering, base64 encoding, and fallback data URIs |
test_app_layout.py |
Tests that all required keys exist in both EN and FR dictionaries |
test_report_builder.py |
Tests for PDF generation |
test_app_utensils.py |
Tests for UI helper functions |
test_app.py |
Integration tests for the Streamlit app |
test_launch.py |
Tests for the CLI entry points |
Metadata
Release files for path-finder-retrosynthesis 1.0.26
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| path_finder_retrosynthesis-1.0.26.tar.gz | 894.0 kB | Without provenance | Details for path_finder_retrosynthesis-1.0.26.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| path_finder_retrosynthesis-1.0.26-py3-none-any.whl | Python 3 | none | any | Details for path_finder_retrosynthesis-1.0.26-py3-none-any.whl |
Total release size: 1.8 MB
Release files / path_finder_retrosynthesis-1.0.26.tar.gz
| Download URL | path_finder_retrosynthesis-1.0.26.tar.gz |
|---|---|
| Size | 894.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
73b4549ad606726d8971487269116cf40e468ae98fc0c6834f0b62bebef26a0f
|
|
BLAKE2b-256 checksum How to use checksums |
515d9d473d5132ca2772843d3b4a9b10f87ba94842fe3914279f31e95de2638a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.20
|
Release files / path_finder_retrosynthesis-1.0.26-py3-none-any.whl
| Download URL | path_finder_retrosynthesis-1.0.26-py3-none-any.whl |
|---|---|
| Size | 896.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0d1f097b90a7a0bfe95fc0a2873bc72e77c0552f2779e086dcab932d0bc83558
|
|
BLAKE2b-256 checksum How to use checksums |
a6a90c6e571d936ba9d7be633e6e994c62ccc335fb641c88b43912819e3d32e4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.20
|
Security for path-finder-retrosynthesis 1.0.26
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.