- Jupyter Notebook 76.4%
- Shell 11.5%
- Python 11.4%
- Dockerfile 0.7%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| align_helix_Active | ||
| align_helix_Inactive | ||
| database | ||
| docs | ||
| example | ||
| fusion_partners | ||
| noah | ||
| align_helix.py | ||
| design_chimera.py | ||
| Dockerfile | ||
| fetch_from_db.py | ||
| LICENSE | ||
| README.md | ||
| run_noah.py | ||
| setup.py | ||
noah_gpcr
NOn-experimental, AI-assisted, High-throughput construct screening for structural analysis
NOAH can be executed using either of the following methods:
Option 1: Run in a local environment
1. Setup
Install the package (editable mode)
conda create -n noah pip
conda activate noah
pip install -e .
Install Dependencies
1. ppm3
Download and build ppm3.
Make sure to prepare a directory where the immers command can be executed (i.e., ensure the binary is built and available in your system’s PATH).
Note: Although a warning such as
Note: The following floating-point exceptions are signalling: IEEE_INVALID_FLAG IEEE_UNDERFLOW_FLAG IEEE_DENORMAL
may appear, it does not affect the functionality.
2. LocalColabFold
Follow the instructions in the LocalColabFold repository to set up the environment.
Ensure that the colabfold_batch command is available in your terminal.
3. DSSP
This package requires the DSSP program to be installed and accessible via the mkdssp command.
conda install -c conda-forge dssp
python -m gzip -d $CONDA_PREFIX/share/libcifpp/components.cif.gz
Note: Although a warning such as
UserWarning: parse error at line 1: This file does not seem to be an mmCIF file
may appear, it does not affect the functionality.
Build Database
If you cloned this repository, the database is already included and no additional setup is required.
(This database was downloaded from GPCRdb on February 7, 2025.)
python fetch_from_db.py -o <DB_DIR> -p <PROCESSES>
Output directory structure:
<DB_DIR>
├── <GPCR>
│ ├── Inactive_model.pdb # structure/homology_models/<gpcr>_human_inactive_full in GPCRdb API
│ ├── Active_model.pdb # structure/homology_models/<gpcr>_human_active_full in GPCRdb API
│ └── GPCR_info.json # residues/extended/<gpcr>_human in GPCRdb API
│
├── classA_GPCR_info.json # proteinfamily/proteins/001 in GPCRdb API
└── fetch_from_db.log # log
2. Execute
python run_noah.py -n <GPCR> -p <PPM3_CODE_DIR> -d <DB_DIR>
For example:
python run_noah.py -n v2r -p ~/noah/ppm3_code -d ~/noah/database
See here for instructions on executing NOAH with chimera GPCRs.
This process typically takes about 20 minutes per structure (e.g., three candidate sequences require ~1 hour in total).
Option 2: Run with Docker
1. Build
cd noah_gpcr
docker build -t noah_gpcr .
Note
The Docker image downloads and installs third-party software (e.g., ppm3, ColabFold) during the build process.
These tools are distributed under their respective licenses.
Users are responsible for complying with those licenses.
2. Prepare directories
export OUTDIR=/path/to/output
mkdir -p $OUTDIR/noah_run
mkdir -p $OUTDIR/colabfold_cache
3. Execute
docker run --rm --gpus all \
-v $OUTDIR/noah_run:/work/out \
-v $OUTDIR/colabfold_cache:/root/.cache/colabfold \
noah_gpcr \
bash -lc 'cd /work/out && /opt/conda/envs/noah/bin/python /opt/noah/run_noah.py -n <GPCR> -p /opt/noah/ppm3_code -d /opt/noah/database'
Output directory structure:
.
├── cf_result
│ └── <CONSTRUCT_NAME> # result of colabfold
├── ppm3_result # result of ppm3
├── *_modified.pdb # input of ppm3
├── <GPCR>_ARK1_Inactive_candidate.fasta # final candidate sequence
├── <GPCR>_ARK1_Inactive_cf_result.pdf # matrix showing the final candidate sequences
├── <GPCR>_ARK1_Inactive_helix_phase_candidate.pdf # matrix showing the candidate sequences after selection by both helix phase
├── <GPCR>_ARK1_Inactive_helix_phase_forward.pdf # matrix showing the candidate sequences after selection by forward helix phase
├── <GPCR>_ARK1_Inactive_helix_phase_reverse.pdf # matrix showing the candidate sequences after selection by reverse helix phase
├── <GPCR>_Inactive_cf_result.csv # csv file containing results of colabfold
├── <GPCR>_Inactive_helix_phase.csv # csv file containing values of helix phase
├── <GPCR>_Inactive_membrane_dis.csv # csv file containing values of distance from membrane
├── <GPCR>_Inactive_membrane_distance.pdf # matrix showing the values of distance from membrane
└── run_noah.log # log
See here for details of each plot.
Test System
OS: Linux (Rocky Linux9)
CPU: Intel Xeon Gold 5218R (2.10 GHz)
GPU: NVIDIA GeForce RTX 3090 (24GB)
Package version is here
Test results for V2R and LPAR2 are shown here.
License
The core components of NOAH are available for non-commercial research and educational use only.
For commercial use, please contact Hideaki Kato (c-hekato@g.ecc.u-tokyo.ac.jp).
Third-party software used by NOAH (e.g., ppm3, ColabFold, GPCRdb) is subject to its own respective licenses and terms of use.
References
[1] Lomize AL, Todd SC, Pogozheva ID. Spatial arrangement of proteins in planar and curved membranes by PPM 3.0. Protein Sci. 2022 Jan;31(1):209-220. 10.1002/pro.4219.
[2] Pándy-Szekeres G, Munk C, Tsonkov TM, Mordalski S, Harpsøe K, Hauser AS, Bojarski AJ, Gloriam DE. GPCRdb in 2018: adding GPCR structure models and ligands. 2017, Nucleic Acids Res., Nov 16. 10.1093/nar/gkx1109
[3] Mirdita M, Schütze K, Moriwaki Y, Heo L, Ovchinnikov S, Steinegger M. ColabFold: making protein folding accessible to all. Nat Methods. 2022 Jun;19(6):679-682. 10.1038/s41592-022-01488-1.