diff --git a/.idea/.name b/.idea/.name
index 27f63ea..42061c0 100644
--- a/.idea/.name
+++ b/.idea/.name
@@ -1 +1 @@
-setup.py
\ No newline at end of file
+README.md
\ No newline at end of file
diff --git a/.idea/MDPerTool_GUI.iml b/.idea/MDPerTool_GUI.iml
new file mode 100644
index 0000000..8b8c395
--- /dev/null
+++ b/.idea/MDPerTool_GUI.iml
@@ -0,0 +1,12 @@
+
+
- - - - -
+## 📥 Installation -### Installation +To install MDPERTOOL using Conda, simply run the following commands: -Open your favorite Terminal and run the commands below: +```sh +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' in your terminal. +--- -```diff -# 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 -``` -```diff -# For linux 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 -``` +### Manual Installation +To manually install MDPERTOOL, follow the instructions below: + +#### For Windows Users +```cmd +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 terminal usage just type; +#### For Linux Users ```sh -$ python no_gui.py -p pdb_file -wdcd True -pert_res 'SER345' -speed_factor 4 +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 ``` ++ +
+ +--- -* __-p__ --> User gives the absolute path of the pdb file. -* __-wdcd__ --> The program uses dcd as default output format. Users can change it to XTC file format using ```-wdcd False -wxtc True``` argument. -* __-pert_res__ --> Users should enter the residue(s) to be perturbed. -* __-speed_factor__ --> Users should indicate the velocity rescale factor. +## 🖥️ Terminal Usage +For terminal usage, run: +```sh +python no_gui.py -p pdb_file -wdcd True -pert_res 'SER345' -speed_factor 4 +``` -### Dependencies +## 📦 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. @@ -86,38 +92,41 @@ $ python no_gui.py -p pdb_file -wdcd True -pert_res 'SER345' -speed_factor 4 * __ProDy__ - Protein Dynamics and Sequence Analysis * __Parmed__ - Parameter/topology editor and molecular simulator -And of course MDPERTOOL v0.0.1 itself is an open source [public repository][MDPERTOOL] on GitHub. +And of course MDPERTOOL itself is an open source public repository. -### Also you can check full functional parameters with: +#### Also you can check full functional parameters with: ```sh -$ python no_gui.py -h +python no_gui.py -h ``` For Molecular Dynamic Simulation production ```sh -$ no_gui.py -pFeature | -README | +Documentation |
---|
+ + + + +
\ No newline at end of file diff --git a/README_2.md b/README_2.md new file mode 100644 index 0000000..6857a45 --- /dev/null +++ b/README_2.md @@ -0,0 +1,168 @@ + ++ + + + +
+ +### Installation + +Open your favorite Terminal and run the commands below: + + +```diff +# 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 +``` +```diff +# For linux 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 +``` + + +### For terminal usage just type; + +```sh +$ python no_gui.py -p pdb_file -wdcd True -pert_res 'SER345' -speed_factor 4 +``` + +* __-p__ --> User gives the absolute path of the pdb file. +* __-wdcd__ --> The program uses dcd as default output format. Users can change it to XTC file format using ```-wdcd False -wxtc True``` argument. +* __-pert_res__ --> Users should enter the residue(s) to be perturbed. +* __-speed_factor__ --> Users should indicate the velocity rescale factor. + + + +### 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 + +And of course MDPERTOOL v0.0.1 itself is an open source [public repository][MDPERTOOL] on GitHub. + +### Also you can check full functional parameters with: + +```sh +$ python no_gui.py -h +``` + +For Molecular Dynamic Simulation production + +```sh +$ no_gui.py -pFeature | +README | +
---|---|
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] | +