This is a read-only mirror of pymolwiki.org

Difference between revisions of "Autodock plugin"

From PyMOL Wiki
Jump to navigation Jump to search
m (64 revisions)
 
(49 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
{{Infobox script-repo
 +
|type      = plugin
 +
|filename  = plugins/autodock_plugin.py
 +
|author    = [[User:Dseelig|Daniel Seeliger]]
 +
|license  = -
 +
}}
 +
 
== Description ==
 
== Description ==
 
This plugin should help to set up docking runs with Autodock and view docking results. It has two features:
 
This plugin should help to set up docking runs with Autodock and view docking results. It has two features:
Line 6: Line 13:
  
 
== Installation ==
 
== Installation ==
The plugin is now automatically available in the project [http://www.pymolwiki.org/index.php/Git_intro Pymol-script-repo].<br>
+
=== Linux ===
It is available only with the the Vina executable, since it has been found that Vina is orders of magnitudes faster than Autodock4.
+
This plugin is ready "out-of-box" for Linux users through the project [[git_intro | Pymol-script-repo]]
 +
 
 +
=== Windows ===
 +
This plugin is ready "out-of-box" for win users through the project [[git_intro | Pymol-script-repo]]
  
Or you can download it manually
+
You can download it manually
 
# Download [http://wwwuser.gwdg.de/~dseelig/adplugin.html plugin]
 
# Download [http://wwwuser.gwdg.de/~dseelig/adplugin.html plugin]
 
# '''PyMOL > Plugin > Install Plugin'''
 
# '''PyMOL > Plugin > Install Plugin'''
Line 20: Line 30:
 
Watch Dan Seeliger's [http://wwwuser.gwdg.de/~dseelig/plugin_tutorial.html autodock plugin tutorial].
 
Watch Dan Seeliger's [http://wwwuser.gwdg.de/~dseelig/plugin_tutorial.html autodock plugin tutorial].
  
== Author ==
+
== Important ==
 +
# The Autodock tools, does not like funny atoms names like "C1, N13, O28" and so on. Rename them! See example 1.
 +
# Ligands can not be in alternative configuration. Create by: '''create ROC_A, 1HXB and resn ROC and alt a''' . See example 2.
 +
 
 +
== Example 1 - Rename of funny atom names ==
 +
Read about the protein here: http://www.proteopedia.org/wiki/index.php/3ig7 <br>
 +
The example of video http://wwwuser.gwdg.de/~dseelig/plugin_tutorial.html <br>
 +
Note, that the module "prepare_ligand4.py" does not like funny names of atoms, so we have to rename them
 +
 
 +
{{Template:PymolScriptRepoDownload|examples/autodock_plugin_1.pml}}
 +
<include src="https://raw.github.com/Pymol-Scripts/Pymol-script-repo/master/examples/autodock_plugin_1.pml" highlight="python" />
 +
 
 +
Open the Autodock/Vina plugin. Check/set the executable to folders (they should be automatically found):
 +
Autodock Tools:      /home/you/another/pymol/Pymol-script-repo/modules/ADT/AutoDockTools/Utilities24
 +
autogrid4 executable: /home/you/another/pymol/Pymol-script-repo/modules/autodock_423/ia64Linux2/autogrid4                    # Platform dependent
 +
autogrid4 executable: /home/you/another/pymol/Pymol-script-repo/modules/autodock_423/ia64Linux2/autodock4                    # Platform dependent
 +
vina executable:      /home/you/another/pymol/Pymol-script-repo/modules/autodock_vina/autodock_vina_1_1_2_linux_x86/vina      # Platform dependent
 +
Working Directory:    /home/you/another/pymol/workingdir
 +
Enlarge the window and click '''Save Plugin Configuration file'''. Plugin will not work, if you do not save.
 +
 
 +
Click tab '''Grid settings'''. In '''Calculate Grid Center by Selection''', write '''EFP'''. <br>
 +
Try clicking '''Wired Box''' in top right, and then '''Show Box''', '''Hide Box''', '''Cylindric Box''', '''Show Box'''.<br>
 +
Then push '''Select binding site'''. In PyMOL, write
 +
show sticks, binding_site
 +
cmd.disable("binding_site")
 +
hide sticks, binding_site
 +
Click tab '''Receptor'''. Mark '''cdk''', and click '''Generate Receptor'''.<br>
 +
Click cdk2 to the "right", and see where the files are located.<br>
 +
Click tab '''Ligands'''. Mark '''EFP''', and click '''EFP''' in the Ligand list. Here is the files stored. Click '''Generate Ligand'''<br>
 +
Click tab '''Docking''', and click '''Run Vina'''. Wait 3-5 minutes, until '''Writing output ... done.'''<br>
 +
Click tab '''View poses''', Browse to '''EFP.docked.pdbqt'''. Click '''Load''', '''Show best 10'''. Experiment with "Display options, and click the candidates"<br>
 +
Congratulations, you did it!
 +
 
 +
== Example 2 - Alternative configurations of a Ligand ==
 +
Read about the protein here: http://www.proteopedia.org/wiki/index.php/1hxb <br>
 +
Ligands can not be in alternative configuration. Create by: create ROC_A, 1HXB and resn ROC and alt a .
 +
 
 +
{{Template:PymolScriptRepoDownload|examples/autodock_plugin_2.pml}}
 +
<include src="https://raw.github.com/Pymol-Scripts/Pymol-script-repo/master/examples/autodock_plugin_2.pml" highlight="python" />
 +
 
 +
== References and LICENSES ==
 +
=== Vina ===
 +
If you used AutoDock Vina in your work, [http://vina.scripps.edu/ please cite:]<br>
 +
O. Trott, A. J. Olson, ''AutoDock Vina: improving the speed and accuracy of docking with a new scoring function, efficient optimization and multithreading'', '''Journal of Computational Chemistry''' 31 (2010) 455-461
 +
 
 +
=== MGLTOOLS ===
 +
LICENSE of MGLTOOLS:
 +
<syntaxhighlight lang="text">
 +
This software is copyrighted by Michel F. Sanner (sanner@scripps.edu) and TSRI.
 +
The following terms apply to all files associated with the software
 +
unless explicitly disclaimed in individual files.
 +
 
 +
      MGLTOOLS SOFTWARE LICENSE AGREEMENT.
 +
 
 +
  1. Grant Of Limited License; Software Use Restrictions. The programs
 +
    received by you will be used only for NON COMMERCIAL purposes.
 +
    This license is issued to you as an individual.
 +
 
 +
    For COMMERCIAL use done with the software please contact Michel F.
 +
    Sanner for details about commercial usage license agreements.
 +
   
 +
    For any question regarding license agreements, please contact
 +
            Michel Sanner:
 +
    TSRI, Molecular Biology Department, TCP 26,
 +
    10550 North Torrey Pines Road, La Jolla, CA 92037
 +
    sanner@scripps.edu
 +
    tel (858) 784-7742
 +
    fax (858) 784-2341
 +
 
 +
  2. COMMERCIAL USAGE is defined as revenues generating activities. These
 +
    include using this software for consulting activities and selling
 +
    applications built on top of, or using this software. Scientific
 +
    research in an academic environment and teaching are considered
 +
    NON COMMERCIAL.
 +
 
 +
  3. Copying Restrictions. You will not sell or otherwise distribute commercially
 +
    these programs or derivatives to any other party, whether with or without
 +
    consideration.
  
[[User:Dseelig|Daniel Seeliger]]
+
  4. Ownership of Software. You will not obtain, and will not attempt to
 +
    obtain copyright coverage thereon without the express purpose written
 +
    consent of The Scripps Research Institute and Dr. Sanner.
  
== Python Code ==
+
  5. IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY
 +
    FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 +
    ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY
 +
    DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE
 +
    POSSIBILITY OF SUCH DAMAGE.
  
{{Template:PymolScriptRepoDownload|plugins/autodock_plugin.py}}
+
  6. THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
 +
    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
 +
    FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.  THIS SOFTWARE
 +
    IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE
 +
    NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
 +
    MODIFICATIONS.
 +
</syntaxhighlight>
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 +
[[Category:Pymol-script-repo]]

Latest revision as of 01:48, 28 March 2014

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

Description

This plugin should help to set up docking runs with Autodock and view docking results. It has two features:

  1. Setup of a docking grid for Autodock with PyMOL.
  2. View the docking results.

Installation

Linux

This plugin is ready "out-of-box" for Linux users through the project Pymol-script-repo

Windows

This plugin is ready "out-of-box" for win users through the project Pymol-script-repo

You can download it manually

  1. Download plugin
  2. PyMOL > Plugin > Install Plugin
  3. MGLTools/AutoDockTools
  4. AutoDock4.2
  5. AutoDock Vina

Tutorial Video

Watch Dan Seeliger's autodock plugin tutorial.

Important

  1. The Autodock tools, does not like funny atoms names like "C1, N13, O28" and so on. Rename them! See example 1.
  2. Ligands can not be in alternative configuration. Create by: create ROC_A, 1HXB and resn ROC and alt a . See example 2.

Example 1 - Rename of funny atom names

Read about the protein here: http://www.proteopedia.org/wiki/index.php/3ig7
The example of video http://wwwuser.gwdg.de/~dseelig/plugin_tutorial.html
Note, that the module "prepare_ligand4.py" does not like funny names of atoms, so we have to rename them

Download: examples/autodock_plugin_1.pml
This code has been put under version control in the project Pymol-script-repo

<include src="https://raw.github.com/Pymol-Scripts/Pymol-script-repo/master/examples/autodock_plugin_1.pml" highlight="python" />

Open the Autodock/Vina plugin. Check/set the executable to folders (they should be automatically found):

Autodock Tools:       /home/you/another/pymol/Pymol-script-repo/modules/ADT/AutoDockTools/Utilities24
autogrid4 executable: /home/you/another/pymol/Pymol-script-repo/modules/autodock_423/ia64Linux2/autogrid4                     # Platform dependent
autogrid4 executable: /home/you/another/pymol/Pymol-script-repo/modules/autodock_423/ia64Linux2/autodock4                     # Platform dependent
vina executable:      /home/you/another/pymol/Pymol-script-repo/modules/autodock_vina/autodock_vina_1_1_2_linux_x86/vina      # Platform dependent
Working Directory:    /home/you/another/pymol/workingdir

Enlarge the window and click Save Plugin Configuration file. Plugin will not work, if you do not save.

Click tab Grid settings. In Calculate Grid Center by Selection, write EFP.
Try clicking Wired Box in top right, and then Show Box, Hide Box, Cylindric Box, Show Box.
Then push Select binding site. In PyMOL, write

show sticks, binding_site
cmd.disable("binding_site")
hide sticks, binding_site

Click tab Receptor. Mark cdk, and click Generate Receptor.
Click cdk2 to the "right", and see where the files are located.
Click tab Ligands. Mark EFP, and click EFP in the Ligand list. Here is the files stored. Click Generate Ligand
Click tab Docking, and click Run Vina. Wait 3-5 minutes, until Writing output ... done.
Click tab View poses, Browse to EFP.docked.pdbqt. Click Load, Show best 10. Experiment with "Display options, and click the candidates"
Congratulations, you did it!

Example 2 - Alternative configurations of a Ligand

Read about the protein here: http://www.proteopedia.org/wiki/index.php/1hxb
Ligands can not be in alternative configuration. Create by: create ROC_A, 1HXB and resn ROC and alt a .

Download: examples/autodock_plugin_2.pml
This code has been put under version control in the project Pymol-script-repo

<include src="https://raw.github.com/Pymol-Scripts/Pymol-script-repo/master/examples/autodock_plugin_2.pml" highlight="python" />

References and LICENSES

Vina

If you used AutoDock Vina in your work, please cite:
O. Trott, A. J. Olson, AutoDock Vina: improving the speed and accuracy of docking with a new scoring function, efficient optimization and multithreading, Journal of Computational Chemistry 31 (2010) 455-461

MGLTOOLS

LICENSE of MGLTOOLS:

This software is copyrighted by Michel F. Sanner (sanner@scripps.edu) and TSRI.
The following terms apply to all files associated with the software 
unless explicitly disclaimed in individual files.

       MGLTOOLS SOFTWARE LICENSE AGREEMENT.

  1. Grant Of Limited License; Software Use Restrictions. The programs
     received by you will be used only for NON COMMERCIAL purposes.
     This license is issued to you as an individual.

     For COMMERCIAL use done with the software please contact Michel F. 
     Sanner for details about commercial usage license agreements.
     
     For any question regarding license agreements, please contact
             Michel Sanner:
	     TSRI, Molecular Biology Department, TCP 26,
	     10550 North Torrey Pines Road, La Jolla, CA 92037
	     sanner@scripps.edu
	     tel (858) 784-7742
	     fax (858) 784-2341

  2. COMMERCIAL USAGE is defined as revenues generating activities. These
     include using this software for consulting activities and selling
     applications built on top of, or using this software. Scientific 
     research in an academic environment and teaching are considered 
     NON COMMERCIAL.

  3. Copying Restrictions. You will not sell or otherwise distribute commercially 
     these programs or derivatives to any other party, whether with or without 
     consideration.

  4. Ownership of Software. You will not obtain, and will not attempt to 
     obtain copyright coverage thereon without the express purpose written 
     consent of The Scripps Research Institute and Dr. Sanner.

  5. IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY
     FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
     ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY
     DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE
     POSSIBILITY OF SUCH DAMAGE.

  6. THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
     FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.  THIS SOFTWARE
     IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE
     NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
     MODIFICATIONS.