Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for variable position/velocity trajectory writing #1083

Merged
merged 15 commits into from
Feb 4, 2025

Conversation

IAlibay
Copy link
Member

@IAlibay IAlibay commented Jan 20, 2025

Depends on: choderalab/openmmtools#767

Also see: OpenFreeEnergy/openfe_analysis#44

TODO:

  • Check this works in real life w/ the openfe_analysis patch
  • Check that the settings keywords make sense / match other protocols
  • Check that the frequency defaults are reasonable / yield sufficiently small trajectories
  • Work out the difference in file size compared to current main
  • Better document the frequency writing?
  • Add pydantic validators (at least positive value checks?)
  • Add tests to check that values works (asserting on the reporter's variables) / the right error gets brought up?
  • Add news entry

Developers certificate of origin

Copy link

codecov bot commented Jan 20, 2025

Codecov Report

Attention: Patch coverage is 96.29630% with 3 lines in your changes missing coverage. Please review.

Project coverage is 91.87%. Comparing base (bd95f22) to head (233e90f).
Report is 16 commits behind head on main.

Files with missing lines Patch % Lines
openfe/protocols/openmm_utils/omm_settings.py 80.00% 2 Missing ⚠️
openfe/tests/protocols/test_openmm_rfe_slow.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1083      +/-   ##
==========================================
- Coverage   93.49%   91.87%   -1.62%     
==========================================
  Files         142      142              
  Lines       10527    10608      +81     
==========================================
- Hits         9842     9746      -96     
- Misses        685      862     +177     
Flag Coverage Δ
fast-tests 91.87% <96.29%> (?)
slow-tests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@hannahbaumann hannahbaumann self-requested a review January 22, 2025 09:48
@hannahbaumann hannahbaumann self-assigned this Jan 22, 2025
@IAlibay IAlibay changed the title [WIP] Add support for variable position/velocity trajectory writing Add support for variable position/velocity trajectory writing Jan 28, 2025
@IAlibay IAlibay marked this pull request as ready for review January 28, 2025 14:02
@IAlibay
Copy link
Member Author

IAlibay commented Jan 28, 2025

Check that the frequency defaults are reasonable / yield sufficiently small trajectories

@hannahbaumann the defaults would now yield 50 frames per replica, down from 5000 frames per replica, which should be a large enough reduction in size, what do you think?

@hannahbaumann
Copy link
Contributor

Yes, that sounds like a good size!

@IAlibay
Copy link
Member Author

IAlibay commented Jan 28, 2025

I think everything that needs addressing has been addressed, only thing that's blocking is a release of openmmtools and openfe-analysis, but I'll leave it to you to approve @hannahbaumann !

Copy link
Contributor

@hannahbaumann hannahbaumann left a comment

Choose a reason for hiding this comment

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

Thanks @IAlibay , lgtm! We'll just need to change the pin after the openmmtools release.

@IAlibay
Copy link
Member Author

IAlibay commented Jan 29, 2025

I'm getting the sense the openmmtools release won't be for a few weeks, so we might have to wait until the next OpenFE release to have this merged.

@atravitz atravitz added this to the v1.3.0 milestone Jan 31, 2025
Copy link

github-actions bot commented Feb 3, 2025

No API break detected ✅

@IAlibay
Copy link
Member Author

IAlibay commented Feb 4, 2025

Checked it out locally, should be good to go.

@IAlibay IAlibay merged commit eef438f into main Feb 4, 2025
12 checks passed
@IAlibay IAlibay deleted the multistate-variablewriting branch February 4, 2025 02:25
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