Skip to content

Expose exploring protocol settings how-to - #2345

Open
jthorton wants to merge 10 commits into
mainfrom
docs/exploring_settings
Open

jthorton wants to merge 10 commits into
mainfrom
docs/exploring_settings

Conversation

@jthorton

@jthorton jthorton commented Nov 9, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Fixes #2278

LLM / AI generated code disclosure

LLMs or other AI-powered tools (beyond simple IDE use cases) were used in this contribution:

  • No
  • Yes: [If yes, please provide details here]

Checklist

  • Read the AI Policy and filled in the AI-generated code disclosure.
  • Adhered to the contribution guidelines
  • All new code is appropriately documented (user-facing code must have complete docstrings).
  • Ran pre-commit: you can run pre-commit locally or comment on this PR with pre-commit.ci autofix.
  • Added a news entry, or the changes are not user-facing.

Manual Tests: these are slow so don't need to be run every commit, only before merging and when relevant changes are made (generally at reviewer-discretion).

Developers certificate of origin

jthorton and others added 2 commits November 9, 2026 14:44
Co-authored-by: Hannah Baumann <43765638+hannahbaumann@users.noreply.github.com>

@hannahbaumann hannahbaumann left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jthorton , lgtm, just left a few small comments!


The number of lambda windows in each leg must match the number of replicas set in ``solvent_simulation_settings.n_replicas`` and ``vacuum_simulation_settings.n_replicas``.

For more information on configuring these and other protocol settings, see :doc:`Exploring protocol settings </how_to_guides/exploring_protocol_settings>`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since that notebook doesn't show the absolute solvation settings (as far as I remember), should we maybe reword/remove this here?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I wasn't sure about this one, we mention it in the introduction but then don't show it in an example. We could add something to the guide to highlight that it acts like the other protocols but has the solvent and vacuum prefix?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea of adding a very small N.B. note.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread docs/guide/setup/defining_protocols.rst Resolved
jthorton and others added 4 commits November 10, 2026 11:03
Co-authored-by: Hannah Baumann <43765638+hannahbaumann@users.noreply.github.com>
Co-authored-by: Hannah Baumann <43765638+hannahbaumann@users.noreply.github.com>
Co-authored-by: Hannah Baumann <43765638+hannahbaumann@users.noreply.github.com>
Co-authored-by: Hannah Baumann <43765638+hannahbaumann@users.noreply.github.com>

@IAlibay IAlibay left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] tutorial on how to explore and validate settings changes

3 participants