3d28b5c48c65c5c0dba09e4f0408f818901154a8
[alexxy/gromacs.git] / docs / release-notes / 2020 / 2020.1.rst
1 GROMACS 2020.1 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 version, to fix known issues. It also incorporates all
7 fixes made in version 2019.5 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 fatal error with mdrun -multidir with more than 1 rank per simulation
20 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
21
22 :issue:`3296`
23
24 Fix deadlock in mdrun runs with multiple ranks and separate PME ranks
25 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
26
27 When multiple PP ranks as well as separate PME ranks are used, mdrun could
28 deadlock before starting the PP-PME balancing.
29
30 :issue:`3335`
31
32 Avoid mdrun assertion failure when running with shells and update on a GPU
33 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
34
35 A check for shells has been added in the mdrun task assignment code,
36 so that mdrun falls back to CPU or produces a clear error message
37 when attempting to run with shells and update on a GPU.
38
39 :issue:`3303`
40
41 Allow large prime factors in the mdrun MPI rank count
42 """""""""""""""""""""""""""""""""""""""""""""""""""""
43
44 The domain decomposition would refuse to run with large prime factors
45 in the MPI rank count even when the grid was specified by the user.
46
47 :issue:`3336`
48
49 Actually fix PME forces with FE without perturbed q/LJ
50 """"""""""""""""""""""""""""""""""""""""""""""""""""""
51
52 PME would incorrectly ignore the mesh forces on perturbed atoms when
53 no charges or LJ atom types were actually perturbed. Note that this
54 is a rather uncommon scenario.
55
56 :issue:`2640`
57 :issue:`3359`
58
59 Avoid deadlock when checking for missing DD interactions
60 """"""""""""""""""""""""""""""""""""""""""""""""""""""""
61
62 When missing bonded interactions after domain decomposition were detected,
63 mdrun was deadlocking instead of exiting with a failure.
64
65 :issue:`3373`
66
67 Fix checkpoint restarts using Parrinello-Rahman and md-vv
68 """""""""""""""""""""""""""""""""""""""""""""""""""""""""
69
70 Checkpoints using Parrinello-Rahman and md-vv (only implemented in
71 the new modular simulator approach) could not be read.
72
73 :issue:`3377`
74
75 Avoid overzealous program abort with orientation restraints
76 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""
77
78 It could happen that mdrun would abort on checking orientation restraints in multiple
79 molecules even though no restraints where applied to them.
80
81 :issue:`3375`
82
83 Add fatal error for mdrun -multidir when simulations sharing state start at different step
84 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
85
86 When (re)starting mdrun -multidir for simulations sharing state data
87 (e.g., replica exchange, AWH with bias sharing or NMR ensemble averaging)
88 having a different initial step only caused a note to be printed, which
89 could lead to simulations getting out of sync. Now a fatal error is issued
90 in this situation.
91
92 :issue:`2440`
93 :issue:`3990`
94
95 Correct skewed box using modular simulator without DD
96 """""""""""""""""""""""""""""""""""""""""""""""""""""
97
98 Using modular simulator without DD, it was not checked whether the box
99 was getting overly skewed when using pressure control.
100
101 :issue:`3383`
102
103 Fix NMR restraints using modular simulator
104 """"""""""""""""""""""""""""""""""""""""""
105
106 Using NMR restraints (distance or orientation restraints) under modular simulator
107 did not work as expected. All orientation restraint simulations would fail with a
108 segmentation fault, as would distance restraint simulations using time averaging.
109 All other distance restraint simulations would run correctly, but output to the
110 energy trajectory would only occur if it coincided with general energy writing
111 steps.
112
113 :issue:`3388`
114
115 Avoid integer overflow when using dispersioncorrection
116 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""
117
118 A change in the integer type storing the index meant that the value could overflow
119 and turn negative, leading to wrong lookup and unphysical values.
120
121 :issue:`3391`
122
123 Fix checkpoint files getting out of sync with simulations sharing data
124 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
125
126 When simulations share data, e.g., replica exchange, AWH with bias sharing
127 or NMR ensemble averaging, MPI barrier have now been added before renaming
128 the checkpointing files to avoid that checkpoints files from the simulations
129 can get out of sync. Now in very unlikely cases some checkpoint files might
130 have temporary names, but all content will be in sync.
131
132 :issue:`2440`
133
134 Fixes for ``gmx`` tools
135 ^^^^^^^^^^^^^^^^^^^^^^^
136
137 Fixes that affect portability
138 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
139
140 Add support for ICC NextGen
141 """""""""""""""""""""""""""
142
143 Add support for Intel Compiler based on LLVM technology.
144 To compile GROMACS with this compiler use ``CXX=icpc CXXFLAGS=-qnextgen cmake``.
145
146 Miscellaneous
147 ^^^^^^^^^^^^^
148