b7966f176e782a171fdc7968c2f1ee7d3df62c66
[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 Fixed conserved energy for MTTK
41 """""""""""""""""""""""""""""""
42
43 When using `pcoupl=MTTK` and `tcoupl=nose-hoover`, the calculated conserved
44 energy was incorrect due to two errors dating back to GROMACS 4.6 and 2018,
45 respectively. As a result, all reported conserved energies using this
46 combination of temperature and pressure coupling algorithms in any GROMACS
47 version since GROMACS 4.6 are likely to be wrong. Note that these errors did
48 not impact the dynamics, as the conserved energy is only reported, but never
49 used in calculations. Also note that this bug only affects this exact
50 combination of temperature / pressure coupling algorithms.
51
52 :issue:`3796`
53
54 Fixed conserved energy for Nose-Hoover
55 """"""""""""""""""""""""""""""""""""""
56
57 When using `tcoupl=nose-hoover` and one or more temperature groups with
58 non-integer number of degrees of freedom, the calculated conserved
59 energy was incorrect due to an error dating back to GROMACS 2018.
60 Reported conserved energies using Nose-Hoover temperature coupling and
61 non-integer number of degrees of freedom since GROMACS 2018 are likely to
62 be slightly off. Note that this error does not impact the dynamics, as the
63 conserved energy is only reported, but never used in calculations. Also note
64 that this will only be noticeable when using small temperature groups or
65 small systems.
66
67 :issue:`3831`
68
69 Fixed kinetic energy and temperature reporting for MTTK
70 """""""""""""""""""""""""""""""""""""""""""""""""""""""
71
72 When using `pcoupl=MTTK` and `tcoupl=nose-hoover`, the reported kinetic
73 energy and temperature were very slightly off. The integration of the
74 temperature coupling trailed the reporting by half a time step. Note that
75 these errors did not impact the dynamics, as the quantities were correctly
76 integrated and only wrongly reported. Also note that the difference is so
77 small that it is unlikely to have been significant for any application
78 except for rigorous algorithm validation. Finally, note that this bug
79 only affects this exact combination of temperature / pressure coupling
80 algorithms.
81
82 :issue:`3832`
83
84 Fix pull error message with angles and dihedrals
85 """"""""""""""""""""""""""""""""""""""""""""""""
86
87 The COM pull code could print incorrect pull group indices when mdrun exited
88 with an error about a too long pull distance in angle and dihedral geometries.
89
90 :issue:`3613`
91
92 Fix incorrect electric field strength with applied electric field
93 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
94
95 The electric field generated by the electric field module would be incorrect when
96 used together with domain decomposition due to an error with indexing the field
97 to all atoms instead of just those on the current domain.
98
99 In overlap regions between domains, which have the thickness of the pairlist
100 cut-off distance, the electric field would be doubled (or more with 2D or
101 3D domain decomposition).
102
103 To validate if a simulation has been affected by the issue, users should calculate
104 the actual potential across the simulation box using the Poisson equation.
105 If this potential agrees with the one provided as the input, a simulation was not affected.
106
107
108 :issue:`3800`
109
110 Fixes for ``gmx`` tools
111 ^^^^^^^^^^^^^^^^^^^^^^^
112
113 Improve CHARMM support in gmx do_dssp
114 """""""""""""""""""""""""""""""""""""
115
116 :issue:`3568`
117
118 Fix non-funtioning gmx h2order -d option
119 """"""""""""""""""""""""""""""""""""""""
120
121 The gmx h2order tool would always take the normal along the z-axis.
122
123 :issue:`3820`
124
125 Fixes that affect portability
126 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
127
128 Fix building on OSX
129 """""""""""""""""""
130
131 The code wouldn't compile due to a missing include.
132
133 :issue:`3730`
134
135 Miscellaneous
136 ^^^^^^^^^^^^^