Skip to main content

Calculates single residue frustration, and mutational frustration of proteins.

Project description

OpenAWSEM

An implementation of the AWSEM coarse-grained protein folding forcefield in OpenMM

OpenAWSEM is an implementation of the AWSEM (Associative memory, Water-mediated Structure, and Energy Model) coarse-grained protein forcefield designed for use with the OpenMM simulation toolkit.

Installation

Conda

To install OpenAWSEM using Conda, execute the following command:

conda install -c conda-forge openawsem

Git

This installation mode is recommended for users that want to contribute to the code and Wolynes lab members.

#Clone the awsem repository
git clone https://github.com/cabb99/openawsem.git
cd openawsem

# Create a new conda environment
conda create -n openawsem --file requirements.txt
conda activate openawsem

# Install the package in editable mode
pip install -e .

Requirements

STRIDE

STRIDE is used for secondary structure prediction. Download and install STRIDE and add it to your PATH: https://webclu.bio.wzw.tum.de/stride/

wget https://webclu.bio.wzw.tum.de/stride/stride.tar.gz
tar -xvzf stride.tar.gz
cd stride
make
echo 'export PATH=$PATH:'`pwd` >> ~/.bashrc

PSIBLAST

Install psiblast using the distribution from bioconda:

conda install -c bioconda blast

Alternatively Download and install psiblast and add it to your PATH: ftp://ftp.ncbi.nlm.nih.gov/blast/executables/blast+/LATEST/

wget https://ftp.ncbi.nlm.nih.gov/blast/executables/LATEST/$(curl -s "https://ftp.ncbi.nlm.nih.gov/blast/executables/LATEST/" | grep -o 'ncbi-blast-[0-9.]*+-x64-linux.tar.gz'| head -n 1)
tar -xvzf ncbi-*.tar.gz
cd ncbi*/bin
echo 'export PATH=$PATH:'`pwd` >> ~/.bashrc

PDB_SEQRES.txt

  • Download pdb_seqres.txt and put it in the cloned openawsem repository location
wget ftp://ftp.wwpdb.org/pub/pdb/derived_data/pdb_seqres.txt
OPENAWSEM_LOCATION=$(python -c "import openawsem; print(openawsem.__location__)")
cp pdb_seqres.txt $OPENAWSEM_LOCATION/data

Configuration

OpenAWSEM allows users to configure data storage paths. To do this:

Create a .awsem directory in your home folder. Inside .awsem, create a configuration file named config.ini to specify data paths. The default paths point to the local data directory inside the OpenAWSEM module. Example config.ini:

[Data Paths]
blast = /home/USER/data/database/cullpdb_pc80_res3.0_R1.0_d160504_chains29712
gro = /home/USER/data/Gros
pdb = /home/USER/data/PDBs
index = /home/USER/data/Indices
pdbfail = /home/USER/data/notExistPDBsList
pdbseqres = /home/USER/data/pdb_seqres.txt
topology = /home/USER/topology

Example

Simulation of the amino terminal domain of Phage 434 repressor (1r69)

  1. Activate the OpenMM Environment: Activate the required environment for running simulations.

    source activate openmm
    
  2. Set Up the Simulation Folder: Create a simulation folder using the awsem_create command. The awsem_create command will automatically download the corresponding pdb.

    awsem_create 1r69 --frag
    

    Alternatively, if you have the 1r69.pdb file:

    awsem_create 1r69.pdb --frag
    
  3. Modify the forces_setup.py

    The forces_setup.py script determines which force (energy) terms are included in the simulation. To activate the fragment memory term uncomment the fragment memory term and comment the single memory term.

       # templateTerms.fragment_memory_term(oa, frag_file_list_file="./frags.mem", npy_frag_table="./frags.npy", UseSavedFragTable=True),
         templateTerms.fragment_memory_term(oa, frag_file_list_file="./single_frags.mem", npy_frag_table="./single_frags.npy", UseSavedFragTable=False),
    

    It should look like this:

         templateTerms.fragment_memory_term(oa, frag_file_list_file="./frags.mem", npy_frag_table="./frags.npy", UseSavedFragTable=False),
       #  templateTerms.fragment_memory_term(oa, frag_file_list_file="./single_frags.mem", npy_frag_table="./single_frags.npy", UseSavedFragTable=False),
    
  4. Run the Simulation: Execute the simulation using the awsem_run command, specifying the platform, number of steps, and start and end temperatures for the annealing simulation. As an example we are running 1e5 steps, but it is common to run from 5 to 30 million steps in a single run.

    awsem_run 1r69 --platform CPU --steps 1e5 --tempStart 800 --tempEnd 200 -f forces_setup.py
    
  5. Compute Energy and Q: Analyze the simulation results and redirect the output to info.dat.

    awsem_analyze 1r69 > info.dat
    
  6. Run Local Scripts (Optional): The scripts are copied to the project folder and can be modified as needed. To run the local scripts, use the following commands:

    ./mm_run.py 1r69 --platform CPU --steps 1e5 --tempStart 800 --tempEnd 200 -f forces_setup.py
    ./mm_analyze.py 1r69 > energy.dat
    

Notes:

For small proteins, the LAMMPS version may be faster than OpenAWSEM, especially if a GPU is unavailable. Consider using http://awsem-md.org for such cases. A quick check of the stability of a protein in AWSEM can be done using the frustratometer server http://frustratometer.qb.fcen.uba.ar/

Data availability

Data related to the paper "OpenAWSEM with Open3SPN2: A fast, flexible, and accessible framework for large-scale coarse-grained biomolecular simulations" is available at https://app.globus.org/file-manager?origin_id=b4cef8ce-7773-4016-8513-829f388f7986&origin_path=%2FopenAWSEM_data%2F

Citation

Please cite the following paper when using OpenAWSEM: Lu, W., Bueno, C., Schafer, N. P., Moller, J., Jin, S., Chen, X., ... & Wolynes, P. G. (2021). OpenAWSEM with Open3SPN2: A fast, flexible, and accessible framework for large-scale coarse-grained biomolecular simulations. PLoS computational biology, 17(2), e1008308. https://doi.org/10.1371/journal.pcbi.1008308

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

openawsem-1.1.1.tar.gz (13.7 MB view details)

Uploaded Source

Built Distribution

openawsem-1.1.1-py3-none-any.whl (13.8 MB view details)

Uploaded Python 3

File details

Details for the file openawsem-1.1.1.tar.gz.

File metadata

  • Download URL: openawsem-1.1.1.tar.gz
  • Upload date:
  • Size: 13.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for openawsem-1.1.1.tar.gz
Algorithm Hash digest
SHA256 0870ee19431d1977cd85f1a000b8984416cf78f02d15b8292e13fb648df4cc5a
MD5 3783fa66a859f0306ec73304e018b434
BLAKE2b-256 3146d8ef9e18e71f34afb9df43fcb6b6822014c46075f6b1be9eaf435db243a7

See more details on using hashes here.

File details

Details for the file openawsem-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: openawsem-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 13.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for openawsem-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3fe3db7c1ad8d95da3a0e29ef378cf90c68675bddbab6007969ab211aad60594
MD5 de1cca5ac262d057754fdb166f86a6f8
BLAKE2b-256 a87b26764a63e31f0cab4fbf469aa603f2d111cbbd665c493035dfc555cc1127

See more details on using hashes here.

Supported by

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