Package AutoDockTools :: Module autodpfCommands
[hide private]
[frames] | no frames]

Module autodpfCommands

source code


This Module facilitates producing a docking parameter file for AutoDock. The steps in this process are:

    * Selecting the macromolecule filename: The user can select the macromolecule for autodpf in three ways: it can be chosen from molecules previously added to the moleculeViewer, it can be picked as a PDB file,  or it can be picked as a MOL2 file:

        o Choose Macromol...

        o Select PDB Macromolecule 

        o Select MOL2 Macromolecule

    * Selecting the small molecule which has been previously formatted by AutoTors: 

        o Via Reading a PDBQ-File which adds the ligand to the viewer

    * The user sets parameters pertaining to the small molecule 

        o Checking that a grid map exists for each of the ligand atom types 

        o Indicating whether a floating grid map exists

        o Setting the initial translation of the small molecule

            - by choosing  the 'random' option which sets a random starting position for the ligand

            - by entering the desired coordinates in the entry

        o Setting the initial quaternion of the small molecule

            - by choosing  the 'random' option which sets a random starting quaternion.

            - by entering the desired initial quaternion -Qx,Qy,Qz,Qw in the entry.  Qx, Qy, Qz define the unit vector in the direction of rigid body rotation and Qw the angle of rotation about this unit vector.

        o Setting the coefficient of the torsional DOF

        o By choosing to set the initial dihedrals for the small molecule or not: If not, AutoDock assumes that the chi1, chi2, chi3 etc are all zero and does not change the initial ligand torsion angles. If the user chooses to set the initial dihedrals, he further chooses:

            - for them to be randomly assigned 

            - an initial relative dihedral angle for each active torsion in the ligand.

        o The user can specify two types of torsion constraints for the ligand:

            -  Gaussian constraints which use an inverted Gaussian bell curve to calculate the energy function input of the constraint.  This type of constraint is specified by two floating point numbers: the perferred angle in the range -180-+180decreeds and the half-width which is the difference between two angles at which the energy is half the barrier PLUS an integer which identifies the torsion according to the list at the top of the AutoTors-generated input ligand PDBQ file. More than one constraint of this type may be specified for a single torsion.

            - Hard torsion constraints may also be specified. These differ from the previous type in that the torsion is never allowed to take values bewond the range defined and in that the second parameter is the full width of the allowed range of torsion angles. Moreover, only one constraint of this type is allowed per torsion.

        o If the user specifies torsion constraints, he may also specify the height of the energy barrier to be applied to these constraints.

        o If the user specifies Gaussian torsion constraints, he may also specify whether to store and output the torsion energies

    * The user sets parameters pertaining to docking algorithm(s) he wishes to use
:
        o Setting Simulated Annealing parameters.

        o Setting Genetic Algorithm parameters (GA).

        o Setting Local Search parameters (LS).

    It is important to remember that any of these may be used alone but only GA and LS may be used together


    * The user adjusts these additional parameters: 
    
        o the step sizes of translation, quaternion rotation and dihedral torsion change.
        o  energy parameters including energy assigned to atoms outside the grid volume, the maximum allowable initial energy and the maximum number of retries.

        o output format parameters including the level of detail for the output, the rms cluster tolerance, the reference file for rms calculations and whether to do symmetry checking in the rms calculations.


    * The user selects which kind of docking parameter file to write : 
    
        o Simulated Annealing 

        o GA

        o LS

        o GALS


    * The results of the previous steps are written to a file. The user selects a filename via a filebrowser.  By convention, the file should have a .dpf extension. If no macromolecule has been selected, it is not possible to write a grid parameter file and the user gets a warning message to that effect. Likewise, the types of the maps to be calculated must be set before the grid parameter file is written and a warning message to this effect appears if the types have not been set.
(A checkbutton, "DONE", allows the user to withdraw the autoTools menuBar)
    



Classes [hide private]
  DpfSetDpo
  DpfLoadDefaults
allows user to select a file containing a set of defaults
  DpfMacroSelector
allows user to select a filename for the macromolecule
  Dpf4MacroSelector
allows user to select a filename for the macromolecule
  Dpf4FlexResSelector
allows user to select a flexible residue filename
  DpfMacroChooser
allows user to choose a molecule already present for the macromolecule
  Dpf4MacroChooser
allows user to choose a molecule already present for the macromolecule
  DpfInitLigand
initializes the ligand
  DpfLigandChooser
allows user to choose a molecule already present for the ligand
  DpfLigPDBQReader
allows user to choose a PDBQ file for the ligand
  Dpf4InitLigand
initializes the ligand for AutoDock4 FIX THIS TO SET TYPES APPROPRIATELY
  Dpf4LigandChooser
allows user to choose a molecule already present for the ligand
  Dpf4LigPDBQReader
allows user to choose a PDBQ file for the ligand
  DpfEditor
allows user to edit current output file and write it
  DpfSAWriter
allows user to choose an output filename and write simulated annealing parameters
  DpfGAWriter
allows user to choose an output filename and write it
  DpfLSWriter
allows user to choose an output filename and write it
  DpfGALSWriter
allows user to choose an output filename and write it
  DpfClusterWriter
allows user to write a dpf to cluster many dockings
  Dpf4SAWriter
allows user to choose an output filename and write simulated annealing parameters
  Dpf4GAWriter
allows user to choose an output filename and write it
  Dpf4LSWriter
allows user to choose an output filename and write it
  Dpf4GALSWriter
allows user to choose an output filename and write it
  Dpf4ClusterWriter
allows user to write a dpf to cluster many dockings
  SimAnneal
allows user to set necessary parameters for simulated annealing-based autodock job
  GA
allows user to set necessary parameters for genetic algorithm-based autodock job
  LS
allows user to set necessary parameters for local search-based autodock job
  SetDockingRunParms
allows user to set these parameters for autodock job: step sizes, energy parameters and format for the output
  SetAutoDock4Parameters
allows user to set these parameters for autodock4 job: (1)parameter_file, (2)include_1_4_interactions (+float), (3)unbound float, (4)epdb filename
  StopAutoDpf
hides the autotools menubar and

Functions [hide private]
  checkHasDpo(vf)
  setDpoFields(ligand, dpo)
    'name':'ADdpf_writeCluster','cmd':DpfClusterWriter(),'gui':DpfClusterWriterGUI},
  initModule(vf)

Variables [hide private]
  menuText = {'ChooseLigand': 'Choose...(AD3)', 'ReadDpfMB': 'Ope...
  DpfLoadDefaultsGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  DpfMacroSelectorGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  Dpf4MacroSelectorGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  Dpf4FlexResSelectorGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  DpfMacroChooserGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  Dpf4MacroChooserGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  DpfInitLigandGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  sortKeyList = ['C', 'A', 'N', 'O', 'S', 'H', 'P', 'n', 'f', 'F', '...
  DpfLigandChooserGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  DpfLigPDBQReaderGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  Dpf4InitLigandGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  Dpf4LigandChooserGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  Dpf4LigPDBQReaderGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  DpfEditorGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  DpfSAWriterGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  DpfGAWriterGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  DpfLSWriterGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  DpfGALSWriterGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  DpfClusterWriterGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  Dpf4SAWriterGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  Dpf4GAWriterGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  Dpf4LSWriterGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  Dpf4GALSWriterGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  Dpf4ClusterWriterGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  SimAnnealGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  GAGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  LSGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  SetDockingRunParmsGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
  SetAutoDock4ParametersGUI = <ViewerFramework.VFCommand.CommandGUI instance at 0x...
    'name':'ADdpf_writeCluster','cmd':DpfClusterWriter(),'gui':DpfClusterWriterGUI},
  commandList = [{'gui': <ViewerFramework.VFCommand.CommandGUI insta...

Function Details [hide private]

checkHasDpo(vf)

source code 
None

setDpoFields(ligand, dpo)

source code 
None

initModule(vf)

source code 
None

Variables Details [hide private]

menuText

None
Value:
{'AdjustLigand': 'Ligand Parameters...(AD3)',
 'AdjustLigand4': 'Ligand Parameters...',
 'AutoDpfMB': 'Docking',
 'ChooseLigand': 'Choose...(AD3)',
 'ChooseLigand4': 'Choose...',
 'ChooseMacro': 'Choose...(AD3)',
 'ChooseMacro4': 'Choose...',
 'EditDpfMB': 'Edit DPF...',
...                                                                    
      

DpfLoadDefaultsGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c806c>          
      

DpfMacroSelectorGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c80ac>          
      

Dpf4MacroSelectorGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c80ec>          
      

Dpf4FlexResSelectorGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c812c>          
      

DpfMacroChooserGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c81ac>          
      

Dpf4MacroChooserGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c822c>          
      

DpfInitLigandGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c832c>          
      

sortKeyList

None
Value:
['C', 'A', 'N', 'O', 'S', 'H', 'P', 'n', 'f', 'F', 'c', 'b', 'I', 'M'] 
      

DpfLigandChooserGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c83ac>          
      

DpfLigPDBQReaderGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c842c>          
      

Dpf4InitLigandGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c852c>          
      

Dpf4LigandChooserGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c85cc>          
      

Dpf4LigPDBQReaderGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c866c>          
      

DpfEditorGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c86cc>          
      

DpfSAWriterGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c872c>          
      

DpfGAWriterGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c878c>          
      

DpfLSWriterGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c87ec>          
      

DpfGALSWriterGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c884c>          
      

DpfClusterWriterGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c88ac>          
      

Dpf4SAWriterGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c890c>          
      

Dpf4GAWriterGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c896c>          
      

Dpf4LSWriterGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c89cc>          
      

Dpf4GALSWriterGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c8a2c>          
      

Dpf4ClusterWriterGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c8a8c>          
      

SimAnnealGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c8b2c>          
      

GAGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c8bec>          
      

LSGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c8c8c>          
      

SetDockingRunParmsGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c8dac>          
      

SetAutoDock4ParametersGUI

None
Value:
<ViewerFramework.VFCommand.CommandGUI instance at 0xb70c8e4c>          
      

commandList

None
Value:
[{'cmd': self.,
  'gui': <ViewerFramework.VFCommand.CommandGUI instance at 0xb70c806c>
,
  'name': 'ADdpf_read'},
 {'gui': None, 'cmd': self., 'name': 'ADdpf_setDpo'},
 {'cmd': self.,
  'gui': <ViewerFramework.VFCommand.CommandGUI instance at 0xb70c80ec>
,
...