Skip to main content

Scripts and functions needed for for APPARISE.

Project description

APPRAISE: Rank binders by structure modeling

Automated Pair-wise Peptide-Receptor binding model AnalysIs for Screening Engineered proteins (APPRAISE) is a method that predicts the receptor binding propensity of engineered proteins based on high-precision protein structure prediction tools, such as AlphaFold2-multimer. The APPRAISE Python package includes tools for preparing input files and analyzing the modeled structures.

APPRAISE concept

Author: Xiaozhe Ding (Email: dingxiaozhe@gmail.com, xding@caltech.edu; Twitter: @DingXiaozhe)

Getting started without installation

We recommend using APPRAISE remotely by running Colab-APPRAISE notebook on Google Colaboratory, which allows you to access APPRAISE with a web-based interface. This notebook guides users through the APPRAISE process step-by-step, with results stored on Google Drive. No need for a local installation when using this notebook.

The basic service of Google Colaboratory is free, although you can choose paid plans to get more stable access to better hardwares.

How to run Colab-APPRAISE

  1. Open Colab-APPRAISE notebook in Google Colaboratory;
  2. Go to "File --> save a copy in Drive" to save a copy of your own;
  3. Follow the Quick guide on the top of the notebook, and you can start APPRAISing!

Local installation

Environment

Local APPRAISE 1.2 was tested with the following environment:

  • MacOS 10.14.6

  • Python 3.6.10

  • Alphafold-colabfold 2.1.14 (Available here)

  • PyMOL 2.3.3 (Schrodinger LLC.)

  • Python packages (will be automatically handled by pip):

    • scipy 1.4.1

    • numpy 1.18.2

    • pandas 1.1.5

    • matplotlib 3.2.1

    • seaborn 0.11.2

Installation options

Installation of APPRAISE locally requires pip. In most cases, pip comes with your Python environment. If not, you can follow the instructions here to install pip.

Option 1 (recommended)

Install the distribution from PyPI. In the terminal, run:

pip install appraise

Option 2 (back-up)

Download the repository to your local computer and unzip. In the terminal, change the working folder to the directory containing the appraise package folder and setup.py, and run the following line:

pip install -e .

Demo

You can find a few demo notebooks that work locally in the demo folder on GitHub.

References

Manuscript

Xiaozhe Ding*, Xinhong Chen, Erin E. Sullivan, Timothy F Shay, Viviana Gradinaru*. APPRAISE: Fast, accurate ranking of engineered proteins by receptor binding propensity using structural modeling. BioRxiv (2023). * Corresponding authors.

Github repository

The repository contains the latest version of APPRAISE package, Colab-APPRAISE notebook, and demo notebooks.

Related resources

ColabFold

ColabFold provides a panel of user-friendly tools for structure modeling that are used by APPRAISE.

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

appraise-1.2.5.tar.gz (26.0 kB view details)

Uploaded Source

Built Distribution

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

appraise-1.2.5-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

Details for the file appraise-1.2.5.tar.gz.

File metadata

  • Download URL: appraise-1.2.5.tar.gz
  • Upload date:
  • Size: 26.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for appraise-1.2.5.tar.gz
Algorithm Hash digest
SHA256 c6ae00008d36949bee29963b2a74ef389946a129aa27704ada4d92abea8b11a2
MD5 45f63836264dcaccc5163c494ff59701
BLAKE2b-256 3e179aa8bc1b782b00d0046bfe6f20b51ac6ed0a58769414847d8f93eb190ac8

See more details on using hashes here.

File details

Details for the file appraise-1.2.5-py3-none-any.whl.

File metadata

  • Download URL: appraise-1.2.5-py3-none-any.whl
  • Upload date:
  • Size: 26.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for appraise-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 02a84519778e6b5d3352a98e210c03259e5f20e0a6e47c2fe923a0bc8b7f3602
MD5 33e2f689fc908b4237a3c896af9871dc
BLAKE2b-256 55137d26ad445674899668053c57e6142871aef76ab9e87c7f7e42437c20c892

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