This repository contains the code for the application ADME@NCATS which hosts QSAR models for different ADME endpoints. To use the application locally, you can either use Git to clone the respository, or you can simply download a ZIP file (by clicking the green "Code" button on the top right corner) and then unzip it. The next steps are described below.
If you use Git to clone this repository, please use the --recursive flag:
git clone --recursive https://github.com/ncats/ncats-adme.git
If you download the application, you also need to download and unzip chemprop, but make sure to unzip the contents of chemprop inside the server
folder so the the ncats-adme folder/file structure looks something like this:
- ncats-adme
- client
- server
- chemprop
- chemprop
- docs
- scripts
- ...
- chemprop
Models will be loaded from NCATS servers so you will need access to the internet when you first run the application. Alternatively, if you want to download the models, the files are available as follows:
- Human Liver Microsomal Stability
- Rat Liver Microsomal Stability
- PAMPA 7.4 Permeability
- PAMPA 5.0 Permeability
- PAMPA-BBB Permeability
- Solubility
- Human Liver Cytosol Stability
- CYP450 isozymes - CYP2C9, CYP2D6, CYP3A4
- Install anaconda or miniconda
Python is also required but it is included with either installation of conda or miniconda.
You only have complete these steps one time.
- Open your terminal
- If you're on Windows, open Anaconda Prompt (window -> Anaconda3 -> Anaconda Prompt)
- If you're on Mac or Linux, open your Terminal
- Change the working directory (windows or Mac and Linux) to where you have
ncats-adme
and then go (CD one more time) into theserver
directory - Create environment
- For Windows and Linux machines
- Type
conda env create --prefix ./env -f environment.yml
and hit Enter - Wait several minutes for the envitonment to be created
- For Windows machines only, type
pip install typed-argument-parser
and hit Enter
- Type
- For Mac machines
- Type
conda env create --prefix ./env -f environment_mac.yml
and hit Enter - Wait several minutes for the envitonment to be created
- Type
- If you're doing this immediately after completing the steps above, skip to step 4
- Open your terminal
- If you're on Windows, open Anaconda Prompt (window -> Anaconda3 -> Anaconda Prompt)
- If you're on Mac or Linux, open your terminal
- Change the working directory (windows or Mac and Linux) to where you have ADME_RLM and then go into the server directory
- Type
conda activate ./env
and hit Enter - Type
python app.py
and hit Enter - Open Chrome or Firefox and browse to
http://127.0.0.1:5000/
- To close the application, hit
Ctrl + c
orCmd + c
in the Terminal and then typeconda deactivate
and hit Enter to close the conda environment