Skip to main content

A package for retrosynthetic planning.

Project description

Navigating the labyrinth of synthesis planning


DocsCLITutorialsPaper

CI Python Version pypi code style License

Overview

Syntheseus is a package for end-to-end retrosynthetic planning.

  • ⚒️ Combines search algorithms and reaction models in a standardized way
  • 🧭 Includes implementations of common search algorithms
  • 🧪 Includes wrappers for state-of-the-art reaction models
  • ⚙️ Exposes a simple API to plug in custom models and algorithms
  • 📈 Can be used to benchmark components of a retrosynthesis pipeline

Quick Start

To install syntheseus with all the extras, run

conda env create -f environment_full.yml
conda activate syntheseus-full

pip install "syntheseus[all]"

See here if you prefer a more lightweight installation that only includes the parts you actually need.

Citation and usage

Since the release of our package, we've been thrilled to see syntheseus be used in the following projects:

Project Usage Reference(s)
Retro-fallback search Multi-step search ICLR paper, code
RetroGFN Pre-packaged single-step models arXiv paper, code
TANGO Single-step and multi-step arXiv paper
SimpRetro Multi-step search JCIM paper, code

If you use syntheseus in an academic project, please consider citing our associated paper from Faraday Discussions (bibtex below). You can also message us or submit a PR to have your project added to the table above!

@article{maziarz2024re,
  title={Re-evaluating retrosynthesis algorithms with syntheseus},
  author={Maziarz, Krzysztof and Tripp, Austin and Liu, Guoqing and Stanley, Megan and Xie, Shufang and Gainski, Piotr and Seidl, Philipp and Segler, Marwin},
  journal={Faraday Discussions},
  year={2024},
  publisher={Royal Society of Chemistry}
}

Development

Syntheseus is currently under active development. If you want to help us develop syntheseus please install and run pre-commit checks before committing code.

We use pytest for testing. Please make sure tests pass on your branch before submitting a PR (and try to maintain high test coverage).

python -m pytest --cov syntheseus/tests

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

syntheseus-0.6.0.tar.gz (264.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

syntheseus-0.6.0-py3-none-any.whl (171.1 kB view details)

Uploaded Python 3

File details

Details for the file syntheseus-0.6.0.tar.gz.

File metadata

  • Download URL: syntheseus-0.6.0.tar.gz
  • Upload date:
  • Size: 264.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.7

File hashes

Hashes for syntheseus-0.6.0.tar.gz
Algorithm Hash digest
SHA256 59b82c47acf5385a740a5e6b0555e69054c23b608528f3147df083ec407ac6a9
MD5 53f209d77610bf123164802ba420413f
BLAKE2b-256 55a402edfc9faa5601f9d70ca118f10d69ee9d7ba204461da4e66c464e5d3e4d

See more details on using hashes here.

File details

Details for the file syntheseus-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: syntheseus-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 171.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.7

File hashes

Hashes for syntheseus-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 67fcedd6d3a16085a7ee6a98f5e2c711a49f98b4b355625c8ba69c6dcb3b41df
MD5 be98f9607de7edb6bad20f0c16964994
BLAKE2b-256 41f408d47a283ff63858f59848904e9fed4238bf59dc12c6b24c72709ba68a0b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page