Added 1 analysis tool manual.
[gromacs/rigid-bodies.git] / man / man1 / g_energy.1
blob617df4e23f4e27657b857f6fc2b23ee99f6467cf
1 .TH g_energy 1 "Mon 4 Apr 2011" "" "GROMACS suite, VERSION 4.5.4-dev-20110404-3c0e5ec"
2 .SH NAME
3 g_energy - writes energies to xvg files and displays averages
5 .B VERSION 4.5.4-dev-20110404-3c0e5ec
6 .SH SYNOPSIS
7 \f3g_energy\fP
8 .BI "\-f" " ener.edr "
9 .BI "\-f2" " ener.edr "
10 .BI "\-s" " topol.tpr "
11 .BI "\-o" " energy.xvg "
12 .BI "\-viol" " violaver.xvg "
13 .BI "\-pairs" " pairs.xvg "
14 .BI "\-ora" " orienta.xvg "
15 .BI "\-ort" " orientt.xvg "
16 .BI "\-oda" " orideva.xvg "
17 .BI "\-odr" " oridevr.xvg "
18 .BI "\-odt" " oridevt.xvg "
19 .BI "\-oten" " oriten.xvg "
20 .BI "\-corr" " enecorr.xvg "
21 .BI "\-vis" " visco.xvg "
22 .BI "\-ravg" " runavgdf.xvg "
23 .BI "\-odh" " dhdl.xvg "
24 .BI "\-[no]h" ""
25 .BI "\-[no]version" ""
26 .BI "\-nice" " int "
27 .BI "\-b" " time "
28 .BI "\-e" " time "
29 .BI "\-[no]w" ""
30 .BI "\-xvg" " enum "
31 .BI "\-[no]fee" ""
32 .BI "\-fetemp" " real "
33 .BI "\-zero" " real "
34 .BI "\-[no]sum" ""
35 .BI "\-[no]dp" ""
36 .BI "\-nbmin" " int "
37 .BI "\-nbmax" " int "
38 .BI "\-[no]mutot" ""
39 .BI "\-skip" " int "
40 .BI "\-[no]aver" ""
41 .BI "\-nmol" " int "
42 .BI "\-[no]fluc" ""
43 .BI "\-[no]orinst" ""
44 .BI "\-[no]ovec" ""
45 .BI "\-acflen" " int "
46 .BI "\-[no]normalize" ""
47 .BI "\-P" " enum "
48 .BI "\-fitfn" " enum "
49 .BI "\-ncskip" " int "
50 .BI "\-beginfit" " real "
51 .BI "\-endfit" " real "
52 .SH DESCRIPTION
53 \&\fB g_energy\fR extracts energy components or distance restraint
54 \&data from an energy file. The user is prompted to interactively
55 \&select the desired energy terms.
58 \&Average, RMSD, and drift are calculated with full precision from the
59 \&simulation (see printed manual). Drift is calculated by performing
60 \&a least\-squares fit of the data to a straight line. The reported total drift
61 \&is the difference of the fit at the first and last point.
62 \&An error estimate of the average is given based on a block averages
63 \&over 5 blocks using the full\-precision averages. The error estimate
64 \&can be performed over multiple block lengths with the options
65 \&\fB \-nbmin\fR and \fB \-nbmax\fR.
66 \&\fB Note\fR that in most cases the energy files contains averages over all
67 \&MD steps, or over many more points than the number of frames in
68 \&energy file. This makes the \fB g_energy\fR statistics output more accurate
69 \&than the \fB .xvg\fR output. When exact averages are not present in the energy
70 \&file, the statistics mentioned above are simply over the single, per\-frame
71 \&energy values.
74 \&The term fluctuation gives the RMSD around the least\-squares fit.
77 \&When the \fB \-viol\fR option is set, the time averaged
78 \&violations are plotted and the running time\-averaged and
79 \&instantaneous sum of violations are recalculated. Additionally
80 \&running time\-averaged and instantaneous distances between
81 \&selected pairs can be plotted with the \fB \-pairs\fR option.
84 \&Options \fB \-ora\fR, \fB \-ort\fR, \fB \-oda\fR, \fB \-odr\fR and
85 \&\fB \-odt\fR are used for analyzing orientation restraint data.
86 \&The first two options plot the orientation, the last three the
87 \&deviations of the orientations from the experimental values.
88 \&The options that end on an 'a' plot the average over time
89 \&as a function of restraint. The options that end on a 't'
90 \&prompt the user for restraint label numbers and plot the data
91 \&as a function of time. Option \fB \-odr\fR plots the RMS
92 \&deviation as a function of restraint.
93 \&When the run used time or ensemble averaged orientation restraints,
94 \&option \fB \-orinst\fR can be used to analyse the instantaneous,
95 \&not ensemble\-averaged orientations and deviations instead of
96 \&the time and ensemble averages.
99 \&Option \fB \-oten\fR plots the eigenvalues of the molecular order
100 \&tensor for each orientation restraint experiment. With option
101 \&\fB \-ovec\fR also the eigenvectors are plotted.
104 \&Option \fB \-odh\fR extracts and plots the free energy data
105 \&(Hamiltoian differences and/or the Hamiltonian derivative dhdl)
106 \&from the \fB ener.edr\fR file.
109 \&With \fB \-fee\fR an estimate is calculated for the free\-energy
110 \&difference with an ideal gas state: 
112 \&  [GRK]Delta[grk] A = A(N,V,T) \- A_idgas(N,V,T) = kT ln  e(Upot/kT) 
114 \&  [GRK]Delta[grk] G = G(N,p,T) \- G_idgas(N,p,T) = kT ln  e(Upot/kT) 
116 \&where k is Boltzmann's constant, T is set by \fB \-fetemp\fR and
117 \&the average is over the ensemble (or time in a trajectory).
118 \&Note that this is in principle
119 \&only correct when averaging over the whole (Boltzmann) ensemble
120 \&and using the potential energy. This also allows for an entropy
121 \&estimate using:
123 \&  [GRK]Delta[grk] S(N,V,T) = S(N,V,T) \- S_idgas(N,V,T) = (Upot \- [GRK]Delta[grk] A)/T
125 \&  [GRK]Delta[grk] S(N,p,T) = S(N,p,T) \- S_idgas(N,p,T) = (Upot + pV \- [GRK]Delta[grk] G)/T
129 \&When a second energy file is specified (\fB \-f2\fR), a free energy
130 \&difference is calculated dF = \-kT ln  e  \-(EB\-EA)/kT A ,
131 \&where EA and EB are the energies from the first and second energy
132 \&files, and the average is over the ensemble A. The running average
133 \&of the free energy difference is printed to a file specified by \fB \-ravg\fR.
134 \&\fB Note\fR that the energies must both be calculated from the same trajectory.
135 .SH FILES
136 .BI "\-f" " ener.edr" 
137 .B Input
138  Energy file 
140 .BI "\-f2" " ener.edr" 
141 .B Input, Opt.
142  Energy file 
144 .BI "\-s" " topol.tpr" 
145 .B Input, Opt.
146  Run input file: tpr tpb tpa 
148 .BI "\-o" " energy.xvg" 
149 .B Output
150  xvgr/xmgr file 
152 .BI "\-viol" " violaver.xvg" 
153 .B Output, Opt.
154  xvgr/xmgr file 
156 .BI "\-pairs" " pairs.xvg" 
157 .B Output, Opt.
158  xvgr/xmgr file 
160 .BI "\-ora" " orienta.xvg" 
161 .B Output, Opt.
162  xvgr/xmgr file 
164 .BI "\-ort" " orientt.xvg" 
165 .B Output, Opt.
166  xvgr/xmgr file 
168 .BI "\-oda" " orideva.xvg" 
169 .B Output, Opt.
170  xvgr/xmgr file 
172 .BI "\-odr" " oridevr.xvg" 
173 .B Output, Opt.
174  xvgr/xmgr file 
176 .BI "\-odt" " oridevt.xvg" 
177 .B Output, Opt.
178  xvgr/xmgr file 
180 .BI "\-oten" " oriten.xvg" 
181 .B Output, Opt.
182  xvgr/xmgr file 
184 .BI "\-corr" " enecorr.xvg" 
185 .B Output, Opt.
186  xvgr/xmgr file 
188 .BI "\-vis" " visco.xvg" 
189 .B Output, Opt.
190  xvgr/xmgr file 
192 .BI "\-ravg" " runavgdf.xvg" 
193 .B Output, Opt.
194  xvgr/xmgr file 
196 .BI "\-odh" " dhdl.xvg" 
197 .B Output, Opt.
198  xvgr/xmgr file 
200 .SH OTHER OPTIONS
201 .BI "\-[no]h"  "no    "
202  Print help info and quit
204 .BI "\-[no]version"  "no    "
205  Print version info and quit
207 .BI "\-nice"  " int" " 19" 
208  Set the nicelevel
210 .BI "\-b"  " time" " 0     " 
211  First frame (ps) to read from trajectory
213 .BI "\-e"  " time" " 0     " 
214  Last frame (ps) to read from trajectory
216 .BI "\-[no]w"  "no    "
217  View output \fB .xvg\fR, \fB .xpm\fR, \fB .eps\fR and \fB .pdb\fR files
219 .BI "\-xvg"  " enum" " xmgrace" 
220  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
222 .BI "\-[no]fee"  "no    "
223  Do a free energy estimate
225 .BI "\-fetemp"  " real" " 300   " 
226  Reference temperature for free energy calculation
228 .BI "\-zero"  " real" " 0     " 
229  Subtract a zero\-point energy
231 .BI "\-[no]sum"  "no    "
232  Sum the energy terms selected rather than display them all
234 .BI "\-[no]dp"  "no    "
235  Print energies in high precision
237 .BI "\-nbmin"  " int" " 5" 
238  Minimum number of blocks for error estimate
240 .BI "\-nbmax"  " int" " 5" 
241  Maximum number of blocks for error estimate
243 .BI "\-[no]mutot"  "no    "
244  Compute the total dipole moment from the components
246 .BI "\-skip"  " int" " 0" 
247  Skip number of frames between data points
249 .BI "\-[no]aver"  "no    "
250  Also print the exact average and rmsd stored in the energy frames (only when 1 term is requested)
252 .BI "\-nmol"  " int" " 1" 
253  Number of molecules in your sample: the energies are divided by this number
255 .BI "\-[no]fluc"  "no    "
256  Calculate autocorrelation of energy fluctuations rather than energy itself
258 .BI "\-[no]orinst"  "no    "
259  Analyse instantaneous orientation data
261 .BI "\-[no]ovec"  "no    "
262  Also plot the eigenvectors with \fB \-oten\fR
264 .BI "\-acflen"  " int" " \-1" 
265  Length of the ACF, default is half the number of frames
267 .BI "\-[no]normalize"  "yes   "
268  Normalize ACF
270 .BI "\-P"  " enum" " 0" 
271  Order of Legendre polynomial for ACF (0 indicates none): \fB 0\fR, \fB 1\fR, \fB 2\fR or \fB 3\fR
273 .BI "\-fitfn"  " enum" " none" 
274  Fit function: \fB none\fR, \fB exp\fR, \fB aexp\fR, \fB exp_exp\fR, \fB vac\fR, \fB exp5\fR, \fB exp7\fR, \fB exp9\fR or \fB erffit\fR
276 .BI "\-ncskip"  " int" " 0" 
277  Skip N points in the output file of correlation functions
279 .BI "\-beginfit"  " real" " 0     " 
280  Time where to begin the exponential fit of the correlation function
282 .BI "\-endfit"  " real" " \-1    " 
283  Time where to end the exponential fit of the correlation function, \-1 is until the end
285 .SH SEE ALSO
286 .BR gromacs(7)
288 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.