Difference between revisions of "HowTo:autodock"

From CAC Wiki
Jump to: navigation, search
(Location of the program and setup)
(Submitting Batch Jobs)
 
(10 intermediate revisions by the same user not shown)
Line 28: Line 28:
 
| valign="top" width="50%" style="padding:1em; border:1px solid #aaaaaa; background-color:#f7f7f7; border-radius:7px" |
 
| valign="top" width="50%" style="padding:1em; border:1px solid #aaaaaa; background-color:#f7f7f7; border-radius:7px" |
  
== Running NWChem from a command line==
+
== Running From a Command Line==
  
NAMD requires a number of input files to run. These include:
+
The usage of AutoDock is explained in the [http://autodock.scripps.edu/downloads/faqs-help/manual/autodock-4-2-user-guide/AutoDock4.2.6_UserGuide.pdf User's Manual] which is available for download.
* A so-called "configuration file" that declares the initial configuration for a molecular dynamics run, the force field files, number of steps in the simulation, etc.
+
* A coordinate file that gives the coordinates of the participating atoms or molecules.
+
* A parameter file declaring bond-lengths, angles, dihedrals, non-bonded parameters etc.
+
* A force-field file declaring parameters associated with atomic and molecular interactions.
+
Details about the supported format of these input files can be found in the NAMD User's Guide.
+
  
NAMD supports several running modes. In the simplest case, it can be run in serial mode by typing:
+
Input files for Autodock are in a PDBQS format for the macromolecule and in a PDBQ format for the ligand molecule. Autodock comes with additional ultilities such asmol2topdqs and addsol to convert other formats (such as mol2). For details, please check the documentation.
<pre>namd2 config_file</pre>
+
where config_file is the configuration input file mentioned above. It is recommended to give the configuration file the file extension .namd to enable consistent naming of the output files. These will be generated automatically, and the progress of the program run will be tracked on the screen.
+
  
NAMD is also able to run in parallel mode. For our shared-memory systems, it is easiest to run it by specifying the number of threads through the +p option:
+
Assuming that we have input files ligand.pdbq and macro.pdbqs, we need to make a Grid Parameter file (gpf) and a Docking Parameter file (dpf) which can be created using themkgpf3 and mkdpf3 programs. Both are part of the Autodock distribution:
<pre>namd2 +pN config_file</pre>
+
if N threads are requested.
+
  
== Submitting (parallel) NAMD jobs ==
+
<pre>mkgpf3 ligand.pdbq macro.pdbqs % mkdpf3 ligand.pdbq macro.pdbqs</pre>
  
Only short test jobs of application software can be run interactively on HPCVL machines. Production jobs must be submitted via the scheduling software Grid Engine. For usage of this software, please consult our [[FAQ:SGE|Grid Engine FAQ]].
+
This produces input files for autogrid3 and autodock3, which are called macro.gpf and ligand.macro.dpf. Both files might have to be edited manually before being used. The main part of an Autodock run then consists in calls to autogrid3 (for calculating a grid map) and autodock2 (for docking):
  
In most cases, you will be running NAMD production jobs in parallel mode. This means that you need to specify a number of CPUs that should be reserved to run each independent NAMD thread. This is done in a Grid Engine submission script:
+
<pre>
 +
autogrid3 -p macro.gpf -l macro.glg
 +
autodock3 -p ligand.macro.dpf -l ligand.macro.dlg
 +
</pre>
 +
 
 +
The -l option is used to specify log files, whereas the -p defines the input. Various other output files will be produced, someof which can be used to inspect the docking result graphically. Other utilities such as get-docked are supplied to perform the necessary conversions.
 +
 
 +
The usage of Autodock is quite complex, and the outline here cannot replace the study of the manual. A postscript version of the latter may be found in /opt/autodock/doc.
 +
 
 +
'''Note''': AutoDock does not have parallel capabilities at this point. As a result you won't get a considerable speedup for an individual run on a parallel system as compared with, say, a desktop machine. However, a parallel machine allows the simultaneous execution of multiple instances of this software.
 +
 
 +
== Submitting Batch Jobs ==
 +
 
 +
Production jobs are submitted via the Grid Engine Scheduler. To obtain details, [[HowTo:Scheduler | read our Scheduler Help File]].
 +
A sample script for the calls to autogrid3 and autodock3 looks like this:
  
 
<pre>
 
<pre>
 
#!/bin/bash
 
#!/bin/bash
 
#$ -S /bin/bash
 
#$ -S /bin/bash
#$ -q abaqus.q
 
#$ -l qname=abaqus.q
 
 
#$ -V
 
#$ -V
 
#$ -cwd
 
#$ -cwd
 
#$ -M {email address}
 
#$ -M {email address}
 
#$ -m be
 
#$ -m be
#$ -o {screen output file}
+
#$ -o {standard output file}
#$ -e {screen error file}
+
#$ -e {standard error file}
#$ -pe shm.pe {number of threads}
+
autogrid3 -p macro.gpf -l macro.glg
namd2 +p$NSLOTS {namd configuration (input) file}
+
autodock3 -p ligand.macro.dpf -l ligand.macro.dlg
 
</pre>
 
</pre>
  
The items in the template that are enclosed in {} be replaced by the appropriate values. Lines that start with "#$" contain information for Grid Engine. The "#$ -V" line tells GE to inherit the shell setup from the calling shell, for instance the $PATH variable. It is important to remember that you need to set up NAMD by issuing the "use namd" command before submitting the above script.
+
Since Autodock is serial, it is very basic. Just replace the items in curly brackets by the proper entries for your run. File name definitions for the ligand and macromolecule are assumed to be without "extensions".
 
+
"#$ -cwd" tells the system to start from the current working directory. "#$ -M" lets the system know you email address, so it can notify you when the job starts and ends. The "#$ -o" and "#$ -e" lines are there to define files that capture output that would go to the screen in an interactive run, coming from the program and the system, repsectively. Finally, the "#$ -pe" line serves to define the number of CPUs to be reserved. The number you insert here will be reused through the environment variable $NSLOTS, so that you do not have to type it again in the namd2 command line.
+
 
+
Note that the name of the configuration file that replaces "configuration file" in the script template, should have file extension .namd, just as in the interactive run.
+
 
+
Once you have a proper script file (let's call it namd.sh) you can submit your production job by typing
+
 
+
<pre>qsub namd.sh</pre>
+
 
+
The Grid Engine will take care of the rest.
+
  
 
|}
 
|}
Line 83: Line 76:
  
 
== Licensing ==
 
== Licensing ==
NAMD is free for non-commercial use, but it is licensed. As with other licensed software, we ask our users to read through the license agreement that exists between the University of Illinois and HPCVL, and to [http://www.hpcvl.org/sites/default/files/hpvcl_namd_statement.pdf sign a statement] that they agree to abide by the terms of the license. The main issue in the NAMD case is that usage has to non-commercial.
+
AutoDock is obtainable free of charge for academic research users only from the Scripps Research Institute. [http://autodock.scripps.edu/downloads To obtain your own copy, go here].
  
Once we have received the signed statement (FAX to (613) 533-2015 or scan/email to admin@hpcvl.org), we will enter the user to a Unix group namd which enables access to the software.
+
The distributors of AutoDock require their users to sign a User's Agreement, and we have done so. Our license agreement covers only academic researchers that are users, explicitly excluding any commercial or contract usage. Like with other software, we require users who want to use AutoDock, to [http://www.hpcvl.org/sites/default/files/hpvcl_autodock_license.pdf read the license agreement], and [http://www.hpcvl.org/sites/default/files/hpvcl_autodock_statement.pdf sign a statement] that they have done so and will abide by its terms. Sign it and return it to us (fax to (613) 533-2015 or [mailto:cac.admin@queensu.ca scan/email to cac.admin@queensu.ca]. You will then be included in a Unix user group "autodock" that has access to the AutoDock executables.
  
 
== More Information ==
 
== More Information ==
  
NAMD requires practice to be used efficiently. We cannot explain it use in any detail here, but
+
AutoDock is a complex software package, and requires practice to be used efficiently. In this file we can't explain its use in any detail
  
* Complete documentation for the program is available in the form of the [http://www.ks.uiuc.edu/Research/namd/documentation.html User's Guide], which is an absolute must-have if you want to use this program.  
+
* Complete documentation for the program is available in the form of [http://autodock.scripps.edu/downloads/faqs-help/manual/autodock-4-2-user-guide/AutoDock4.2.6_UserGuide.pdf the User's Manual], which is an absolute must-have if you want to use this program.
* Check out the [http://www.ks.uiuc.edu/Research/namd/ NAMD website]. They feature a very useful FAQ and even a tutorial.
+
* It is available at the official [http://autodock.scripps.edu/ AutoDock website]. This website is also your number-one address if you have questions about the program or encounter problems. They feature a useful FAQ and even a few movies.
* There is an active [http://www.ks.uiuc.edu/Research/namd/mailing_list/ NAMD Mailing List].
+
 
* '''Send [mailto:cac.help@queensu.ca|email to cac.help@queensu.ca]'''. We're happy to help.
 
* '''Send [mailto:cac.help@queensu.ca|email to cac.help@queensu.ca]'''. We're happy to help.
 
|}
 
|}

Latest revision as of 17:56, 16 May 2017

AutoDock

This is a short help file on the AutoDock suite of automated docking tools. This software allows the prediction of how small molecules bind to a receptor site of known structure. Since AutoDock is a rather sophisticated set of tools, this FAQ cannot replace the manual. It is rather meant as a starting point for using AutoDock, and to answer questions that are specific to our installation of the software.

Features

AutoDock actually consists of three separate programs:

  • AutoDock performs the docking of the ligand to a set of grids describing the target protein
  • AutoGrid pre-calculates these grids
  • AutoTors sets up which bonds will be treated as rotatable in the ligand.

AutoDock has been widely used and there are many examples of its successful application in the literature (see References). It is very fast, provides high quality predictions of ligand conformations, and good correlations between predicted inhibition constants and experimental ones. For a more complete list, see the official AutoDock homepage and click on "capabilities".

Location of the program and setup

The present version of AutoDock is 4.2.5, which is the latest as of early 2014.

Before you can access AutoDock, you need to read our license agreement and sign a statement that you have done so and will abide by it. See the last section for details.

The AutoDock program is located in the directory /opt/autodock. To access it, you have to do a setup using the usepackage facility:

use autodock305

Of course, this may be included in your setup files (probably .bash_profile), so you don't have to type them each time you run AutoDock.

Running From a Command Line

The usage of AutoDock is explained in the User's Manual which is available for download.

Input files for Autodock are in a PDBQS format for the macromolecule and in a PDBQ format for the ligand molecule. Autodock comes with additional ultilities such asmol2topdqs and addsol to convert other formats (such as mol2). For details, please check the documentation.

Assuming that we have input files ligand.pdbq and macro.pdbqs, we need to make a Grid Parameter file (gpf) and a Docking Parameter file (dpf) which can be created using themkgpf3 and mkdpf3 programs. Both are part of the Autodock distribution:

mkgpf3 ligand.pdbq macro.pdbqs % mkdpf3 ligand.pdbq macro.pdbqs

This produces input files for autogrid3 and autodock3, which are called macro.gpf and ligand.macro.dpf. Both files might have to be edited manually before being used. The main part of an Autodock run then consists in calls to autogrid3 (for calculating a grid map) and autodock2 (for docking):

autogrid3 -p macro.gpf -l macro.glg 
autodock3 -p ligand.macro.dpf -l ligand.macro.dlg 

The -l option is used to specify log files, whereas the -p defines the input. Various other output files will be produced, someof which can be used to inspect the docking result graphically. Other utilities such as get-docked are supplied to perform the necessary conversions.

The usage of Autodock is quite complex, and the outline here cannot replace the study of the manual. A postscript version of the latter may be found in /opt/autodock/doc.

Note: AutoDock does not have parallel capabilities at this point. As a result you won't get a considerable speedup for an individual run on a parallel system as compared with, say, a desktop machine. However, a parallel machine allows the simultaneous execution of multiple instances of this software.

Submitting Batch Jobs

Production jobs are submitted via the Grid Engine Scheduler. To obtain details, read our Scheduler Help File. A sample script for the calls to autogrid3 and autodock3 looks like this:

#!/bin/bash
#$ -S /bin/bash
#$ -V
#$ -cwd
#$ -M {email address}
#$ -m be
#$ -o {standard output file}
#$ -e {standard error file}
autogrid3 -p macro.gpf -l macro.glg 
autodock3 -p ligand.macro.dpf -l ligand.macro.dlg 

Since Autodock is serial, it is very basic. Just replace the items in curly brackets by the proper entries for your run. File name definitions for the ligand and macromolecule are assumed to be without "extensions".

Licensing

AutoDock is obtainable free of charge for academic research users only from the Scripps Research Institute. To obtain your own copy, go here.

The distributors of AutoDock require their users to sign a User's Agreement, and we have done so. Our license agreement covers only academic researchers that are users, explicitly excluding any commercial or contract usage. Like with other software, we require users who want to use AutoDock, to read the license agreement, and sign a statement that they have done so and will abide by its terms. Sign it and return it to us (fax to (613) 533-2015 or scan/email to cac.admin@queensu.ca. You will then be included in a Unix user group "autodock" that has access to the AutoDock executables.

More Information

AutoDock is a complex software package, and requires practice to be used efficiently. In this file we can't explain its use in any detail.

  • Complete documentation for the program is available in the form of the User's Manual, which is an absolute must-have if you want to use this program.
  • It is available at the official AutoDock website. This website is also your number-one address if you have questions about the program or encounter problems. They feature a useful FAQ and even a few movies.
  • Send to cac.help@queensu.ca. We're happy to help.