New entry
[gromacs/rigid-bodies.git] / man / man1 / g_chi.1
blob5625ba215e7cddf5f6103bb06bb3db97f8fb1b80
1 .TH g_chi 1 "Mon 4 Apr 2011" "" "GROMACS suite, VERSION 4.5.4-dev-20110404-bc5695c"
2 .SH NAME
3 g_chi - calculates everything you want to know about chi and other dihedrals
5 .B VERSION 4.5.4-dev-20110404-bc5695c
6 .SH SYNOPSIS
7 \f3g_chi\fP
8 .BI "\-s" " conf.gro "
9 .BI "\-f" " traj.xtc "
10 .BI "\-o" " order.xvg "
11 .BI "\-p" " order.pdb "
12 .BI "\-ss" " ssdump.dat "
13 .BI "\-jc" " Jcoupling.xvg "
14 .BI "\-corr" " dihcorr.xvg "
15 .BI "\-g" " chi.log "
16 .BI "\-ot" " dihtrans.xvg "
17 .BI "\-oh" " trhisto.xvg "
18 .BI "\-rt" " restrans.xvg "
19 .BI "\-cp" " chiprodhisto.xvg "
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 "\-r0" " int "
29 .BI "\-[no]phi" ""
30 .BI "\-[no]psi" ""
31 .BI "\-[no]omega" ""
32 .BI "\-[no]rama" ""
33 .BI "\-[no]viol" ""
34 .BI "\-[no]periodic" ""
35 .BI "\-[no]all" ""
36 .BI "\-[no]rad" ""
37 .BI "\-[no]shift" ""
38 .BI "\-binwidth" " int "
39 .BI "\-core_rotamer" " real "
40 .BI "\-maxchi" " enum "
41 .BI "\-[no]normhisto" ""
42 .BI "\-[no]ramomega" ""
43 .BI "\-bfact" " real "
44 .BI "\-[no]chi_prod" ""
45 .BI "\-[no]HChi" ""
46 .BI "\-bmax" " real "
47 .BI "\-acflen" " int "
48 .BI "\-[no]normalize" ""
49 .BI "\-P" " enum "
50 .BI "\-fitfn" " enum "
51 .BI "\-ncskip" " int "
52 .BI "\-beginfit" " real "
53 .BI "\-endfit" " real "
54 .SH DESCRIPTION
55 \&\fB g_chi\fR computes phi, psi, omega, and chi dihedrals for all your 
56 \&amino acid backbone and sidechains.
57 \&It can compute dihedral angle as a function of time, and as
58 \&histogram distributions.
59 \&The distributions \fB (histo\-(dihedral)(RESIDUE).xvg\fR) are cumulative over all residues of each type.
62 \&If option \fB \-corr\fR is given, the program will
63 \&calculate dihedral autocorrelation functions. The function used
64 \&is C(t) =  cos(chi(tau)) cos(chi(tau+t)) . The use of cosines
65 \&rather than angles themselves, resolves the problem of periodicity.
66 \&(Van der Spoel & Berendsen (1997), Biophys. J. 72, 2032\-2041).
67 \&Separate files for each dihedral of each residue
68 \&\fB (corr(dihedral)(RESIDUE)(nresnr).xvg\fR) are output, as well as a
69 \&file containing the information for all residues (argument of \fB \-corr\fR).
72 \&With option \fB \-all\fR, the angles themselves as a function of time for
73 \&each residue are printed to separate files \fB (dihedral)(RESIDUE)(nresnr).xvg\fR.
74 \&These can be in radians or degrees.
77 \&A log file (argument \fB \-g\fR) is also written. This contains 
79 \&(a) information about the number of residues of each type.
81 \&(b) The NMR 3J coupling constants from the Karplus equation.
83 \&(c) a table for each residue of the number of transitions between 
84 \&rotamers per nanosecond,  and the order parameter S2 of each dihedral.
86 \&(d) a table for each residue of the rotamer occupancy.
89 \&All rotamers are taken as 3\-fold, except for omega and chi dihedrals
90 \&to planar groups (i.e. chi2 of aromatics, Asp and Asn; chi3 of Glu
91 \&and Gln; and chi4 of Arg), which are 2\-fold. "rotamer 0" means 
92 \&that the dihedral was not in the core region of each rotamer. 
93 \&The width of the core region can be set with \fB \-core_rotamer\fR
96 \&The S2 order parameters are also output to an \fB .xvg\fR file
97 \&(argument \fB \-o\fR ) and optionally as a \fB .pdb\fR file with
98 \&the S2 values as B\-factor (argument \fB \-p\fR). 
99 \&The total number of rotamer transitions per timestep
100 \&(argument \fB \-ot\fR), the number of transitions per rotamer
101 \&(argument \fB \-rt\fR), and the 3J couplings (argument \fB \-jc\fR), 
102 \&can also be written to \fB .xvg\fR files.
105 \&If \fB \-chi_prod\fR is set (and \fB \-maxchi\fR  0), cumulative rotamers, e.g.
106 \&1+9(chi1\-1)+3(chi2\-1)+(chi3\-1) (if the residue has three 3\-fold 
107 \&dihedrals and \fB \-maxchi\fR = 3)
108 \&are calculated. As before, if any dihedral is not in the core region,
109 \&the rotamer is taken to be 0. The occupancies of these cumulative 
110 \&rotamers (starting with rotamer 0) are written to the file
111 \&that is the argument of \fB \-cp\fR, and if the \fB \-all\fR flag
112 \&is given, the rotamers as functions of time
113 \&are written to \fB chiproduct(RESIDUE)(nresnr).xvg\fR 
114 \&and their occupancies to \fB histo\-chiproduct(RESIDUE)(nresnr).xvg\fR.
117 \&The option \fB \-r\fR generates a contour plot of the average omega angle
118 \&as a function of the phi and psi angles, that is, in a Ramachandran plot
119 \&the average omega angle is plotted using color coding.
120 .SH FILES
121 .BI "\-s" " conf.gro" 
122 .B Input
123  Structure file: gro g96 pdb tpr etc. 
125 .BI "\-f" " traj.xtc" 
126 .B Input
127  Trajectory: xtc trr trj gro g96 pdb cpt 
129 .BI "\-o" " order.xvg" 
130 .B Output
131  xvgr/xmgr file 
133 .BI "\-p" " order.pdb" 
134 .B Output, Opt.
135  Protein data bank file 
137 .BI "\-ss" " ssdump.dat" 
138 .B Input, Opt.
139  Generic data file 
141 .BI "\-jc" " Jcoupling.xvg" 
142 .B Output
143  xvgr/xmgr file 
145 .BI "\-corr" " dihcorr.xvg" 
146 .B Output, Opt.
147  xvgr/xmgr file 
149 .BI "\-g" " chi.log" 
150 .B Output
151  Log file 
153 .BI "\-ot" " dihtrans.xvg" 
154 .B Output, Opt.
155  xvgr/xmgr file 
157 .BI "\-oh" " trhisto.xvg" 
158 .B Output, Opt.
159  xvgr/xmgr file 
161 .BI "\-rt" " restrans.xvg" 
162 .B Output, Opt.
163  xvgr/xmgr file 
165 .BI "\-cp" " chiprodhisto.xvg" 
166 .B Output, Opt.
167  xvgr/xmgr file 
169 .SH OTHER OPTIONS
170 .BI "\-[no]h"  "no    "
171  Print help info and quit
173 .BI "\-[no]version"  "no    "
174  Print version info and quit
176 .BI "\-nice"  " int" " 19" 
177  Set the nicelevel
179 .BI "\-b"  " time" " 0     " 
180  First frame (ps) to read from trajectory
182 .BI "\-e"  " time" " 0     " 
183  Last frame (ps) to read from trajectory
185 .BI "\-dt"  " time" " 0     " 
186  Only use frame when t MOD dt = first time (ps)
188 .BI "\-[no]w"  "no    "
189  View output \fB .xvg\fR, \fB .xpm\fR, \fB .eps\fR and \fB .pdb\fR files
191 .BI "\-xvg"  " enum" " xmgrace" 
192  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
194 .BI "\-r0"  " int" " 1" 
195  starting residue
197 .BI "\-[no]phi"  "no    "
198  Output for phi dihedral angles
200 .BI "\-[no]psi"  "no    "
201  Output for psi dihedral angles
203 .BI "\-[no]omega"  "no    "
204  Output for omega dihedrals (peptide bonds)
206 .BI "\-[no]rama"  "no    "
207  Generate phi/psi and chi1/chi2 Ramachandran plots
209 .BI "\-[no]viol"  "no    "
210  Write a file that gives 0 or 1 for violated Ramachandran angles
212 .BI "\-[no]periodic"  "yes   "
213  Print dihedral angles modulo 360 degrees
215 .BI "\-[no]all"  "no    "
216  Output separate files for every dihedral.
218 .BI "\-[no]rad"  "no    "
219  in angle vs time files, use radians rather than degrees.
221 .BI "\-[no]shift"  "no    "
222  Compute chemical shifts from phi/psi angles
224 .BI "\-binwidth"  " int" " 1" 
225  bin width for histograms (degrees)
227 .BI "\-core_rotamer"  " real" " 0.5   " 
228  only the central \fB \-core_rotamer\fR*(360/multiplicity) belongs to each rotamer (the rest is assigned to rotamer 0)
230 .BI "\-maxchi"  " enum" " 0" 
231  calculate first ndih chi dihedrals: \fB 0\fR, \fB 1\fR, \fB 2\fR, \fB 3\fR, \fB 4\fR, \fB 5\fR or \fB 6\fR
233 .BI "\-[no]normhisto"  "yes   "
234  Normalize histograms
236 .BI "\-[no]ramomega"  "no    "
237  compute average omega as a function of phi/psi and plot it in an \fB .xpm\fR plot
239 .BI "\-bfact"  " real" " \-1    " 
240  B\-factor value for \fB .pdb\fR file for atoms with no calculated dihedral order parameter
242 .BI "\-[no]chi_prod"  "no    "
243  compute a single cumulative rotamer for each residue
245 .BI "\-[no]HChi"  "no    "
246  Include dihedrals to sidechain hydrogens
248 .BI "\-bmax"  " real" " 0     " 
249  Maximum B\-factor on any of the atoms that make up a dihedral, for the dihedral angle to be considere in the statistics. Applies to database work where a number of X\-Ray structures is analyzed. \fB \-bmax\fR = 0 means no limit.
251 .BI "\-acflen"  " int" " \-1" 
252  Length of the ACF, default is half the number of frames
254 .BI "\-[no]normalize"  "yes   "
255  Normalize ACF
257 .BI "\-P"  " enum" " 0" 
258  Order of Legendre polynomial for ACF (0 indicates none): \fB 0\fR, \fB 1\fR, \fB 2\fR or \fB 3\fR
260 .BI "\-fitfn"  " enum" " none" 
261  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
263 .BI "\-ncskip"  " int" " 0" 
264  Skip N points in the output file of correlation functions
266 .BI "\-beginfit"  " real" " 0     " 
267  Time where to begin the exponential fit of the correlation function
269 .BI "\-endfit"  " real" " \-1    " 
270  Time where to end the exponential fit of the correlation function, \-1 is until the end
272 .SH KNOWN PROBLEMS
273 \- Produces MANY output files (up to about 4 times the number of residues in the protein, twice that if autocorrelation functions are calculated). Typically several hundred files are output.
275 \- phi and psi dihedrals are calculated in a non\-standard way, using H\-N\-CA\-C for phi instead of C(\-)\-N\-CA\-C, and N\-CA\-C\-O for psi instead of N\-CA\-C\-N(+). This causes (usually small) discrepancies with the output of other tools like \fB g_rama\fR.
277 \- \fB \-r0\fR option does not work properly
279 \- Rotamers with multiplicity 2 are printed in \fB chi.log\fR as if they had multiplicity 3, with the 3rd (g(+)) always having probability 0
281 .SH SEE ALSO
282 .BR gromacs(7)
284 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.