Fixed make_edi.c
[gromacs/rigid-bodies.git] / man / man1 / g_wham.1
blob01e514dcdd6138fe374aec8e82d151b221f667ee
1 .TH g_wham 1 "Thu 16 Oct 2008"
2 .SH NAME
3 g_wham - weighted histogram analysis after umbrella sampling
5 .B VERSION 4.0
6 .SH SYNOPSIS
7 \f3g_wham\fP
8 .BI "-o" " profile.xvg "
9 .BI "-hist" " histo.xvg "
10 .BI "-[no]h" ""
11 .BI "-nice" " int "
12 .BI "-[no]w" ""
13 .BI "-[no]xvgr" ""
14 .BI "-min" " real "
15 .BI "-max" " real "
16 .BI "-bins" " int "
17 .BI "-[no]prof" ""
18 .BI "-temp" " real "
19 .BI "-[no]flip" ""
20 .BI "-tol" " real "
21 .SH DESCRIPTION
22 This is an analysis program that implements the Weighted
23 Histogram Analysis Method (WHAM).  It is intended to analyze
24 .pdo files generated by mdrun using umbrella sampling tocreate a potential of mean force (PMF). The options are
26   
27 .B -o
28      name of the PMF output file
30   
31 .B -hist
32   name of the histograms output file
34   
35 .B -min
36    minimum coordinate to use
38   
39 .B -max
40    maximum coordinate to use
43 Note: the program will throw out any data that is outside
44 of min - max. The program will output the true min and max
45 after completion, so you can use these values the next time.
46 or you can use:
48   
49 .B -noprof
50 only calculate min and max
52   
53 .B -bins
54   number of bins to use in calculation
56 .SH FILES
57 .BI "-o" " profile.xvg" 
58 .B Output
59  xvgr/xmgr file 
61 .BI "-hist" " histo.xvg" 
62 .B Output
63  xvgr/xmgr file 
65 .SH OTHER OPTIONS
66 .BI "-[no]h"  "no    "
67  Print help info and quit
69 .BI "-nice"  " int" " 0" 
70  Set the nicelevel
72 .BI "-[no]w"  "no    "
73  View output xvg, xpm, eps and pdb files
75 .BI "-[no]xvgr"  "yes   "
76  Add specific codes (legends etc.) in the output xvg files for the xmgrace program
78 .BI "-min"  " real" " 0     " 
79  Minimum coordinate in profile
81 .BI "-max"  " real" " 0     " 
82  Maximum coordinate in profile
84 .BI "-bins"  " int" " 100" 
85  Number of bins in profile
87 .BI "-[no]prof"  "yes   "
88  Only calculate min and max
90 .BI "-temp"  " real" " 298   " 
91  Temperature
93 .BI "-[no]flip"  "no    "
94  Combine halves of profile
96 .BI "-tol"  " real" " 0.01  " 
97  Tolerance