Skip to content

Bio-Otto/MDPerTool_GUI

Repository files navigation

MDPERTOOL: Perturbation-based Allosteric Pathway Finder

Conda Build Platforms Download Counter License GitHub contributors website Twitter Follow Stars Badge Forks Badge

A Software Tool for Investigation of Allosteric Communication within Protein Structures via Energy Dissipation in Molecular Dynamics Simulations

MDPerTool Animation


📥 Installation

To install MDPERTOOL using Conda, simply run the following commands:

conda install bio-otto::mdpertool

This will install MDPERTOOL and all of its dependencies. Once the installation is completed, you can access the Command Line Interface by typing mdpertool cli in your terminal or the Graphical User Interface by typing mdpertool gui.


Manual Installation

To manually install MDPERTOOL, follow the instructions below:

For Windows Users

git clone https://github.com/Bio-Otto/MDPerTool_GUI.git
cd MDPerTool_GUI
conda env create -f envs/winx64_env.yml
conda activate mdpertool
cd mdpertool
python ui_main.py

For Linux and macOS Users

git clone https://github.com/Bio-Otto/MDPerTool_GUI.git
cd MDPerTool_GUI
conda env create -f envs/linux64_env.yml
conda activate mdpertool
cd mdpertool
python ui_main.py


🖥️ Usage

Graphical User Interface (GUI)

To launch the GUI, simply run:

mdpertool gui

Command Line Interface (CLI)

To run the CLI mode, you need to provide additional arguments. The basic command structure is:

mdpertool cli -p <topology_file> [optional arguments]

Example Usage

Running in CLI Mode

mdpertool cli -p path/to/topology.pdb -pff amber99sb -wff spce

This command will run MDPERTOOL in command line mode with the specified topology file, protein forcefield, and water forcefield.

Full CLI Options

For a complete list of CLI options, you can refer to the help command:

mdpertool cli -h

This will display all the available options and their descriptions for running MDPERTOOL in CLI mode.

📦 Dependencies

  • OpenMM - A high performance toolkit for molecular simulation.

  • Networkx - NetworkX is a Python package for the creation, manipulation, and study of the structure, dynamics, and functions of complex networks.

  • Pandas - pandas is a fast, powerful, flexible and easy to use open source data analysis and manipulation tool

  • Numpy - The fundamental package for scientific computing with Python

  • Pymol (Open Source) - PyMOL is a user-sponsored molecular visualization system on an open-source foundation, maintained and distributed by Schrödinger.

  • Matplotlib - Matplotlib is a comprehensive library for creating static, animated, and interactive visualizations in Python.

  • Pyqtgraph - Scientific Graphics and GUI Library for Python

  • PySide2 - Python bindings for the Qt cross-platform application and UI framework

  • ProDy - Protein Dynamics and Sequence Analysis

  • Parmed - Parameter/topology editor and molecular simulator

MDPerTool applies Energy Dissipation Concept using OpenMM Molecular Dynamic Toolkit, which also supports the CUDA platform.

✨ Features

  • Automated topology builder
  • Residue base energy decomposition
  • DCD and XTC file format support
  • Easy to installation using Conda

Features of MDPERTOOL v0.0.1

This version of mdpertool includes the following features.

Feature Documentation
Each Residue Decomposition [plugins/dropbox/README.md][MDPERTOOL]
Molecular Dynamic Simulation [plugins/github/README.md][MDPERTOOL]
Energy Dissipation Network [plugins/googledrive/README.md][MDPERTOOL]
Free Energy Calculations [plugins/onedrive/README.md][MDPERTOOL]


🚀 Development

Want to contribute? Get a branch and join us to make MDPERTOOL even greater!

📋 Todos

  • Write MORE Tests
  • Add Light Mode

📝 License

MDPERTOOL is licensed under the MIT License. See the LICENSE file for more details.

Free Software, Hell Yeah!

About

Perturbation based Allosteric Pathway Finder

Resources

License

MIT, BSD-3-Clause licenses found

Licenses found

MIT
LICENSE
BSD-3-Clause
LICENSE.md

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages