Skip to content

Add simulation extraction and viewing notebook#226

Merged
hannahbaumann merged 24 commits into
mainfrom
traj-view
Jun 11, 2026
Merged

Add simulation extraction and viewing notebook#226
hannahbaumann merged 24 commits into
mainfrom
traj-view

Conversation

@jthorton

@jthorton jthorton commented Sep 5, 2025

Copy link
Copy Markdown
Contributor

Fixes #223

@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 Sep 5, 2025

Copy link
Copy Markdown

Binder 👈 Launch a binder notebook on branch OpenFreeEnergy/ExampleNotebooks/traj-view

Comment thread simulation_visualisation/simulation_visualisation.ipynb Outdated
Comment thread simulation_visualisation/simulation_visualisation.ipynb
Comment thread simulation_visualisation/simulation_visualisation.ipynb
Comment thread simulation_visualisation/simulation_visualisation.ipynb
Comment thread simulation_visualisation/simulation_visualisation.ipynb
Comment thread simulation_visualisation/simulation_visualisation.ipynb

@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.

Overall looks good, thanks for doing this!

Added a few comments for things that we should address.

Comment thread simulation_visualisation/simulation_visualisation.ipynb
Comment thread simulation_visualisation/simulation_visualisation.ipynb
Comment thread simulation_visualisation/simulation_visualisation.ipynb
@hannahbaumann hannahbaumann self-assigned this Jun 1, 2026
@review-notebook-app

review-notebook-app Bot commented Jun 3, 2026

Copy link
Copy Markdown

View / edit / reply to this conversation on ReviewNB

IAlibay commented on 2026-06-03T13:14:02Z
----------------------------------------------------------------

Two questions:

1) Could you mention what Transformations are being applied by the method? Also can you mention that there's a separate one for solvent simulations if they want it.

2) Is there anything we can link to regarding when centering is a good idea and when it's not? I can't remember what Justin Lemkhul usually links to. Essentially what I mean here is that it would be good to say "don't center / align if you need to look at how components diffuse over time, etc..."


hannahbaumann commented on 2026-06-08T11:45:15Z
----------------------------------------------------------------

Added details on the transformations and added a note that the traj should not be aligned when looking at diffusion behavior. I couldn't find a good reference yet though.

@review-notebook-app

review-notebook-app Bot commented Jun 3, 2026

Copy link
Copy Markdown

View / edit / reply to this conversation on ReviewNB

IAlibay commented on 2026-06-03T13:14:03Z
----------------------------------------------------------------

"We can fix this, however, using the alignment functions in openfe_analysis"

It would be good to reword this as using a helper method to add a transformation to the MDAnalysis Universe. That way folkls that know MDAnalysis things can easily understand what's going on. For those that don't it would be good to link to the Transformations documentions in MDAnalysis (just so that folks understand what that means). And then in the code block add a comment when you apply the transformation.


hannahbaumann commented on 2026-06-08T11:48:52Z
----------------------------------------------------------------

Reworded, added a link to the MDA docs and a comment in the code block.

jthorton commented on 2026-06-09T09:21:49Z
----------------------------------------------------------------

This looks really good. One possible bit of info to add is that the resname of the ligand is always UNK from the protocol?

IAlibay commented on 2026-06-09T13:24:07Z
----------------------------------------------------------------

I would may avoid putting is as "always" but "usually" - in pontibus the ligands have normal residue names. Longer term we need to change this too (it's been a long term wish of mine to make SmallMoleculeComponent have a resname setter).

hannahbaumann commented on 2026-06-10T09:32:16Z
----------------------------------------------------------------

Thanks, I added a doc string before defining the ligand selection!

Copy link
Copy Markdown
Contributor

Removed this


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor

Thanks, I added a doc string before defining the ligand selection!


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor

True, removed this!


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor

Thanks, changed this!


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor

Changed this!


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor

Changed this!


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor

Added a comment!


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor

Yes, changed this!


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor

Changed this!


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor

Changed this!


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor

Changed this!


View entire conversation on ReviewNB

@hannahbaumann hannahbaumann requested a review from IAlibay June 10, 2026 10:42
@hannahbaumann

Copy link
Copy Markdown
Contributor

@jthorton : I removed the images since they were no longer used!

@review-notebook-app

review-notebook-app Bot commented Jun 11, 2026

Copy link
Copy Markdown

View / edit / reply to this conversation on ReviewNB

IAlibay commented on 2026-06-11T07:23:08Z
----------------------------------------------------------------

[nits]

1) Small style discrepancy - you use the backticks around MDAnalysis in one place and then just use a normal link for openfe-analysis and MDAnalysis elsewhere. If you can't use backticks with links, I would just bold the package names.

2) Maybe use backticks around tempfactor?


hannahbaumann commented on 2026-06-11T09:50:39Z
----------------------------------------------------------------

Changes this!

@review-notebook-app

review-notebook-app Bot commented Jun 11, 2026

Copy link
Copy Markdown

View / edit / reply to this conversation on ReviewNB

IAlibay commented on 2026-06-11T07:23:09Z
----------------------------------------------------------------

Line #7.    ! tar -xzf septop_structural_results.zip

Should this be unzip instead of tar xzf? Or is this a poorly named gzip file? (if it's the latter - let's open an issue to fix that and add a comment here it's going to be confusing to readers otherwise).


hannahbaumann commented on 2026-06-11T09:50:51Z
----------------------------------------------------------------

Using unzip now

@review-notebook-app

review-notebook-app Bot commented Jun 11, 2026

Copy link
Copy Markdown

View / edit / reply to this conversation on ReviewNB

IAlibay commented on 2026-06-11T07:23:10Z
----------------------------------------------------------------

Line #3.    v.render_image(trim=False, factor=4)

[nit] Other places you set trim to True, any reason for using False here?


hannahbaumann commented on 2026-06-11T09:51:29Z
----------------------------------------------------------------

Good catch, I think this was left from playing around with different options, using True here now as well.

@review-notebook-app

review-notebook-app Bot commented Jun 11, 2026

Copy link
Copy Markdown

View / edit / reply to this conversation on ReviewNB

IAlibay commented on 2026-06-11T07:23:11Z
----------------------------------------------------------------

Line #2.    state_a = sum(u_0.atoms[u_0.atoms.tempfactors <= 0.5])

You don't need to do the sum here - the u_0.atoms indexing will create the atomgroup.


hannahbaumann commented on 2026-06-11T09:51:46Z
----------------------------------------------------------------

Changed this!

@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.

Couple of small things but lgtm! I'll approve early.

@jthorton jthorton left a comment

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 for finishing this up @hannahbaumann LGTM!

Copy link
Copy Markdown
Contributor

Changes this!


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor

Using unzip now


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor

Good catch, I think this was left from playing around with different options, using True here now as well.


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor

Changed this!


View entire conversation on ReviewNB

@hannahbaumann hannahbaumann merged commit 216a4a6 into main Jun 11, 2026
4 checks passed
@hannahbaumann hannahbaumann deleted the traj-view branch June 11, 2026 11:19
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.

OpenFE Analylsis notebook

4 participants