Skip to content

Commit c3dd9ee

Browse files
authored
Merge pull request #402 from openforcefield/050-release-notes
Add release notes summary for 0.5.0
2 parents fdb6406 + 90dbde2 commit c3dd9ee

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

docs/releasehistory.rst

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,27 @@ Releases follow the ``major.minor.micro`` scheme recommended by `PEP440 <https:/
88
* ``micro`` increments represent bugfix releases or improvements in documentation
99

1010

11+
0.5.0 - GBSA support and quality-of-life improvements
12+
-----------------------------------------------------
13+
14+
This release adds support for the
15+
`GBSA tag in the SMIRNOFF specification <https://open-forcefield-toolkit.readthedocs.io/en/latest/smirnoff.html#gbsa>`_.
16+
Currently, the ``HCT``, ``OBC1``, and ``OBC2`` models (corresponding to AMBER keywords
17+
``igb=1``, ``2``, and ``5``, respectively) are supported, with the ``OBC2`` implementation being
18+
the most flexible. Unfortunately, systems produced
19+
using these keywords are not yet transferable to other simulation packages via ParmEd, so users are restricted
20+
to using OpenMM to simulate systems with GBSA.
21+
22+
OFFXML files containing GBSA parameter definitions are available,
23+
and can be loaded in addition to existing parameter sets (for example, with the command
24+
``ForceField('test_forcefields/smirnoff99Frosst.offxml', 'test_forcefields/GBSA_OBC1-1.0.offxml')``).
25+
A manifest of new SMIRNOFF-format GBSA files is below.
26+
27+
28+
Several other user-facing improvements have been added, including easier access to indexed attributes,
29+
which are now accessible as ``torsion.k1``, ``torsion.k2``, etc. (the previous access method
30+
``torsion.k`` still works as well). More details of the new features and several bugfixes are listed below.
31+
1132
New features
1233
""""""""""""
1334
- `PR #363 <https://github.com/openforcefield/openforcefield/pull/363>`_: Implements
@@ -36,7 +57,7 @@ New features
3657
- `PR #377 <https://github.com/openforcefield/openforcefield/pull/377>`_: Single indexed parameters in
3758
:py:class:`ParameterHandler <openforcefield.typing.engines.smirnoff.parameters.ParameterHandler>`
3859
and :py:class:`ParameterType <openforcefield.typing.engines.smirnoff.parameters.ParameterType>`
39-
can now be get/set through normal attribute syntax on top of the list syntax.
60+
can now be get/set through normal attribute syntax in addition to the list syntax.
4061
- `PR #394 <https://github.com/openforcefield/openforcefield/pull/394>`_: Include element and atom name
4162
in error output when there are missing valence parameters during molecule parameterization.
4263

@@ -62,7 +83,7 @@ Force fields added
6283
``test_forcefields/GBSA_HCT-1.0.offxml``, ``test_forcefields/GBSA_OBC1-1.0.offxml``,
6384
and ``test_forcefields/GBSA_OBC2-1.0.offxml``, which are experimental implementations
6485
of GBSA models. These are primarily used in validation tests against OpenMM's models, and
65-
their versions are intended to track bugfixes if discrepancies are found.
86+
their version numbers will increment if bugfixes are necessary.
6687

6788
0.4.1 - Bugfix Release
6889
----------------------

0 commit comments

Comments
 (0)