From 988189ccd91eb9a8e1eead12b984dfcbda204dab Mon Sep 17 00:00:00 2001 From: Alyssa Travitz Date: Fri, 9 Jan 2026 16:07:30 -0800 Subject: [PATCH 1/6] make CLI starting guide easier to find from the landing page --- docs/index.rst | 6 +++--- openfecli/parameters/plan_network_options.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 600d84310..6bdb6e844 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,12 +25,12 @@ Using this toolkit you can plan, execute, and analyze free energy calculations u Follow our installation guide to get **openfe** running on your machine! - .. grid-item-card:: :fas:`laptop-code` CLI + .. grid-item-card:: :fas:`laptop-code` CLI Quickstart :text-align: center - :link: reference/cli/index + :link: tutorials/rbfe_cli_tutorial :link-type: doc - Documentation for **openfe**\'s simple command line interface. + The simplest way to get started with **openfe**\'s command line interface. .. grid-item-card:: :fas:`person-chalkboard` Tutorials :text-align: center diff --git a/openfecli/parameters/plan_network_options.py b/openfecli/parameters/plan_network_options.py index 5798d69e4..b349d8972 100644 --- a/openfecli/parameters/plan_network_options.py +++ b/openfecli/parameters/plan_network_options.py @@ -205,7 +205,7 @@ def load_yaml_planner_options(path: Optional[str], context) -> PlanNetworkOption # TODO: do we want this in the docs anywhere? DEFAULT_YAML = """ - mapper: KartografAtomMapper + mapper: kartograf settings: atom_max_distance: 0.95 atom_map_hydrogens: true From 1fd788f996c51fd634dc7899a0e395d3465c4791 Mon Sep 17 00:00:00 2001 From: Alyssa Travitz Date: Tue, 13 Jan 2026 11:11:13 -0800 Subject: [PATCH 2/6] Python API -> API Docs --- docs/index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 6bdb6e844..6e8cbbd49 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,7 +30,7 @@ Using this toolkit you can plan, execute, and analyze free energy calculations u :link: tutorials/rbfe_cli_tutorial :link-type: doc - The simplest way to get started with **openfe**\'s command line interface. + Get started with **openfe**\'s command line interface. .. grid-item-card:: :fas:`person-chalkboard` Tutorials :text-align: center @@ -53,12 +53,12 @@ Using this toolkit you can plan, execute, and analyze free energy calculations u How-to guides for common tasks. - .. grid-item-card:: :fas:`code` Python API + .. grid-item-card:: :fas:`code` API Docs :text-align: center - :link: reference/api/index + :link: reference/index :link-type: doc - Comprehensive details of the **openfe** Python API. + Comprehensive details of the **openfe** Python and CLI APIs. .. grid-item-card:: :fas:`gears` Protocols :text-align: center From 45276064ffa7de5b16fb79666d1349764d16bb44 Mon Sep 17 00:00:00 2001 From: Alyssa Travitz Date: Thu, 15 Jan 2026 09:06:19 -0800 Subject: [PATCH 3/6] bump ci From c0c8ab97a5bb5f616bea6c0ce8a0647b182d02ea Mon Sep 17 00:00:00 2001 From: Alyssa Travitz Date: Mon, 26 Jan 2026 09:42:18 -0800 Subject: [PATCH 4/6] bump example notebooks pin to 2026.01.26 --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 1e6bd07df..f54790c22 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -193,7 +193,7 @@ else: repo = git.Repo.clone_from( "https://github.com/OpenFreeEnergy/ExampleNotebooks.git", - branch="2025.12.04", + branch="2026.01.26", to_path=example_notebooks_path, ) except Exception as e: From a5e4ced8f2788d049d9fc046c0421545b3e39463 Mon Sep 17 00:00:00 2001 From: Alyssa Travitz Date: Mon, 26 Jan 2026 11:56:23 -0800 Subject: [PATCH 5/6] change a word --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 6e8cbbd49..4a0cb6f69 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -53,7 +53,7 @@ Using this toolkit you can plan, execute, and analyze free energy calculations u How-to guides for common tasks. - .. grid-item-card:: :fas:`code` API Docs + .. grid-item-card:: :fas:`code` API Reference :text-align: center :link: reference/index :link-type: doc From 8821175bef3d3ec9dfb80c176fcafd656dc151f3 Mon Sep 17 00:00:00 2001 From: Alyssa Travitz Date: Mon, 26 Jan 2026 11:59:49 -0800 Subject: [PATCH 6/6] clarifying language --- docs/reference/api/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/api/index.rst b/docs/reference/api/index.rst index 5b93b8739..d74b545dc 100644 --- a/docs/reference/api/index.rst +++ b/docs/reference/api/index.rst @@ -4,7 +4,7 @@ We have reproduced API documentation from the `gufe`_ package here for convenience. `gufe`_ serves as a foundation layer for openfe, providing abstract base classes and object models, and so might be more useful for developers. -OpenFE API Reference +Python API Reference ==================== .. toctree::