Python package for the ASKCOS platform for prediction of chemical reactivity
  • Python 99.7%
  • Makefile 0.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Max Liu c1ebf21b7f
Merge pull request #2 from ASKCOS/release-2021-01
askcos-core 2021.01 open-source release
2022-02-24 17:33:08 -05:00
askcos Remove hard-coded value in context v2 fp class 2022-02-24 11:46:10 -05:00
docs Change other uses of makeit 2020-07-01 11:05:20 -04:00
.dockerignore clean up old and deprecated artifacts 2020-03-09 15:40:51 -04:00
.gitignore Add make target to set up directory to track pages branch 2020-05-04 15:15:31 -04:00
.gitlab-ci.yml Update .gitlab-ci.yml for custom gitlab runner 2021-01-25 17:33:13 -05:00
Dockerfile Merge branch 'main' into release-2021-01 2022-02-22 17:21:37 -05:00
environment.yml Add conda environment file for local use of askcos-core 2020-11-24 11:07:07 -05:00
LICENSE Add LICENSE 2021-08-02 16:45:44 -04:00
Makefile Merge branch 'main' into release-2021-01 2022-02-22 17:21:37 -05:00
README.md Merge branch 'main' into release-2021-01 2022-02-22 17:21:37 -05:00
requirements.txt Install pytorch in docker image 2020-09-23 17:22:47 -04:00

askcos-core

askcos-base askcos-data askcos-core askcos-site askcos-deploy

Python package for the prediction of feasible synthetic routes towards a desired compound and associated tasks related to synthesis planning. Originally developed under the DARPA Make-It program and now being developed under the MLPDS Consortium.

Getting Started

This package can be used on its own as a normal Python package without deploying the full ASKCOS application. To do so, make sure that the project directory is on your PYTHONPATH and that the dependencies listed in requirements.txt are satisfied. The data and models must be downloaded separately from the askcos-data repository and placed in askcos-core/askcos/data.

Building a Docker Image

The askcos-core image can be built using the Dockerfile in this repository. It depends on the askcos-data Docker image, which can be built manually or pulled from Docker Hub.

$ cd askcos-core
$ docker build -t <image name> .

A Makefile is also provided to simplify the build command by providing a default image name and tag:

$ cd askcos-core
$ make build

How To Run Individual Modules

Many of the individual modules -- at least the ones that are the most interesting -- can be run "standalone". Examples of how to use them are often found in the if __name__ == '__main__' statement at the bottom of the script definitions. For example...

Using the learned synthetic complexity metric (SCScore):

askcos/prioritization/precursors/scscore.py

Obtaining a single-step retrosynthetic suggestion with consideration of chirality:

askcos/retrosynthetic/transformer.py

Finding recommended reaction conditions based on a trained neural network model:

askcos/synthetic/context/neuralnetwork.py

Using the template-free forward predictor:

askcos/synthetic/evaluation/template_free.py

Using the coarse "fast filter" (binary classifier) for evaluating reaction plausibility:

askcos/synthetic/evaluation/fast_filter.py

Predicting regio-selectivity for a given atom-mapped reaction:

askcos/synthetic/selectivity/general_selectivity.py

Predicting reactivity descriptors for a given list of molecules:

askcos/synthetic/descriptors/descriptors.py