AiZynthFinder is a tool for retrosynthetic planning. The 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.
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.6 - 3.8
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 env create -f https://raw.githubusercontent.com/MolecularAI/aizynthfinder/master/env-users.yml
And if you want to update the environment
conda env update -n aizynth-env -f https://raw.githubusercontent.com/MolecularAI/aizynthfinder/master/env-users.yml
The package is now installed in a new conda environment, that you need to activate each time you want to use it
conda activate aizynth-env
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
the aizynthfinder package is now installed in editable mode.
If the above simple instructions does not work, here are the more detailed instructions. You might have to modify conda channels or similar if the dependencies fails to install on your OS.
First, install these conda packages
conda install -c conda-forge "rdkit=>2019.09.1" -y
conda install graphviz -y
Secondly, install the aizynthfinder package
python -m pip install https://github.com/MolecularAI/aizynthfinder/archive/v2.4.0.tar.gz
if you want to install the latest version
or, if you have cloned this repository
conda install poetry
python poetry
Note on the graphviz installation: this package does not depend on any third-party python interfaces to graphviz but instead calls the
dotexecutable directly. If the executable is not in the$PATHenvironmental variable, the generation of route images will not work. If unable to install it properly with the default conda channel, try using-c anaconda.
The tool will install the aizynthcli and aizynthapp tools
as interfaces to the algorithm:
aizynthcli --config config.yml --smiles smiles.txt
aizynthapp --config config.yml
Consult the documentation here for more information.
To use the tool you need
1. A stock file
2. A trained rollout policy network (including the Keras model and the list of unique templates)
3. A trained filer 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. J. Cheminf. https://jcheminf.biomedcentral.com/articles/10.1186/s13321-020-00472-1