Update instructions in containers.rst
[gromacs.git] / docs / release-notes / 2016 / 2016.2.rst
blob92b6585792175fe2bcb67bced43db3c50db517c0
1 GROMACS 2016.2 Release Notes
2 ----------------------------------------
4 This version was released on February 7, 2016. These release notes
5 document the changes that have taken place in GROMACS since version
6 2016.1 to fix known issues. It also incorporates all fixes made in
7 version 5.1.4 and several since.
9 Fixes where mdrun could behave incorrectly
10 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12 Add grompp check for equipartition violation risk for decoupled modes
13 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
14 When atoms involved in an angle with constrained bonds have very
15 different masses, there can be very weakly coupled dynamics modes.
16 Default mdp settings are often not sufficiently accurate to obtain
17 equipartitioning. This change adds a grompp check for this issue.
19 Part of :issue:`2071`
21 Disallow overwriting of dihedral type 9
22 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
23 It is no longer allowed to repeat blocks of parameter of multiple
24 lines for dihedrals of type 9. It is also no longer allowed to
25 override parameters or dihedrals of type 9. Both are too complex
26 to properly check. It is still allowed to repeat parameters blocks
27 consisting of a single line.
28 Repeating a block with the same parameters would lead to incorrect
29 dihedral potentials and forces.
31 :issue:`2077`
33 Fixed flat-bottom position restraints + DD + OpenMP
34 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
35 A (re)allocation was missing, causing a crash.
37 :issue:`2095`
39 Fixed multi-domain reruns
40 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
41 Old code cleanup led multi-domain rerun to crash because it failed to
42 consider logic separated over two places.
44 :issue:`2105`
46 Fixes for mdrun performance issues
47 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
49 Corrected CUDA sm_60 performance
50 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
51 The kernel launch now suits the SM size of the GP100 architecture.
53 Fixes for ``gmx`` tools
54 ^^^^^^^^^^^^^^^^^^^^^^^
56 Fixed some FFT handling in cross-corrrelation calculations
57 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
58 An array of complex number was created as an array of pointers and
59 then passed to gmx_fft_1d. This does not work.
61 :issue:`2109`
63 Fixed gmx rmsf -q -oq
64 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
65 This led to the PDB file containing B-factors using coordinates based
66 on those from the -s file, rather than -q file. gmx rmsf -oq was
67 otherwise fine.
69 Fixed crash in gmx order
70 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
71 gmx order used a cumbersome floating point method to compute
72 a histogram, leading to an index value that could be negative.
74 :issue:`2104`
76 Fixed minor trjconv bug
77 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
78 gmx trjconv -novel -f in.pdb -o out.pdb probably works better now.
80 Fixed time label print in gmx vanhove
81 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
83 Handled issuing warnings correctly in xpm2ps and membed
84 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
85 The code should not (over)write the output file before checking for
86 errors. For membed, it is useful to require the user to fix issues in
87 their input file before we unilaterally over-write it.
89 Corrected documentation about eigenvalue handling
90 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
91 Some file format docs were out of step with the implementation in
92 eigio.cpp.
94 The behaviour of gmx anaeig -eig -eig2 was not properly documented.
96 Made editconf B-factor attachment more useful in practice
97 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
98 B-factor values will be added to residues unless an index is larger
99 than the number of residues or an option is specified. Protein residue
100 indices can start from any number and, in case they start from a large
101 number, there is no way to add B-factor values to residues.
103 This patch changes it to add B-factor values to residues unless the
104 number of B-factor values is larger than the number of residues.
106 Fixed possible memory error with long selections
107 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
108 If a selection was more than 1000 characters long and there was a
109 whitespace exactly at the 1000 point, a buffer overflow could occur.
110 Replaced the buffer with std::string, simplifying the code
111 significantly.
113 :issue:`2086`
115 Fixed use of position variables with plus/merge
116 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
117 If a selection contained a position variable (e.g., 'com of ...') that
118 was used more than once, and at least one of those uses was with
119 plus/merge, there were out-of-bounds memory writes.  This was caused by
120 the internal position structure not getting fully initialized.
121 Incomplete initialization happens in all contexts with such variables,
122 but only plus/merge (and possibly permute) actually use the values that
123 remained uninitialized, which caused them to incorrectly compute the
124 amount of memory required to store the result.
126 :issue:`2086`
128 Improved documentation
129 ^^^^^^^^^^^^^^^^^^^^^^
131 Made several minor improvements to documentation and messages to users
132 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
133 In particular, for selections:
135 - Explained resindex and resnr keywords in selection help.
136 - Explained how selection-enabled tools treat -s and -f input files.
138 :issue:`2083`
140 Clarified use of tau-p and pcoupltype
141 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
142 grompp used to permit the erroneous "tau-p = 5 5". This does not
143 reflect that only one time constant is permitted for pressure coupling
144 (unlike group-based temperature coupling). The recent fix for
145 :issue:`1893` leads to the user receiving a grompp warning, so this
146 improves the docs to make clear that pressure coupling is different.
148 :issue:`1893`
150 Portability enhancements
151 ^^^^^^^^^^^^^^^^^^^^^^^^
153 Fixed x86 conditional on IBM s390x
154 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
155 The CpuInfoTest.SupportLevel test fails on IBM s390x because wrong
156 condition was used.
158 Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=1390149
160 :issue:`2072`
162 Build system enhancements
163 ^^^^^^^^^^^^^^^^^^^^^^^^^
165 Fixed compilation with CMAKE_CXX_FLAGS="-Wall -Werror"
166 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
167 :issue:`2073`
169 Stopped trying to use objdump --reloc in the build system on Mac
170 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
171 Recent Xcode objdump does not support --reloc.
173 The warning that is based on the output of running objdump was only
174 implemented to work on Linux-like things, so should not spam the cmake
175 output on other platforms.
177 Improved the support for plugin loading in the build system
178 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
179 The mdrun-only and prefer-static-libs builds set the default for
180 BUILD_SHARED_LIBS to off, which silently disabled plugin support
181 for things like VMD-based I/O handling.
183 Converted GMX_LOAD_PLUGINS to tri-state ON/OFF/AUTO so that if the
184 preconditions for support are not met we can have suitable behaviour
185 in each case.
187 :issue:`2082`
189 Turn off hwloc support when static lib found
190 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
191 Hwloc dependencies are not resolved at CMake time when static
192 libwloc.a is detected and in most of these cases link-time
193 errors will prevent building GROMACS. As it is hard for a user to know
194 how to solve such cryptic errors and hwloc is not a required dependency,
195 we turn off hwloc support when a static lib is detected. The user can
196 override this on the cmake command line.
198 :issue:`1919`
200 Fixed build with GMX_EXTERNAL_TNG=ON
201 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
203 House-keeping that reduces users' problems
204 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
206 Mdrun prints invalid performance data less often
207 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
208 If mdrun finished before a scheduled reset of the timing information
209 (e.g. from mdrun -resetstep or mdrun -resethway), then misleading
210 timing information should not be reported.
212 Related, the default reset step for gmx tune_pme was increased to 1500.
214 :issue:`2041`
216 Added a runtime check for number of threads in bonded code
217 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
218 Replaced a debug assertion on the number of OpenMP threads not being
219 larger than GMX_OPENMP_MAX_THREADS by fatal error.
220 But since the listed-forces reduction is actually not required with
221 listed forces, these are now conditional and mdrun can run with more
222 than GMX_OPENMP_MAX_THREADS threads.
224 :issue:`2085`
226 Fixed integer narrowing in TNG reading for long trajectories
227 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
228 Reading of TNG trajectories with sufficiently large numbers of frames
229 could truncate integers used for frame numbers. Fixed to use 64-bit
230 integers as originally intended.
232 Fixed logic of TRR reading
233 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
234 When reading a trr file, reaching the end of the file was
235 indistinguishable from a reading error or a magic-number error. This
236 is now fixed, restoring the intended behaviour in each case.
238 :issue:`1926`