diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst index 8d9c5b069..2fa2fd6d5 100644 --- a/docs/CHANGELOG.rst +++ b/docs/CHANGELOG.rst @@ -4,13 +4,38 @@ Changelog .. current developments +v1.10.0 +==================== + +This release introduces the ability to resume execution of an incomplete transformation using ``openfe quickrun`` with the ``--resume`` flag. +See the `quickrun documentation `_ details. + +**Added:** + +* Added ``--resume`` flag to ``openfe quickrun``. + Quickrun now temporarily caches ``protocolDAG`` information and, when used with the ``--resume`` flag, quickrun will attempt to resume execution of an incomplete transformation (`PR #1848 `_). +* Added API support to resume ``RelativeHybridTopologyProtocol`` simulations (`PR #1774 `_). +* Added API support to resume ``AbsoluteBindingProtocol`` and ``AbsoluteSolvationProtocol`` simulations (`PR #1808 `_). + +**Deprecated:** + +* Perses atom mapper and scorer functionality is deprecated, slated to be removed in ``openfe v2.0``. + This includes ``PersesAtomMapper`` and ``default_perses_scorer`` (`PR #1857 `_). + +**Fixed:** + +* Fixed bug introduced in v1.9.0 to ``openfe gather-abfe --report=raw`` where additional unit results for Setup and Simulation units would be shown. + This fix restores the behavior prior to v1.9.0 (`PR #1876 `_). + + + v1.9.1 ==================== **Fixed:** * Fixed a bug in Protocol termination for the HybridTop and AFE Protocols which would unnecessarily declare an ``UnboundLocalError``. -* Updated ``openfe_analysis`` dependency to fix issue with RMSD analysis (`Issue 1834 `). +* Updated ``openfe_analysis`` dependency to fix issue with RMSD analysis (`Issue #1834 `_). @@ -20,26 +45,26 @@ v1.9.0 **Added:** * The ``validate`` method for the RelativeHybridTopologyProtocol has been implemented. - This means that settings and system validation can mostly be done prior to Protocol execution by calling ``RelativeHybridTopologyProtocol.validate(stateA, stateB, mapping)`` (`PR 1740 `_). + This means that settings and system validation can mostly be done prior to Protocol execution by calling ``RelativeHybridTopologyProtocol.validate(stateA, stateB, mapping)`` (`PR #1740 `_). -* Added ``openfe test --download-only`` flag, which downloads all test data stored remotely to the local cache (`PR 1814 `_). +* Added ``openfe test --download-only`` flag, which downloads all test data stored remotely to the local cache (`PR #1814 `_). **Changed:** * The absolute free energy protocols (AbsoluteBindingProtocol and AbsoluteSolvationProtocol) have been broken into multiple protocol units, allowing for setup, run, and analysis to happen separately in the future when relevant changes to protocol execution are - made (`PR 1776 `_). + made (`PR #1776 `_). * The relative free energy protocol (RelativeHybridTopologyProtocol) has been broken into multiple protocol units, allowing for the setup, run, analysis to happen - separately (`PR 1773 `_). + separately (`PR #1773 `_). **Fixed:** -* Fixed bug in ligand network visualization (such as with ``openfe view-ligand-network``) so that ligand names are no longer cut off by the plot border (`PR 1822 `_). +* Fixed bug in ligand network visualization (such as with ``openfe view-ligand-network``) so that ligand names are no longer cut off by the plot border (`PR #1822 `_). * Endstates in the RelativeHybridTopologyProtocol are now being created in a manner that allows for isomorphic molecules that differ between - endstates to have different parameters (`PR 1772 `_). + endstates to have different parameters (`PR #1772 `_). diff --git a/news/deprecate_perses.rst b/news/deprecate_perses.rst deleted file mode 100644 index 07047159d..000000000 --- a/news/deprecate_perses.rst +++ /dev/null @@ -1,24 +0,0 @@ -**Added:** - -* - -**Changed:** - -* - -**Deprecated:** - -* Perses atom mapper and scorer functionality is deprecated, slated to be removed in ``openfe v2.0``. -This includes ``PersesAtomMapper`` and ``default_perses_scorer``. - -**Removed:** - -* - -**Fixed:** - -* - -**Security:** - -* diff --git a/news/fix_abfe_gather.rst b/news/fix_abfe_gather.rst deleted file mode 100644 index 99dd840bd..000000000 --- a/news/fix_abfe_gather.rst +++ /dev/null @@ -1,23 +0,0 @@ -**Added:** - -* - -**Changed:** - -* - -**Deprecated:** - -* - -**Removed:** - -* - -**Fixed:** - -* Fixed bug introduced in v1.9.0 to ``openfe gather-abfe --report=raw`` where additional unit results for Setup and Simulation units would be shown. -This fix restores the behavior prior to v1.9.0. -**Security:** - -* diff --git a/news/quickrun_resume.rst b/news/quickrun_resume.rst deleted file mode 100644 index c594c443a..000000000 --- a/news/quickrun_resume.rst +++ /dev/null @@ -1,24 +0,0 @@ -**Added:** - -* Added ``--resume`` flag to ``openfe quickrun``. - Quickrun now temporarily caches ``protocolDAG`` information and, when used with the ``--resume`` flag, quickrun will attempt to resume execution of an incomplete transformation. - -**Changed:** - -* - -**Deprecated:** - -* - -**Removed:** - -* - -**Fixed:** - -* - -**Security:** - -* diff --git a/news/resume.rst b/news/resume.rst deleted file mode 100644 index 1c123da2e..000000000 --- a/news/resume.rst +++ /dev/null @@ -1,27 +0,0 @@ -**Added:** - -* Added API support to resume `RelativeHybridTopologyProtocol` - simulations (`PR 1774 `_). -* Added API support to resume `AbsoluteBindingProtocol` and - `AbsoluteSolvationProtocol` simulations - (`PR 1808 `_). - -**Changed:** - -* - -**Deprecated:** - -* - -**Removed:** - -* - -**Fixed:** - -* - -**Security:** - -*