Revert "GROMACS 2021.3 release"
[alexxy/gromacs.git] / docs / release-notes / 2021 / 2021.3.rst
1 GROMACS 2021.3 release notes
2 ----------------------------
3
4 This version was released on TODO, 2021. These release notes
5 document the changes that have taken place in GROMACS since the
6 previous 2021.2 version, to fix known issues. It also incorporates all
7 fixes made in version 2020.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 GitLab, without the
14    a space between the colon and number!
15
16 Fixes where mdrun could behave incorrectly
17 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
18
19 Fixed gmxapi MD plugin binding
20 """"""""""""""""""""""""""""""
21
22 Molecular Dynamics extension code was not properly handled when added to a
23 simulation through the gmxapi Python interface.
24 This meant that restraint potentials would silently fail to be applied with
25 gmxapi versions >= 0.1.
26 Updates have been applied internally to gmxapi.
27 Third party code should not need to be updated, but developers will
28 note an additional "null restraint" in
29 https://gitlab.com/gromacs/gromacs/-/tree/master/python_packaging/sample_restraint
30 (for illustration and testing purposes).
31
32 :issue:`4078`
33
34 Fixes for ``gmx`` tools
35 ^^^^^^^^^^^^^^^^^^^^^^^
36
37 Fix gmx nmr -viol option
38 """"""""""""""""""""""""
39
40 The tool would previously fail with a cryptic error.
41 Also enforces that this option is exclusive with other analysis modes.
42
43 :issue:`4060`
44
45 Fixed gmx dipoles -quad option
46 """"""""""""""""""""""""""""""
47
48 The tool now reports correct values.
49
50 :issue:`4080`
51
52 Make sure gmx convert-tpr -until works
53 """"""""""""""""""""""""""""""""""""""
54
55 This got broken during reworking the internals of the tool and didn't
56 calculate the number of remaining steps correctly.
57
58 :issue:`4056`
59
60 Fixes that affect portability
61 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
62
63 Check that necessary python modules are available
64 """""""""""""""""""""""""""""""""""""""""""""""""
65
66 The source code validation could otherwise fail a build with cryptic errors.
67
68 :issue:`3985`
69
70 Ensure that NB-LIB and gmxapi can be build even without tests enabled
71 """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
72
73 Could otherwise lead to cryptic build errors.
74
75 Miscellaneous
76 ^^^^^^^^^^^^^
77
78 Removed performance loss in the mdrun domain decomposition
79 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""
80
81 With 16 or more so-called PP MPI ranks, the domain decomposition
82 repartitioning could incur large performance overheads due to a sub-optimally
83 sized hash table. This has now been fixed.
84
85 :issue:`4054`