This is a read-only mirror of pymolwiki.org

Difference between revisions of "MtsslDock"

From PyMOL Wiki
Jump to navigation Jump to search
m (2 revisions)
 
(31 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{Infobox script-repo
 
{{Infobox script-repo
 
|type      = plugin
 
|type      = plugin
|filename  = plugins/mtsslDock.py
+
|filename  = plugins/mtsslDockGui.py
 
|author    = [[User:Gha|Gregor Hagelueken]]
 
|author    = [[User:Gha|Gregor Hagelueken]]
 
|license  = -
 
|license  = -
 
}}
 
}}
 
= mtsslDock =
 
= mtsslDock =
mtsslWizard is a PyMOL plugin for distance constrained rigid-body docking.
+
mtsslDock is a PyMOL plugin for distance constrained rigid-body docking.
  
 
==News==
 
==News==
 +
2020-05-21:
 +
If you are having trouble with installation, give [http://www.mtsslsuite.isb.ukbonn.de this] a try!
 +
 +
2017-01-18:
 +
[http://www-hagelueken.thch.uni-bonn.de/index.php/en/2014-08-04-13-28-34/mtssldock Version 2.0 available]
 +
 
2013-07-04:
 
2013-07-04:
  
Version 1.0 submitted to script repository.
+
Version 1.0 in repository.
  
  
Line 21: Line 27:
 
[[File:MtsslDock screenshot.jpg |640px]]
 
[[File:MtsslDock screenshot.jpg |640px]]
  
==Usage==
+
==Installation==
===Installation===
+
*Step 1:
 +
Install the program by copying the code from the link above into an empty text file (e.g. "mtsslDock.py") located in the \Pymol\modules\pmg_tk\startup directory. After PyMOL has been started, the program can be launched from the PLUGINS menu.
 +
Alternatively install the plugin via the Plugin Manager.
  
 +
*Step 2:
 +
This might be a bit tricky: In addition to scipy and numpy, you will need a module called tkintertable (http://code.google.com/p/tkintertable/). Download it and check the contents of the downloaded folder (It is probably called "tkintertable-1.1.2" or similar). There should be a folder in it that is called "tkintertable" put this folder into the 'site-packages' folder of the Python installation that PyMOL uses. On Windows it is usually the system-wide installation, on my Mac PyMOL uses its own Python: /Applications/PyMOLX11Hybrid.app/pymol/ext/lib/python2.7/site-packages
  
 +
On my Mac I also had to install a new version of the Pmw module (for the GUI). You can get it here:
 +
http://sourceforge.net/projects/pmw/files/Pmw/Pmw.1.3.3/
 +
Install it to /Applications/PyMOLX11Hybrid.app/pymol/modules into a folder called 'Pmw'. You might want to rename the original Pmw folder in case something gets messed up…
  
 
mtsslDock has been tested with PyMOL 1.5.
 
mtsslDock has been tested with PyMOL 1.5.
 +
 +
===Additional requirements:===
 +
*SciPy
 +
*NumPy
 +
*[http://code.google.com/p/tkintertable/ tkintertable]
 +
 +
==Docking==
 +
To do a docking run, label the two proteins with [[MtsslWizard | mtsslWizard (1.1)]] and then start mtsslDock from the Plugins menu.
 +
The GUI should then appear and look like this:
 +
 +
[[File:MtsslDock Import Labels.jpg | 500px]]
 +
 +
First select the two proteins that you want to dock using the pulldown menus at the top of the 'Import Labels' dialog. Protein A will be held fixed, protein B will be moved. In the list below these two pulldowns, the program will list all mtsslWizard labels that it found in the PyMOL session. You can assign each of them to either A or B using the radiobuttons. Once you are happy with everything, click "OK".
 +
 +
The program will then build up a table for the docking constraints and you can enter your distance data (the rows are proteinA labels, the columns protein B labels). If a distance was not measured, enter "0", otherwise enter the distance and uncertainty separated by semicolon, e.g. "12.4;5.0":
 +
 +
[[File:MtsslDock distanceTable.jpg | 500px]]
 +
 +
You can then save this table for later reference in the file menu. Note that if you do save it, you have to use the exact same order of labels if you want to use it again.
 +
If you want you can then change some docking settings in the 'Settings' menu, but the defaults should be fine.
 +
 +
Hit "Dock" at the bottom. The program will do 10 independent docking runs. Depending on the size of the molecules this might take 5-30 min. There is a progress bar on the bottom right.
 +
Once the docking has finished, a "Results" tab will be added to the GUI:
 +
 +
[[File:MtsslDock results.jpg | 500px]]
 +
 +
Here, the solutions are listed on the left, clashing ones are marked by "-clash" added to their names. The table on the right shows the log of the docking or the difference between docked and experimental distances for the selected solution, depending on what you select with the three buttons below the table. The box on the bottom left shows you the settings that were used for this docking run.
 +
 +
===C2 symmetric structures, e.g. symmetric dimers===
 +
If you try the C2 dimer feature: Make a copy of your monomer and leave it at the exact same position. Then, label both monomers independently and import them as protein A and B.
 +
 +
The program was tested with a crystal structure of a protein:protein complex and it works well when you have at least 6 or better 8 distance constraints. See the paper for a discussion of performance.
 +
 +
==Reference==
 +
If you find this program useful, please cite this paper:
 +
 +
[http://www.tandfonline.com/doi/abs/10.1080/00268976.2013.809804#.UdWAzha3n6s/ '''mtsslSuite: In silico spin labelling, trilateration and distance-constrained rigid body docking in PyMOL''', Gregor Hagelueken, Dinar Abdullin, Richard Ward and Olav Schiemann, DOI: 10.1080/00268976.2013.809804]
 +
 +
It also contains detailed informations about the program, examples and a discussion of limitations of the approach.
 +
  
  
Line 33: Line 86:
  
 
==Acknowledgement==
 
==Acknowledgement==
Thanks to Jason Vertrees and Thomas Holder for some programming tips.
+
Thanks to Jason Vertrees and Thomas Holder for some programming tips. Also to Damien Farrell for the tkintertable class.

Latest revision as of 05:13, 26 May 2020

Type PyMOL Plugin
Download plugins/mtsslDockGui.py
Author(s) Gregor Hagelueken
License -
This code has been put under version control in the project Pymol-script-repo

mtsslDock

mtsslDock is a PyMOL plugin for distance constrained rigid-body docking.

News

2020-05-21: If you are having trouble with installation, give this a try!

2017-01-18: Version 2.0 available

2013-07-04:

Version 1.0 in repository.


If you use this program, please reference:

mtsslSuite: In silico spin labelling, trilateration and distance-constrained rigid body docking in PyMOL, Gregor Hagelueken, Dinar Abdullin, Richard Ward and Olav Schiemann, DOI: 10.1080/00268976.2013.809804

Screen shot

MtsslDock screenshot.jpg

Installation

  • Step 1:

Install the program by copying the code from the link above into an empty text file (e.g. "mtsslDock.py") located in the \Pymol\modules\pmg_tk\startup directory. After PyMOL has been started, the program can be launched from the PLUGINS menu. Alternatively install the plugin via the Plugin Manager.

  • Step 2:

This might be a bit tricky: In addition to scipy and numpy, you will need a module called tkintertable (http://code.google.com/p/tkintertable/). Download it and check the contents of the downloaded folder (It is probably called "tkintertable-1.1.2" or similar). There should be a folder in it that is called "tkintertable" put this folder into the 'site-packages' folder of the Python installation that PyMOL uses. On Windows it is usually the system-wide installation, on my Mac PyMOL uses its own Python: /Applications/PyMOLX11Hybrid.app/pymol/ext/lib/python2.7/site-packages

On my Mac I also had to install a new version of the Pmw module (for the GUI). You can get it here: http://sourceforge.net/projects/pmw/files/Pmw/Pmw.1.3.3/ Install it to /Applications/PyMOLX11Hybrid.app/pymol/modules into a folder called 'Pmw'. You might want to rename the original Pmw folder in case something gets messed up…

mtsslDock has been tested with PyMOL 1.5.

Additional requirements:

Docking

To do a docking run, label the two proteins with mtsslWizard (1.1) and then start mtsslDock from the Plugins menu. The GUI should then appear and look like this:

MtsslDock Import Labels.jpg

First select the two proteins that you want to dock using the pulldown menus at the top of the 'Import Labels' dialog. Protein A will be held fixed, protein B will be moved. In the list below these two pulldowns, the program will list all mtsslWizard labels that it found in the PyMOL session. You can assign each of them to either A or B using the radiobuttons. Once you are happy with everything, click "OK".

The program will then build up a table for the docking constraints and you can enter your distance data (the rows are proteinA labels, the columns protein B labels). If a distance was not measured, enter "0", otherwise enter the distance and uncertainty separated by semicolon, e.g. "12.4;5.0":

MtsslDock distanceTable.jpg

You can then save this table for later reference in the file menu. Note that if you do save it, you have to use the exact same order of labels if you want to use it again. If you want you can then change some docking settings in the 'Settings' menu, but the defaults should be fine.

Hit "Dock" at the bottom. The program will do 10 independent docking runs. Depending on the size of the molecules this might take 5-30 min. There is a progress bar on the bottom right. Once the docking has finished, a "Results" tab will be added to the GUI:

MtsslDock results.jpg

Here, the solutions are listed on the left, clashing ones are marked by "-clash" added to their names. The table on the right shows the log of the docking or the difference between docked and experimental distances for the selected solution, depending on what you select with the three buttons below the table. The box on the bottom left shows you the settings that were used for this docking run.

C2 symmetric structures, e.g. symmetric dimers

If you try the C2 dimer feature: Make a copy of your monomer and leave it at the exact same position. Then, label both monomers independently and import them as protein A and B.

The program was tested with a crystal structure of a protein:protein complex and it works well when you have at least 6 or better 8 distance constraints. See the paper for a discussion of performance.

Reference

If you find this program useful, please cite this paper:

mtsslSuite: In silico spin labelling, trilateration and distance-constrained rigid body docking in PyMOL, Gregor Hagelueken, Dinar Abdullin, Richard Ward and Olav Schiemann, DOI: 10.1080/00268976.2013.809804

It also contains detailed informations about the program, examples and a discussion of limitations of the approach.


Contact

hagelueken'at'pc.uni-bonn.de

Acknowledgement

Thanks to Jason Vertrees and Thomas Holder for some programming tips. Also to Damien Farrell for the tkintertable class.