AiZynthFinder is a tool for retrosynthetic planning. The default algorithm is based on a Monte Carlo tree search that recursively breaks down a molecule to purchasable precursors. The tree search is guided by a policy that suggests possible precursors by utilizing a neural network trained on a library of known reaction templates. This setup is completely customizable as the tool supports multiple search algorithms and expansion policies.
An introduction video can be found here: https://youtu.be/r9Dsxm-mcgA
Before you begin, ensure you have met the following requirements:
-
Linux, Windows or macOS platforms are supported - as long as the dependencies are supported on these platforms.
-
You have installed anaconda or miniconda with python 3.9 - 3.11
The tool has been developed on a Linux platform, but the software has been tested on Windows 10 and macOS Catalina.
First time, execute the following command in a console or an Anaconda prompt
conda create "python>=3.9,<3.11" -n aizynth-env
To install, activate the environment and install the package using pypi
conda activate aizynth-env
python -m pip install aizynthfinder[all]
for a smaller package, without all the functionality, you can also type
python -m pip install aizynthfinder
First clone the repository using Git.
Then execute the following commands in the root of the repository
conda env create -f env-dev.yml
conda activate aizynth-dev
poetry install --all-extras
the aizynthfinder package is now installed in editable mode.
The tool will install the aizynthcli and aizynthapp tools
as interfaces to the algorithm:
aizynthcli --config config_local.yml --smiles smiles.txt
aizynthapp --config config_local.yml
Consult the documentation here for more information.
To use the tool you need
1. A stock file
2. A trained expansion policy network
3. A trained filter policy network (optional)
Such files can be downloaded from figshare and here or they can be downloaded automatically using
download_public_data my_folder
where my_folder is the folder that you want download to.
This will create a config.yml file that you can use with either aizynthcli or aizynthapp.
Tests uses the pytest package, and is installed by poetry
Run the tests using:
pytest -v
The full command run on the CI server is available through an invoke command
invoke full-tests
The documentation is generated by Sphinx from hand-written tutorials and docstrings
The HTML documentation can be generated by
invoke build-docs
We welcome contributions, in the form of issues or pull requests.
If you have a question or want to report a bug, please submit an issue.
To contribute with code to the project, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>. - Make your changes and commit them:
git commit -m '<commit_message>' - Push to the remote branch:
git push - Create the pull request.
Please use black package for formatting, and follow pep8 style guide.
The contributors have limited time for support questions, but please do not hesitate to submit an issue (see above).
The software is licensed under the MIT license (see LICENSE file), and is free and provided as-is.
- Thakkar A, Kogej T, Reymond J-L, et al (2019) Datasets and their influence on the development of computer assisted synthesis planning tools in the pharmaceutical domain. Chem Sci. https://doi.org/10.1039/C9SC04944D
- Genheden S, Thakkar A, Chadimova V, et al (2020) AiZynthFinder: a fast, robust and flexible open-source software for retrosynthetic planning. ChemRxiv. Preprint. https://doi.org/10.26434/chemrxiv.12465371.v1
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
