man/man1/g_sham.1

   1 .TH g_sham 1 "Mon 4 Apr 2011" "" "GROMACS suite, VERSION 4.5.4-dev-20110404-bc5695c"
   2 .SH NAME
   3 g_sham - read/write xmgr and xvgr data sets
   4
   5 .B VERSION 4.5.4-dev-20110404-bc5695c
   6 .SH SYNOPSIS
   7 \f3g_sham\fP
   8 .BI "\-f" " graph.xvg "
   9 .BI "\-ge" " gibbs.xvg "
  10 .BI "\-ene" " esham.xvg "
  11 .BI "\-dist" " ener.xvg "
  12 .BI "\-histo" " edist.xvg "
  13 .BI "\-bin" " bindex.ndx "
  14 .BI "\-lp" " prob.xpm "
  15 .BI "\-ls" " gibbs.xpm "
  16 .BI "\-lsh" " enthalpy.xpm "
  17 .BI "\-lss" " entropy.xpm "
  18 .BI "\-map" " map.xpm "
  19 .BI "\-ls3" " gibbs3.pdb "
  20 .BI "\-mdata" " mapdata.xvg "
  21 .BI "\-g" " shamlog.log "
  22 .BI "\-[no]h" ""
  23 .BI "\-[no]version" ""
  24 .BI "\-nice" " int "
  25 .BI "\-[no]w" ""
  26 .BI "\-xvg" " enum "
  27 .BI "\-[no]time" ""
  28 .BI "\-b" " real "
  29 .BI "\-e" " real "
  30 .BI "\-ttol" " real "
  31 .BI "\-n" " int "
  32 .BI "\-[no]d" ""
  33 .BI "\-bw" " real "
  34 .BI "\-[no]sham" ""
  35 .BI "\-tsham" " real "
  36 .BI "\-pmin" " real "
  37 .BI "\-dim" " vector "
  38 .BI "\-ngrid" " vector "
  39 .BI "\-xmin" " vector "
  40 .BI "\-xmax" " vector "
  41 .BI "\-pmax" " real "
  42 .BI "\-gmax" " real "
  43 .BI "\-emin" " real "
  44 .BI "\-emax" " real "
  45 .BI "\-nlevels" " int "
  46 .BI "\-mname" " string "
  47 .SH DESCRIPTION
  48 \&\fB g_sham\fR makes multi\-dimensional free\-energy, enthalpy and entropy plots.
  49 \&\fB g_sham\fR reads one or more \fB .xvg\fR files and analyzes data sets.
  50 \&The basic purpose of \fB g_sham\fR is to plot Gibbs free energy landscapes
  51 \&(option \fB \-ls\fR)
  52 \&by Bolzmann inverting multi\-dimensional histograms (option \fB \-lp\fR),
  53 \&but it can also
  54 \&make enthalpy (option \fB \-lsh\fR) and entropy (option \fB \-lss\fR)
  55 \&plots. The histograms can be made for any quantities the user supplies.
  56 \&A line in the input file may start with a time
  57 \&(see option \fB \-time\fR) and any number of \fI y\fR\-values may follow.
  58 \&Multiple sets can also be
  59 \&read when they are separated by & (option \fB \-n\fR),
  60 \&in this case only one \fI y\fR\-value is read from each line.
  61 \&All lines starting with  and @ are skipped.
  62 \&
  63
  64
  65 \&Option \fB \-ge\fR can be used to supply a file with free energies
  66 \&when the ensemble is not a Boltzmann ensemble, but needs to be biased
  67 \&by this free energy. One free energy value is required for each
  68 \&(multi\-dimensional) data point in the \fB \-f\fR input.
  69 \&
  70
  71
  72 \&Option \fB \-ene\fR can be used to supply a file with energies.
  73 \&These energies are used as a weighting function in the single
  74 \&histogram analysis method by Kumar et al. When temperatures
  75 \&are supplied (as a second column in the file), an experimental
  76 \&weighting scheme is applied. In addition the vales
  77 \&are used for making enthalpy and entropy plots.
  78 \&
  79
  80
  81 \&With option \fB \-dim\fR, dimensions can be gives for distances.
  82 \&When a distance is 2\- or 3\-dimensional, the circumference or surface
  83 \&sampled by two particles increases with increasing distance.
  84 \&Depending on what one would like to show, one can choose to correct
  85 \&the histogram and free\-energy for this volume effect.
  86 \&The probability is normalized by r and r2 for dimensions of 2 and 3,
  87 \&respectively.
  88 \&A value of \-1 is used to indicate an angle in degrees between two
  89 \&vectors: a sin(angle) normalization will be applied.
  90 \&\fB Note\fR that for angles between vectors the inner\-product or cosine
  91 \&is the natural quantity to use, as it will produce bins of the same
  92 \&volume.
  93 .SH FILES
  94 .BI "\-f" " graph.xvg"
  95 .B Input
  96  xvgr/xmgr file
  97
  98 .BI "\-ge" " gibbs.xvg"
  99 .B Input, Opt.
 100  xvgr/xmgr file
 101
 102 .BI "\-ene" " esham.xvg"
 103 .B Input, Opt.
 104  xvgr/xmgr file
 105
 106 .BI "\-dist" " ener.xvg"
 107 .B Output, Opt.
 108  xvgr/xmgr file
 109
 110 .BI "\-histo" " edist.xvg"
 111 .B Output, Opt.
 112  xvgr/xmgr file
 113
 114 .BI "\-bin" " bindex.ndx"
 115 .B Output, Opt.
 116  Index file
 117
 118 .BI "\-lp" " prob.xpm"
 119 .B Output, Opt.
 120  X PixMap compatible matrix file
 121
 122 .BI "\-ls" " gibbs.xpm"
 123 .B Output, Opt.
 124  X PixMap compatible matrix file
 125
 126 .BI "\-lsh" " enthalpy.xpm"
 127 .B Output, Opt.
 128  X PixMap compatible matrix file
 129
 130 .BI "\-lss" " entropy.xpm"
 131 .B Output, Opt.
 132  X PixMap compatible matrix file
 133
 134 .BI "\-map" " map.xpm"
 135 .B Output, Opt.
 136  X PixMap compatible matrix file
 137
 138 .BI "\-ls3" " gibbs3.pdb"
 139 .B Output, Opt.
 140  Protein data bank file
 141
 142 .BI "\-mdata" " mapdata.xvg"
 143 .B Output, Opt.
 144  xvgr/xmgr file
 145
 146 .BI "\-g" " shamlog.log"
 147 .B Output, Opt.
 148  Log file
 149
 150 .SH OTHER OPTIONS
 151 .BI "\-[no]h"  "no    "
 152  Print help info and quit
 153
 154 .BI "\-[no]version"  "no    "
 155  Print version info and quit
 156
 157 .BI "\-nice"  " int" " 19"
 158  Set the nicelevel
 159
 160 .BI "\-[no]w"  "no    "
 161  View output \fB .xvg\fR, \fB .xpm\fR, \fB .eps\fR and \fB .pdb\fR files
 162
 163 .BI "\-xvg"  " enum" " xmgrace"
 164  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
 165
 166 .BI "\-[no]time"  "yes   "
 167  Expect a time in the input
 168
 169 .BI "\-b"  " real" " \-1    "
 170  First time to read from set
 171
 172 .BI "\-e"  " real" " \-1    "
 173  Last time to read from set
 174
 175 .BI "\-ttol"  " real" " 0     "
 176  Tolerance on time in appropriate units (usually ps)
 177
 178 .BI "\-n"  " int" " 1"
 179  Read  sets separated by &
 180
 181 .BI "\-[no]d"  "no    "
 182  Use the derivative
 183
 184 .BI "\-bw"  " real" " 0.1   "
 185  Binwidth for the distribution
 186
 187 .BI "\-[no]sham"  "yes   "
 188  Turn off energy weighting even if energies are given
 189
 190 .BI "\-tsham"  " real" " 298.15"
 191  Temperature for single histogram analysis
 192
 193 .BI "\-pmin"  " real" " 0     "
 194  Minimum probability. Anything lower than this will be set to zero
 195
 196 .BI "\-dim"  " vector" " 1 1 1"
 197  Dimensions for distances, used for volume correction (max 3 values, dimensions  3 will get the same value as the last)
 198
 199 .BI "\-ngrid"  " vector" " 32 32 32"
 200  Number of bins for energy landscapes (max 3 values, dimensions  3 will get the same value as the last)
 201
 202 .BI "\-xmin"  " vector" " 0 0 0"
 203  Minimum for the axes in energy landscape (see above for  3 dimensions)
 204
 205 .BI "\-xmax"  " vector" " 1 1 1"
 206  Maximum for the axes in energy landscape (see above for  3 dimensions)
 207
 208 .BI "\-pmax"  " real" " 0     "
 209  Maximum probability in output, default is calculate
 210
 211 .BI "\-gmax"  " real" " 0     "
 212  Maximum free energy in output, default is calculate
 213
 214 .BI "\-emin"  " real" " 0     "
 215  Minimum enthalpy in output, default is calculate
 216
 217 .BI "\-emax"  " real" " 0     "
 218  Maximum enthalpy in output, default is calculate
 219
 220 .BI "\-nlevels"  " int" " 25"
 221  Number of levels for energy landscape
 222
 223 .BI "\-mname"  " string" " "
 224  Legend label for the custom landscape
 225
 226 .SH SEE ALSO
 227 .BR gromacs(7)
 228
 229 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.