4.5.7 release
[gromacs.git] / man / man1 / g_disre.1
blobcf9fd1efadf1621401ef91d1bb504c17e2c64057
1 .TH g_disre 1 "Fri 19 Apr 2013" "" "GROMACS suite, VERSION 4.5.7"
2 .SH NAME
3 g_disre - analyzes distance restraints
5 .B VERSION 4.5.7
6 .SH SYNOPSIS
7 \f3g_disre\fP
8 .BI "\-s" " topol.tpr "
9 .BI "\-f" " traj.xtc "
10 .BI "\-ds" " drsum.xvg "
11 .BI "\-da" " draver.xvg "
12 .BI "\-dn" " drnum.xvg "
13 .BI "\-dm" " drmax.xvg "
14 .BI "\-dr" " restr.xvg "
15 .BI "\-l" " disres.log "
16 .BI "\-n" " viol.ndx "
17 .BI "\-q" " viol.pdb "
18 .BI "\-c" " clust.ndx "
19 .BI "\-x" " matrix.xpm "
20 .BI "\-[no]h" ""
21 .BI "\-[no]version" ""
22 .BI "\-nice" " int "
23 .BI "\-b" " time "
24 .BI "\-e" " time "
25 .BI "\-dt" " time "
26 .BI "\-[no]w" ""
27 .BI "\-xvg" " enum "
28 .BI "\-ntop" " int "
29 .BI "\-maxdr" " real "
30 .BI "\-nlevels" " int "
31 .BI "\-[no]third" ""
32 .SH DESCRIPTION
33 \&\fB g_disre\fR computes violations of distance restraints.
34 \&If necessary, all protons can be added to a protein molecule 
35 \&using the \fB g_protonate\fR program.
38 \&The program always
39 \&computes the instantaneous violations rather than time\-averaged,
40 \&because this analysis is done from a trajectory file afterwards
41 \&it does not make sense to use time averaging. However,
42 \&the time averaged values per restraint are given in the log file.
45 \&An index file may be used to select specific restraints for
46 \&printing.
49 \&When the optional \fB \-q\fR flag is given a \fB .pdb\fR file coloured by the
50 \&amount of average violations.
53 \&When the \fB \-c\fR option is given, an index file will be read
54 \&containing the frames in your trajectory corresponding to the clusters
55 \&(defined in another manner) that you want to analyze. For these clusters
56 \&the program will compute average violations using the third power
57 \&averaging algorithm and print them in the log file.
58 .SH FILES
59 .BI "\-s" " topol.tpr" 
60 .B Input
61  Run input file: tpr tpb tpa 
63 .BI "\-f" " traj.xtc" 
64 .B Input
65  Trajectory: xtc trr trj gro g96 pdb cpt 
67 .BI "\-ds" " drsum.xvg" 
68 .B Output
69  xvgr/xmgr file 
71 .BI "\-da" " draver.xvg" 
72 .B Output
73  xvgr/xmgr file 
75 .BI "\-dn" " drnum.xvg" 
76 .B Output
77  xvgr/xmgr file 
79 .BI "\-dm" " drmax.xvg" 
80 .B Output
81  xvgr/xmgr file 
83 .BI "\-dr" " restr.xvg" 
84 .B Output
85  xvgr/xmgr file 
87 .BI "\-l" " disres.log" 
88 .B Output
89  Log file 
91 .BI "\-n" " viol.ndx" 
92 .B Input, Opt.
93  Index file 
95 .BI "\-q" " viol.pdb" 
96 .B Output, Opt.
97  Protein data bank file 
99 .BI "\-c" " clust.ndx" 
100 .B Input, Opt.
101  Index file 
103 .BI "\-x" " matrix.xpm" 
104 .B Output, Opt.
105  X PixMap compatible matrix file 
107 .SH OTHER OPTIONS
108 .BI "\-[no]h"  "no    "
109  Print help info and quit
111 .BI "\-[no]version"  "no    "
112  Print version info and quit
114 .BI "\-nice"  " int" " 19" 
115  Set the nicelevel
117 .BI "\-b"  " time" " 0     " 
118  First frame (ps) to read from trajectory
120 .BI "\-e"  " time" " 0     " 
121  Last frame (ps) to read from trajectory
123 .BI "\-dt"  " time" " 0     " 
124  Only use frame when t MOD dt = first time (ps)
126 .BI "\-[no]w"  "no    "
127  View output \fB .xvg\fR, \fB .xpm\fR, \fB .eps\fR and \fB .pdb\fR files
129 .BI "\-xvg"  " enum" " xmgrace" 
130  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
132 .BI "\-ntop"  " int" " 0" 
133  Number of large violations that are stored in the log file every step
135 .BI "\-maxdr"  " real" " 0     " 
136  Maximum distance violation in matrix output. If less than or equal to 0 the maximum will be determined by the data.
138 .BI "\-nlevels"  " int" " 20" 
139  Number of levels in the matrix output
141 .BI "\-[no]third"  "yes   "
142  Use inverse third power averaging or linear for matrix output
144 .SH SEE ALSO
145 .BR gromacs(7)
147 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.