GROMACS version 2019.5
[alexxy/gromacs.git] / docs / release-notes / 2019 / 2019.5.rst
1 GROMACS 2019.5 release notes
2 ----------------------------
3
4 This version was released on December 23rd, 2019. These release notes
5 document the changes that have taken place in GROMACS since the
6 previous 2019.4 version, to fix known issues. It also incorporates all
7 fixes made in version 2018.8 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 use of uninitialized data on PME only ranks
20 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""
21
22 When building GPU enabled versions of |Gromacs| with clang as either host only or host
23 and device side compiler, PME datastructures could be left uninitialized, leading
24 to the use of random values for LJ PME energies, virial and pressure.
25
26 The effect of this bug was that the potential and total energy could
27 be wrong, but not the Coulomb mesh energy. This didn't affect sampling.
28 The pressure could also be wrong, which would affect sampling when pressure
29 coupling is used, but likely the simulation would explode after a few steps.
30
31 This doesn't seem to have affected versions of |Gromacs| built
32 with gcc as the host side compiler.
33
34 :issue:`3120`
35
36 Fix out of range memory access with free-energy calculations
37 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""
38
39 With free-energy calculations not using lambda states, an output
40 buffer would be accessed one element beyond it's allocated size.
41 We don't expect this to have caused incorrect results, but
42 a memory checker would complain.
43
44 :issue:`3173`
45
46 Work around broken Apple Clang compiler in Mac OS Catalina
47 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
48 In Mac OS Catalina, the default XCode compilers checks and
49 enforces stack alignment. This would have been a good idea
50 if Apple itself did not ship a C library that violates the
51 stack alignment with AVX instructions are enabled.
52
53 :issue:`3199`
54
55 Fix error with intermolecular interactions and domain decomposition
56 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
57
58 With intermolecular interactions at distances longer than the cutoff
59 and domain decomposition, mdrun could exit with an error message
60 about missing interactions.
61
62 :issue:`3204`
63
64 Fix issues with AWH with pull-geometry 'direction' to be periodic
65 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
66
67 Removed fatal error with AWH with periodic pull-geometry 'direction'
68 when the distance was within 2% of half the box size.
69 Changed an assertion failure when the AWH interval was larger than
70 the box size to a fatal error.
71 Clarified the documentation for pull geometry 'direction-periodic'.
72
73 :issue:`2946`
74
75 Remove assertion failure with AWH when not using the initial stage
76 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
77
78 :issue:`3217`
79
80 Fixes for ``gmx`` tools
81 ^^^^^^^^^^^^^^^^^^^^^^^
82
83 Make histogram output clearer
84 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
85
86 Output gave number of events included in histogram bar as *a.u.*,
87 which was not clear for users.
88
89
90 Fix dihedral angle calculation near 180 degree boundary
91 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
92
93 The analysis tools could incorrectly calculate properties of torsion angles and their averages
94 when close to the -180 or 180 degree boundary.
95
96 :issue:`3225`
97
98
99 Remove problematic output of gmx angle tool
100 """""""""""""""""""""""""""""""""""""""""""
101
102 It could happen that the calculation of the standard deviation
103 for angles caused a divide by zero error for empty populations.
104 Because this standard deviation was meaningless, it has been
105 removed.
106
107 :issue:`3206`
108
109 Fixes that affect portability
110 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
111
112 Check that libhwloc headers and runtime match
113 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
114
115 It could happen that the libhwloc headers and library detection would
116 lead to a mismatch at compile or runtime that could cause cryptic
117 crashes while using mdrun.
118
119 :issue:`3200`
120
121 Miscellaneous
122 ^^^^^^^^^^^^^
123
124 Fix .gro file formatting with large boxes
125 """""""""""""""""""""""""""""""""""""""""
126
127 The |Gromacs| manual says the box components in the .gro file
128 format are separated by spaces. But no space was printed when
129 a box component, except for the first, was 1000 nm or larger
130 or an off-diagonal component was -100 nm or smaller.
131 Now at least one space is always printed. Content that was written
132 in a way that already had at least one space between components
133 is unchanged. Existing parsers that conform to the documentation
134 and expect whitespace separation will continue to work in all cases.
135
136 :issue:`3176`
137
138 Fix duplicate PDB CONECT record output
139 """"""""""""""""""""""""""""""""""""""
140
141 PDB "CONECT" record output was duplicated in some instances. Since |Gromacs| does
142 not use these anywhere, analysis was not affected. The behavior is now fixed.
143
144 :issue:`3206`
145
146 Fix performance issue with bonded interactions in wrong GPU stream
147 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
148
149 This could lead to a significant loss in performance.
150
151 :issue:`3241`