Skip to main content

Pipeline allows massive screening using alphafold

Project description

AlphaPulldown

Downloads python3.10 GPL3 license

*This is a development version of AlphaPulldown! The stable version is available at 0.30.7 branch.

AlphaPulldown is a Python package that streamlines protein-protein interaction screens and high-throughput modelling of higher-order oligomers using AlphaFold-Multimer:

  • provides a convenient command line interface to screen a bait protein against many candidates, calculate all-versus-all pairwise comparisons, test alternative homo-oligomeric states, and model various parts of a larger complex
  • separates the CPU stages (MSA and template feature generation) from GPU stages (the actual modeling)
  • allows modeling fragments of proteins without recalculation of MSAs and keeping the original full-length residue numbering in the models
  • summarizes the results in a CSV table with AlphaFold scores, pDockQ and mpDockQ, PI-score, and various physical parameters of the interface
  • provides a Jupyter notebook for an interactive analysis of PAE plots and models
  • (New) allows to integrate experimental models into AlphaFold pipeline using custom multimeric databases

Pre-installation

Check if you have downloaded necessary parameters and databases (e.g. BFD, MGnify etc.) as instructed in AlphFold's documentation. You should have a directory like below:

alphafold_database/                             # Total: ~ 2.2 TB (download: 438 GB)
   bfd/                                   # ~ 1.7 TB (download: 271.6 GB)
       # 6 files.
   mgnify/                                # ~ 64 GB (download: 32.9 GB)
       mgy_clusters_2018_12.fa
   params/                                # ~ 3.5 GB (download: 3.5 GB)
       # 5 CASP14 models,
       # 5 pTM models,
       # 5 AlphaFold-Multimer models,
       # LICENSE,
       # = 16 files.
   pdb70/                                 # ~ 56 GB (download: 19.5 GB)
       # 9 files.
   pdb_mmcif/                             # ~ 206 GB (download: 46 GB)
       mmcif_files/
           # About 180,000 .cif files.
       obsolete.dat
   pdb_seqres/                            # ~ 0.2 GB (download: 0.2 GB)
       pdb_seqres.txt
   small_bfd/                             # ~ 17 GB (download: 9.6 GB)
       bfd-first_non_consensus_sequences.fasta
   uniclust30/                            # ~ 86 GB (download: 24.9 GB)
       uniclust30_2018_08/
           # 13 files.
   uniprot/                               # ~ 98.3 GB (download: 49 GB)
       uniprot.fasta
   uniref90/                              # ~ 58 GB (download: 29.7 GB)
       uniref90.fasta

Installation using pip

Firstly, install Anaconda and create AlphaPulldown environment, gathering necessary dependencies

conda create -n AlphaPulldown -c omnia -c bioconda -c conda-forge python==3.10 openmm==8.0 pdbfixer==1.9 kalign2 cctbx-base pytest

Secondly, activate the AlphaPulldown environment and install AlphaPulldown

source activate AlphaPulldown
python3 -m pip install alphapulldown==1.00.0
pip install jax==0.3.25 jaxlib==0.3.25+cuda11.cudnn805 -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html

Optionally, if you do not have these software yet on your system, install HMMER, HH-suite from Anaconda

source activate AlphaPulldown
conda install -c bioconda hmmer hhsuite

This usually works, but on some compute systems users may wish to use other versions or optimized builds of already installed HMMER and HH-suite.

For older versions of AlphaFold: If you haven't updated your databases according to the requirements of AlphaFold 2.3.0, you can still use AlphaPulldown with your older version of AlphaFold database. Please follow the installation instructions on the dedicated branch

How to develop

Follow the instructions at Developing guidelines


Manuals

AlphaPulldown supports four different modes of massive predictions:

  • pulldown - to screen a list of "bait" proteins against a list or lists of other proteins
  • all_vs_all - to model all pairs of a protein list
  • homo-oligomer - to test alternative oligomeric states
  • custom - to model any combination of proteins and their fragments, such as a pre-defined list of pairs or fragments of a complex

AlphaPulldown will return models of all interactions, summarize results in a score table, and will provide a Jupyter notebook for an interactive analysis, including PAE plots and 3D displays of models colored by chain and pLDDT score.

Examples

Example 1 is a case where pulldown mode is used. Manual: example_1

Example 2 is a case where custom and homo-oligomer modes are used. Manual: example_2

Example 3 is demonstrating the usage of multimeric templates for guiding AlphaFold predictions. Manual: example_3

all_vs_all mode can be viewed as a special case of the pulldown mode thus the instructions of this mode are added as Appendix in both manuals mentioned above.

Citations

If you use this package, please cite as the following:

@Article{AlphaPUlldown,
  author  = {Dingquan Yu, Grzegorz Chojnowski, Maria Rosenthal, and Jan Kosinski},
  journal = {Bioinformatics},
  title   = {AlphaPulldowna python package for proteinprotein interaction screens using AlphaFold-Multimer},
  year    = {2023},
  volume  = {39},
  issue  = {1},
  doi     = {https://doi.org/10.1093/bioinformatics/btac749}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alphapulldown-0.40.4.tar.gz (288.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

alphapulldown-0.40.4-py3-none-any.whl (371.0 kB view details)

Uploaded Python 3

File details

Details for the file alphapulldown-0.40.4.tar.gz.

File metadata

  • Download URL: alphapulldown-0.40.4.tar.gz
  • Upload date:
  • Size: 288.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for alphapulldown-0.40.4.tar.gz
Algorithm Hash digest
SHA256 bec01eebca7d031810bc591f14e99f1bb5983666bdc846cd52cd0eade9eda1c2
MD5 a82f98a169dc0ef645a6996cb016a9bd
BLAKE2b-256 c556c399a297fbb494c5acdca36d70a02808da70b0fcd3313fe9269a13f9db69

See more details on using hashes here.

File details

Details for the file alphapulldown-0.40.4-py3-none-any.whl.

File metadata

  • Download URL: alphapulldown-0.40.4-py3-none-any.whl
  • Upload date:
  • Size: 371.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for alphapulldown-0.40.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6fff4c75a80cf56bc79b6ac9b014aa270d4d2bea393c23ddd22e5b6a880d1386
MD5 77ddcd357d65199d78c8c900f0f8a725
BLAKE2b-256 755248c953e767f30b06620be725e128b220a1d69697abb03d63c75839361d5e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page