Skip to content

Merge cinnabar tutorials into a single how-to guide - #357

Open
hannahbaumann wants to merge 13 commits into
mainfrom
rename-cinnabar-howto
Open

hannahbaumann wants to merge 13 commits into
mainfrom
rename-cinnabar-howto

Conversation

@hannahbaumann

@hannahbaumann hannahbaumann commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

For moving the cinnabar tutorial into the how-to guide: OpenFreeEnergy/openfe#2343

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown

Colab 👈 Launch a Colab session on branch rename-cinnabar-howto

@hannahbaumann hannahbaumann self-assigned this Nov 9, 2026
@hannahbaumann

hannahbaumann commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor Author

Actually, maybe this is a good time to address this:

@hannahbaumann hannahbaumann changed the title Rename cinnabar title to match howto style Merge cinnabar tutorials into a single how-to guide Nov 9, 2026
@@ -5,9 +5,16 @@
"id": "ddae61fd-fa15-4be9-9160-ba3e195c67dc",

@jthorton jthorton Nov 9, 2026 •

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.

What about bolding the relative free energies and absolute free energies in the list to make it stand out?

Maybe a warning or note box for the cinnabar version or we could have a cell that checks it and errors if its not over 0.6?


Reply via ReviewNB

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks, yes made them bold and moved the version mentioning into a box!

@@ -5,9 +5,16 @@
"id": "ddae61fd-fa15-4be9-9160-ba3e195c67dc",

@jthorton jthorton Nov 9, 2026 •

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.

The requirement for all values to have an experimental point is no longer true in cinnabar so we can remove this.


Reply via ReviewNB

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks, removed this!

@@ -5,9 +5,16 @@
"id": "ddae61fd-fa15-4be9-9160-ba3e195c67dc",

@jthorton jthorton Nov 9, 2026 •

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.

The plots look great!


Reply via ReviewNB

@@ -5,9 +5,16 @@
"id": "ddae61fd-fa15-4be9-9160-ba3e195c67dc",

@jthorton jthorton Nov 9, 2026 •

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.

Should the gather-septop command not be included in the first item as it also runs MLE on the relative differences?

Also do we need to sync up the outputs of the rbfe and septop dg reports to have the same headings?

Should we say something about mixed networks here or the section above and point to the new tutorial as the CLI steps will be an issue?


Reply via ReviewNB

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@@ -5,9 +5,16 @@
"id": "ddae61fd-fa15-4be9-9160-ba3e195c67dc",

@jthorton jthorton Nov 9, 2026 •

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.

Why does this use slightly different DG values, if this from a different network to the DDG example above?


Reply via ReviewNB

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

YEs, I'm not sure why this was different, I now recreated the file to match the other output.

@@ -5,9 +5,16 @@
"id": "ddae61fd-fa15-4be9-9160-ba3e195c67dc",

@jthorton jthorton Nov 9, 2026 •

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.

Should this note be copied to the ned of the relative plotting guide above?


Reply via ReviewNB

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I moved part of the note to the relative section above, but left this here as a reminder, please let me know if you feel like it wouldn't be necessary here.

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.

Merge cinnabar-absolute and cinnabar RBFE plotting docs

2 participants