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

Bugfix Boresch Correction #258

Merged
merged 2 commits into from
Dec 3, 2024

Conversation

fjclark
Copy link
Collaborator

@fjclark fjclark commented Nov 1, 2024

This pull request closes #248. I've updated the Boresch restraint correction to be consistent with the definitions of the restraint energies and forces as E = k * x **2 and F = 2 * k * x. To make this clear to the user, I've also updated the restraints docstrings and tutorial page to make this explicit, and have referred to the "k"s as "half force constants". This isn't the cleanest vocabulary, so please let me know if there's a better way to explain this.

  • I confirm that I have merged the latest version of devel into this branch before issuing this pull request (e.g. by running git pull origin devel): [y]
  • I confirm that I have added a changelog entry to the changelog (we will add a link to this PR as part of the review): [y]
  • I confirm that I have permission to release this code under the GPL3 license: [y]

Suggested reviewers:

@chryswoods, @lohedges

Thanks.

Previously, the correction was implemented assuming F=kx. This lead
to erroneously favourable absolute free energies of binding by
1.23 kcal mol-1.
Update the restraint function docstrings, restraints tutorial,
and changelog.
Copy link
Contributor

@lohedges lohedges left a comment

Choose a reason for hiding this comment

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

Thanks for this. I'm happy with the changes.

@lohedges lohedges mentioned this pull request Dec 3, 2024
@lohedges lohedges merged commit d48d138 into OpenBioSim:devel Dec 3, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Definition of force constants inconsistent between Boresch restraints correction and applied restraints
2 participants