0a56c9db86d400119f5bd5a27a68f9ba4e4483c0
[alexxy/gromacs.git] / docs / release-notes / 2020 / 2020.5.rst
1 GROMACS 2020.5 release notes
2 ----------------------------
3
4 This version was released on TODO, 2020. These release notes
5 document the changes that have taken place in GROMACS since the
6 previous 2020.4 version, to fix known issues. It also incorporates all
7 fixes made in version 2019.6 and earlier, which you can find described
8 in the :ref:`release-notes`.
9
10 .. Note to developers!
11    Please use """"""" to underline the individual entries for fixed issues in the subfolders,
12    otherwise the formatting on the webpage is messed up.
13    Also, please use the syntax :issue:`number` to reference issues on redmine, without the
14    a space between the colon and number!
15
16 Fixes where mdrun could behave incorrectly
17 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
18
19 Fix mdrun writing zero dH/dlambda and foreign lambda energies before checkpointing
20 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
21  
22 With free-energy runs with separate-dhdl-file=no and nstdhdl not a multiple of
23 nstenergy, mdrun would write zeros for dH/dlambda and foreign energies to
24 the energy file for steps between the last energy frame and the checkpoint.
25 This would lead to errors in free-energy estimates which could go unnoticed
26 as values only deviate for a few steps.
27
28 :issue:`3763`
29
30 Fixed bugs with COM pulling and domain decompostion with weight or >32 ranks
31 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
32
33 When using COM pulling and domain decomposition, the results would be
34 incorrect when using relative weights per atom or when using more than
35 32 DD MPI ranks. This would usually lead to crashes or obviously wrong
36 results.
37
38 :issue:`3750`
39
40 Fix incorrect AWH free-energies when multiple walkers share a bias
41 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
42
43 The AWH free-energy output was incorrect when multiple walkers shared
44 an AWH bias. The error went up quadratically with the free-energy update
45 interval, as well as with the number of walkers. The error decreases as
46 update size decreases with time. This meant that with default AWH settings
47 the error was negligible. With a free-energy update interval of 2 ps,
48 we observed an error about equal to the statistical error with 32 walkers
49 for a rather fast reaction coordinate. For slower coordinates the error
50 will be smaller than the statistical error.
51
52 :issue:`3828`
53
54 Fixed conserved energy for MTTK
55 """""""""""""""""""""""""""""""
56
57 When using `pcoupl=MTTK` and `tcoupl=nose-hoover`, the calculated conserved
58 energy was incorrect due to two errors dating back to GROMACS 4.6 and 2018,
59 respectively. As a result, all reported conserved energies using this
60 combination of temperature and pressure coupling algorithms in any GROMACS
61 version since GROMACS 4.6 are likely to be wrong. Note that these errors did
62 not impact the dynamics, as the conserved energy is only reported, but never
63 used in calculations. Also note that this bug only affects this exact
64 combination of temperature / pressure coupling algorithms.
65
66 :issue:`3796`
67
68 Fixed conserved energy for Nose-Hoover
69 """"""""""""""""""""""""""""""""""""""
70
71 When using `tcoupl=nose-hoover` and one or more temperature groups with
72 non-integer number of degrees of freedom, the calculated conserved
73 energy was incorrect due to an error dating back to GROMACS 2018.
74 Reported conserved energies using Nose-Hoover temperature coupling and
75 non-integer number of degrees of freedom since GROMACS 2018 are likely to
76 be slightly off. Note that this error does not impact the dynamics, as the
77 conserved energy is only reported, but never used in calculations. Also note
78 that this will only be noticeable when using small temperature groups or
79 small systems.
80
81 :issue:`3831`
82
83 Fixed kinetic energy and temperature reporting for MTTK
84 """""""""""""""""""""""""""""""""""""""""""""""""""""""
85
86 When using `pcoupl=MTTK` and `tcoupl=nose-hoover`, the reported kinetic
87 energy and temperature were very slightly off. The integration of the
88 temperature coupling trailed the reporting by half a time step. Note that
89 these errors did not impact the dynamics, as the quantities were correctly
90 integrated and only wrongly reported. Also note that the difference is so
91 small that it is unlikely to have been significant for any application
92 except for rigorous algorithm validation. Finally, note that this bug
93 only affects this exact combination of temperature / pressure coupling
94 algorithms.
95
96 :issue:`3832`
97
98 Fix pull error message with angles and dihedrals
99 """"""""""""""""""""""""""""""""""""""""""""""""
100
101 The COM pull code could print incorrect pull group indices when mdrun exited
102 with an error about a too long pull distance in angle and dihedral geometries.
103
104 :issue:`3613`
105
106 Fix numerical issues in expanded ensemble
107 """""""""""""""""""""""""""""""""""""""""
108
109 When performing simulated tempering or expanded ensemble simulations
110 with changes in the Hamiltonian that were too large, then Monte Carlo
111 proposals to states that were sufficiently unlikely would underflow,
112 causing division by zero errors. This was fixed by numerically
113 hardening the logical flow so that such proposals would be rejected
114 instead.
115
116 :issue:`3304`
117
118 Fix incorrect electric field strength with applied electric field
119 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
120
121 The electric field generated by the electric field module would be incorrect when
122 used together with domain decomposition due to an error with indexing the field
123 to all atoms instead of just those on the current domain.
124
125 In overlap regions between domains, which have the thickness of the pairlist
126 cut-off distance, the electric field would be doubled (or more with 2D or
127 3D domain decomposition).
128
129 To validate if a simulation has been affected by the issue, users should calculate
130 the actual potential across the simulation box using the Poisson equation.
131 If this potential agrees with the one provided as the input, a simulation was not affected.
132
133 :issue:`3800`
134
135 Fixes for ``gmx`` tools
136 ^^^^^^^^^^^^^^^^^^^^^^^
137
138 Improve CHARMM support in gmx do_dssp
139 """""""""""""""""""""""""""""""""""""
140
141 :issue:`3568`
142
143 Fix non-funtioning gmx h2order -d option
144 """"""""""""""""""""""""""""""""""""""""
145
146 The gmx h2order tool would always take the normal along the z-axis.
147
148 :issue:`3820`
149
150 Fix pull group index handling
151 """""""""""""""""""""""""""""
152
153 The pull code would not validate its index groups correctly, leading
154 to infinite loops or assertions being triggered at grompp time.
155
156 :issue:`3810`
157
158 Fixes that affect portability
159 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
160
161 Fix building on OSX
162 """""""""""""""""""
163
164 The code wouldn't compile due to a missing include.
165
166 :issue:`3730`
167
168 Miscellaneous
169 ^^^^^^^^^^^^^