Feig at 22:45, 13 September 2010

2010-09-13T22:45:48Z

New page

__NOTOC__
== Usage ==

<mmtsbToolUsage cmd="enerCHARMM.pl"></mmtsbToolUsage>

== Description ==

This script uses CHARMM to evaluate the energy of a protein structure from a PDB file
or from a CHARMM PSF and coordinate files given with -psf.
It does not perform any minimization or refinement and is most useful with previously
minimized structures. A common application is the evaluation of implicit solvent
Generalized Born energy terms for structures that have been minimized in vacuum only
as a compromise between speed and accuracy of the energy score. 
CHARMM parameters can be given in a list of key=value pairs with -par. A
list of all available parameters is given
[http://feig.bch.msu.edu/mmtsb/CHARMM_Parameters here]. 
Once the energies have been evaluated the total energy or some or all components may be
written to standard output. The flag -out is used to specify a list of desired
energy values, separated by commas.
Possible choices are total, bonds, angles,
ureyb, dihedrals, impropers, vdwaals, elec,
gb, and sasa (hydrophobic solvation free energy based on solvent
accessible surface). All available energy values are written out with -all.
It is also possible to specify limited arithmetic operators. + and - are supported
to report a sum or difference, a multiplicative factor can be given with *
in front of a property name. If more than one value is requested they are
reported each on a separate line. The flag -oneline can be used to request
that multiple values are written out in a single line, separated by spaces.
By default only the total energy is written out. 
Rather than the total energy it is also possible to calculate interaction energies
for a subset of residues with this utility. To do this the residue range
of interest has to be given with -l. Then, the interaction energy of those
residues with themselves and with all other residues are calculated.
If the option -self is given only the self energy contributions are considered.
 
The option -log is available to save the complete
output from CHARMM under the given file name. Commands sent to CHARMM are saved in
a file with -cmd. 
The location of the CHARMM binary and data directory are
set from the environment variables CHARMMEXEC and CHARMMDATA or
deduced from a charmm binary found in the search path. 

== Options ==

; -help : usage information
; -out energy-terms : specify which energy terms to output
; -all : write out all energy terms
; -oneline : output results in a single line
; -charge : output total charge of a system
; -dipole : output dipole of a system
; -mass : use center of mass as origin for dipole calculation (instead of center of geometry)
; -oxyz : use origin of coordinate system as origin for dipole calculation
; -psf PSFfile CRDfile : load topology and coordinates from PSF and CRD files
; -mol2 MOL2file : load topology and coordinates from MOL2 file
; -par key=value[,...] : CHARMM parameter
; -l min:max[=...] : calculate interaction energies of residue range with itself and rest of system
; -self : only output self energies for residue range
; -log file : CHARMM log file
; -cmd file : CHARMM input file
; -custom file : CHARMM custom file loaded before energy calculation

== Examples ==

<mmtsbToolExample cmd="enerCHARMM.pl" set="/apps/mmtsb/bench/enerCHARMM.pl-test/test1"></mmtsbToolExample>

<mmtsbToolExample cmd="enerCHARMM.pl" set="/apps/mmtsb/bench/enerCHARMM.pl-test/test2"></mmtsbToolExample>

enerCHARMM.pl - Revision history

Feig at 22:45, 13 September 2010