Skip to content

add mixed network tutorial - #350

Open
jthorton wants to merge 8 commits into
mainfrom
mixed_networks
Open

jthorton wants to merge 8 commits into
mainfrom
mixed_networks

Conversation

@jthorton

Copy link
Copy Markdown
Contributor

No description provided.

@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

Copy link
Copy Markdown

Colab 👈 Launch a Colab session on branch mixed_networks

@jthorton jthorton self-assigned this Oct 28, 2026
@@ -0,0 +1,1465 @@
{

@hannahbaumann hannahbaumann Nov 2, 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.

In this tutorial, we will demonstrate how to create a mixed...

Since the protocol also goes into the setup of the calculations, and analysis of results, I would add that here so the user has an overview of what's covered in the notebook.


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.

Tried to do this with a minor edit to the overview and the list of steps.

@@ -0,0 +1,1465 @@
{

@hannahbaumann hannahbaumann Nov 2, 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.

Line #4.    ligands_file = "inputs/ligands.sdf"

This file still needs to be added. Do the ligand come with partial charges?


Reply via ReviewNB

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.

+1 a more descriptive file name would be great

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.

Added the file and updated the name.

@@ -0,0 +1,1465 @@
{

@hannahbaumann hannahbaumann Nov 2, 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.

I think this part is missing a brief intro sentence.


Reply via ReviewNB

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.

+1

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.

added something.

@@ -0,0 +1,1465 @@
{

@hannahbaumann hannahbaumann Nov 2, 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.

I think the strategy for how to create the mixed network should be highlighted more.

Was there a specific reason you decided to go by series how and not by Lomap score?


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.

Tried to make the selection method clear.

Was there a specific reason you decided to go by series how and not by Lomap score?

I was thinking that this is more consistent with our new domain of applicability guide and generally how we talk about the SepTop method and has no magic numbers (Lomap score cutoff) so this might be a nice intro to the idea of mixing the protocols.

In our other work though we do plan on having an API which can sub out the protocol based on lomap score so maybe we should change it here to plant the idea?

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.

I'm also not fully sure yet what the best way would be, yes, I agree we haven't investigated the science enough to say "lomap 0.5 is a great threshold", but I also wonder if planning the mixed network generally by score may be more something that would fit into the use cases of our users as if they already know there are different series and they should be treated separately, maybe they would just run them in completely separate maps. BUt if there was a score that could tell you generally which method is better (meaning also within a series), that would of course be better. So I think I would at least show a brief example on how to create the mixed network by score? Or do you think that would make the tutorial too confusing and that should be separate in e.g. a how-to?

@@ -0,0 +1,1465 @@
{

@hannahbaumann hannahbaumann Nov 2, 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.

openfe provides a number of free ene

[nit] Somehow "a number" sounds like a lot while we only have three binding protocols, I understand that you don't want to add a specific number as we will add more protocols, but maybe just "provides different free ..."? Not sure if that's better, please reject if you don't think so!


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.

Tried to rephrase, is that a bit better?

@@ -0,0 +1,1465 @@
{

@IAlibay IAlibay Nov 3, 2026 •

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.

[nit] probably worth adding the links for how partial charges can be added via the CLI & API.


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.

Good idea added.

@@ -0,0 +1,1465 @@
{

@IAlibay IAlibay Nov 3, 2026 •

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.

Line #11.    network_graph = nx.Graph()

Not specifically this line but all the lines in this cell - some comments that describe what you are doing would be useful to readers.


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.

Added throughout.

@@ -0,0 +1,1465 @@
{

@IAlibay IAlibay Nov 3, 2026 •

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.

[nit] It might be good to add something indicating the score goes from 0 to 1.


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.

Added.

@@ -0,0 +1,1465 @@
{

@IAlibay IAlibay Nov 3, 2026 •

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.

[nit] How about moving the force field bit to a "warning" box that more specifically says that they need to ensure that key settings which affect the free energy results should match between the two Protocols - in this case the force field settings.


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.

Changed.

@@ -0,0 +1,1465 @@
{

@IAlibay IAlibay Nov 3, 2026 •

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.

[nit] plot hasn't come through, not sure if it's just the rendering.


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.

It seems to show on the github render I'll check on openfe.

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.

3 participants