From 41159bde89099e2c3a55542cf82033ec1c267b78 Mon Sep 17 00:00:00 2001 From: Alyssa Travitz Date: Thu, 26 Mar 2026 16:56:12 -0700 Subject: [PATCH 1/4] Updated CHANGELOG for 1.10.10 --- docs/CHANGELOG.rst | 25 +++++++++++++++++++++++++ news/deprecate_perses.rst | 24 ------------------------ news/fix_abfe_gather.rst | 23 ----------------------- news/quickrun_resume.rst | 24 ------------------------ news/resume.rst | 27 --------------------------- 5 files changed, 25 insertions(+), 98 deletions(-) delete mode 100644 news/deprecate_perses.rst delete mode 100644 news/fix_abfe_gather.rst delete mode 100644 news/quickrun_resume.rst delete mode 100644 news/resume.rst diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst index 8d9c5b069..b4246521f 100644 --- a/docs/CHANGELOG.rst +++ b/docs/CHANGELOG.rst @@ -4,6 +4,31 @@ Changelog .. current developments +v1.10.10 +==================== + +**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. +* 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``. + +**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. + + + v1.9.1 ==================== 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:** - -* From bd1ad24f4dedeffd6e25775b3235017aaa2df086 Mon Sep 17 00:00:00 2001 From: Alyssa Travitz Date: Thu, 26 Mar 2026 17:00:41 -0700 Subject: [PATCH 2/4] clean up links --- docs/CHANGELOG.rst | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst index b4246521f..b332bf8fa 100644 --- a/docs/CHANGELOG.rst +++ b/docs/CHANGELOG.rst @@ -4,28 +4,25 @@ Changelog .. current developments -v1.10.10 +v1.10.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. -* Added API support to resume `RelativeHybridTopologyProtocol` - simulations (`PR 1774 `_). -* Added API support to resume `AbsoluteBindingProtocol` and - `AbsoluteSolvationProtocol` simulations - (`PR 1808 `_). + 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``. + 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. + This fix restores the behavior prior to v1.9.0 (`PR 1876 `_). @@ -35,7 +32,7 @@ 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 `_). From f20c5ad4a66748117b1eb28f6980a7b48f81095c Mon Sep 17 00:00:00 2001 From: Alyssa Travitz Date: Thu, 26 Mar 2026 17:04:51 -0700 Subject: [PATCH 3/4] consistent formatting --- docs/CHANGELOG.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst index b332bf8fa..8ffbec777 100644 --- a/docs/CHANGELOG.rst +++ b/docs/CHANGELOG.rst @@ -10,19 +10,19 @@ v1.10.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 (`PR 1848 `_). -* Added API support to resume ``RelativeHybridTopologyProtocol`` simulations (`PR 1774 `_). -* Added API support to resume ``AbsoluteBindingProtocol`` and ``AbsoluteSolvationProtocol`` simulations (`PR 1808 `_). + 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 `_). + 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 `_). + This fix restores the behavior prior to v1.9.0 (`PR #1876 `_). @@ -32,7 +32,7 @@ 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 `_). @@ -42,26 +42,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 `_). From 9a80ccc9bd8b1fece16ec0117528730c27d95b51 Mon Sep 17 00:00:00 2001 From: Alyssa Travitz Date: Mon, 30 Mar 2026 14:55:10 -0700 Subject: [PATCH 4/4] add link to new docs --- docs/CHANGELOG.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst index 8ffbec777..2fa2fd6d5 100644 --- a/docs/CHANGELOG.rst +++ b/docs/CHANGELOG.rst @@ -7,6 +7,9 @@ Changelog 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``.