Skip to content

Latest commit

 

History

History
144 lines (94 loc) · 5.87 KB

README.rst

File metadata and controls

144 lines (94 loc) · 5.87 KB
https://img.shields.io/github/actions/workflow/status/prody/prody/main.yml

SYNOPSIS

ProDy is a free and open-source Python package for protein structure, dynamics, and sequence analysis. It allows for comparative analysis and modeling of protein structural dynamics and sequence co-evolution. Fast and flexible ProDy API is for interactive usage as well as application development. ProDy also comes with several analysis applications and a graphical user interface for visual analysis.

Further details are described in the ProDy papers:

Bakan A, Meireles LM, Bahar I.
ProDy: Protein Dynamics Inferred from Theory and Experiments.
Bioinformatics 2011 27(11):1575-1577.
Bakan A, Dutta A, Mao W, Liu Y, Chennubhotla C, Lezon TR, Bahar I.
Evol and ProDy for Bridging Protein Sequence Evolution and Structural Dynamics.
Bioinformatics 2014 30(18):2681-2683.
Zhang S, Krieger JM, Zhang Y, Kaya C, Kaynak B, Mikulska-Ruminska K, Doruker P, Li H, Bahar I.
ProDy 2.0: Increased Scale and Scope after 10 Years of Protein Dynamics Modelling with Python.
Bioinformatics 2021 37(20):3657-3659.

MODULES

ProDy has a modular structure with modules inside various subpackages.

The main ones are:

as well as PCA, SignDy (:mod:`~prody.dynamics.signature`), hybrid methods such as :mod:`~prody.dynamics.clustenm`, allosteric signal propagation methods :mod:`~prody.dynamics.perturb` (PRS) and :func:`~prody.dynamics.analysis.calcHitTime` (Markovian hitting time), and various analysis and plotting functions.

  • :mod:`~prody.ensemble` enables construction of heterogeneous structural ensembles for exploring dynamics from experiments and simulations
  • :mod:`~prody.proteins` provides various modules for parsing different kinds of protein structure files including PDB, mmCIF, MMTF and maps,

as well as tools to align and compare structures, and analysis of :mod:`~prody.proteins.interactions` within and between proteins (InSty) and find :mod:`~prody.proteins.waterbridges` (WatFinder).

Smaller ones include:

GETTING PRODY

You can run ProDy on all major platforms. For download and installation instructions see:

DOCUMENTATION

See also https://github.com/prody/ProDy-website for latest versions.

SOURCE CODE

LICENSE

ProDy is available under MIT License. See LICENSE.txt for more details.

Biopython (http://biopython.org/) KDTree and TreeConstruction modules are distributed with ProDy. Biopython is developed by The Biopython Consortium and is available under the Biopython license (http://www.biopython.org/DIST/LICENSE).

Pyparsing (https://github.com/pyparsing/pyparsing) module is distributed with ProDy. Pyparsing is developed by Paul T. McGuire and is available under the MIT license (http://www.opensource.org/licenses/mit-license.php).

CEalign module (https://pymolwiki.org/index.php/Cealign_plugin) is distributed with ProDy. The original CE method was developed by Ilya Shindyalov and Philip Bourne. The Python version which is used by ProDy is developed by Jason Vertrees and available under the New BSD license.

Hbp module: The calculation of hydrophobic interactions, solvent accessible surface area (SASA) and volume for each residue is using geometric methods based on the information of the atoms in the molecule. The methods have been programmed in C++ and can be compiled as a python module “hpb.so” which is then used by ProDy. Files for compilation are stored at prody/proteins/hpbmodule folder and required C++ and Fortran compiler. After compilation hpb.so file can be stored in prody/proteins folder in ProDy or in the local directory which is used to perform calulations. The precompiled versions for Python 2.7, 3.8, 3.9, and 3.10 are availabe in prody/proteins/hpbmodule. The user can choose the correct version of hpb.so and copy to the prody/proteins or local directory.

C++ code of hpb.so was developed by Xin Cao and Fortran code by Xin Cao, Michelle H. Hummel, Bihua Yu, and Evangelos A. Coutsias (License in prody/proteins/hpbmodule folder). Details of the method can be found in the Supplementary Material of InSty manuscript (soon will be submitted for publication).