b1612a9822530766d66fb7e3187793e0f504f3e2
[alexxy/gromacs.git] / docs / release-notes / 2022 / major / tools.rst
1 Improvements to |Gromacs| tools
2 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3
4 .. Note to developers!
5    Please use """"""" to underline the individual entries for fixed issues in the subfolders,
6    otherwise the formatting on the webpage is messed up.
7    Also, please use the syntax :issue:`number` to reference issues on GitLab, without the
8    a space between the colon and number!
9
10 ``gmx msd`` has been migrated to the trajectoryanalysis framework
11 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
12
13 The tool now uses the |Gromacs| selection syntax. Rather than piping selections via stdin,
14 selections are now made using the "-sel" option. There is a new option called ``-maxtau``,
15 which limits maximum time delta between frames to compare for calculating MSDs. This will allow
16 users who otherwise would run into out-of-memory errors and slow execution with large systems
17 to restrict sampling to useful tau values.
18
19 This migration comes with about a 20% speedup in execution time.
20
21 Some rarely used features have yet to be migrated, including:
22
23 - The -tensor option is not yet implemented.
24 - System COM removal with -rmcomm has not yet been implemented.
25 - B-factor writing using the -pdb option is not yet supported.
26
27 A slight behavior change is the removal of the -mw option. ``gmx msd`` with ``-mol`` will
28 take the MSD of the center-of-mass of of molecules, while no mass-weighting is done
29 when ``-mol`` is not selected. In previous |Gromacs| versions, ``-mw`` was on by default,
30 and ``-nomw`` was silently ignored when ``-mol`` was chosen. This change will only cause
31 different results when performing MSD calculations on a non-homogenous group of particles without
32 ``-mol`` set.
33
34 :issue:`2368`
35
36 ``gmx chi`` no longer needs ``residuetypes.dat`` entries for custom residues
37 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
38
39 The need to add the names of custom residues to ``residuetypes.dat`` has been
40 removed, because it served no purpose. This makes ``gmx chi`` easier to use.
41
42 ``gmx wham`` has had minor improvements to its text output
43 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""
44
45 Reporting about file handling and input-file column contents are easier to
46 follow.