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

Correct RMSD documentation and remove RMSD weight setting. #417

Merged
merged 4 commits into from
Apr 18, 2024

Conversation

ChiCheng45
Copy link
Collaborator

@ChiCheng45 ChiCheng45 commented Apr 18, 2024

Description of work
Updated and corrected RMSD documentation, the equations in the current version are not correct, see the new version below. Also updated the ROG documentation.

image

I've also removed the weight setting from the RMSD calculation. Here are two reason for why I've decided that the weight setting should be remove from the RMSD calculation.

  • RMSD weight setting does not follow the documentation on how the weight setting is applied. In RMSD it is applied inside the property calculation before the application of the root.
  • Keeping the weight setting would mean doing similar things for other calculations or we'd have to have RMSD as some special case which will be confusing for users.

I've also changed the result name from rmsd_total to rmsd_all to make it clear that rmsd_all is not the sum of the atom rmsds.

Fixes
Closes #381

To test
The weight setting on the RMSD job should be removed. Run RMSD and check the results, this should be the same as the results calculated on the protos branch with equal weight setting.

@ChiCheng45 ChiCheng45 marked this pull request as draft April 18, 2024 10:28
@ChiCheng45 ChiCheng45 marked this pull request as ready for review April 18, 2024 11:03
Copy link
Collaborator

@MBartkowiakSTFC MBartkowiakSTFC left a comment

Choose a reason for hiding this comment

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

I compared the protos branch results to this branch. Everything worked as expected.

Also, thank you for correcting the documentation.

@MBartkowiakSTFC MBartkowiakSTFC merged commit cd0a131 into protos Apr 18, 2024
84 checks passed
@MBartkowiakSTFC MBartkowiakSTFC deleted the chi/rmsd-remove-weighting branch April 18, 2024 12:42
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.

RootMeanSquareDeviation weight setting and documentation
2 participants