Skip to content

Introduce Basic Orientational Entropy Calculations#294

Merged
skfegan merged 26 commits intomainfrom
27-orientational-entropy
Mar 13, 2026
Merged

Introduce Basic Orientational Entropy Calculations#294
skfegan merged 26 commits intomainfrom
27-orientational-entropy

Conversation

@skfegan
Copy link
Member

@skfegan skfegan commented Mar 2, 2026

Summary

This pull request adds the basic orientational entropy calculation.

Changes

Adding Neighbours to Levels:

  • Functions for counting the number of neighbours (two methods available - RAD and grid)
  • Function for guessing symmetry number using RDKit structure matching functions
  • Function for identifying linear molecules using RDKit labels of hybridization types for molecules with more than two united atom beads

Orientational Entropy Calculation:

  • Adds the orientational term to the entropy calculation

Conformational Entropy:

  • Fixing a small bug in conformational entropy by removing one equals sign in the identifying of peaks.

Documentation

  • Update to science.rst to describe the orientational entropy calculation
  • Update to conf.rst to include the neighbours search_type option

Impact

  • The orientational entropy term is now included to give a more complete entropy value.
  • The conformational entropy is improved by not identifying extraneous peaks in the histogram.
  • Documentation expanded to cover the orientational entropy theory.

@skfegan skfegan linked an issue Mar 2, 2026 that may be closed by this pull request
@skfegan skfegan requested a review from harryswift01 March 2, 2026 11:11
@skfegan skfegan linked an issue Mar 2, 2026 that may be closed by this pull request
@harryswift01 harryswift01 added this to the v2.1.0 milestone Mar 3, 2026
@harryswift01 harryswift01 changed the title 27 orientational entropy Introduce Basic Orientational Entropy Calculations Mar 3, 2026
Copy link
Member

@harryswift01 harryswift01 left a comment

Choose a reason for hiding this comment

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

This addition to CodeEntropy is a major milestone in bringing new theory into the package, and this PR communicates that work very well. I’ve requested a few changes, but they are mainly focused on tidying up comments and clarifying certain areas. Functionally, this is looking very strong.

Since this introduces new entropy calculations, we should expect the regression test results to change. For that reason, I think it would be appropriate to re-run and update the baseline results to reflect the new calculation method. These can be updated locally with: pytest tests/regression --update-baselines. It also looks like coverage has dropped slightly. It would be great if we could bring that back up before merging.

We’re very close to getting this merged, thank you. If there’s anything I can do to help move this across the line, just let me know.

@skfegan skfegan requested a review from harryswift01 March 13, 2026 09:46
@harryswift01 harryswift01 force-pushed the 27-orientational-entropy branch from 01a9a27 to b98888b Compare March 13, 2026 10:02
Copy link
Member

@harryswift01 harryswift01 left a comment

Choose a reason for hiding this comment

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

This PR now looks complete and, once merged, will allow us to introduce basic orientational entropy calculations into CodeEntropy.

Earlier this morning I kicked off the full set of regression tests on this branch. They are still currently running, but assuming they all come back passing, I can’t see any reason not to merge this.

Thanks for all the work on this.

@skfegan skfegan merged commit 77fcc19 into main Mar 13, 2026
14 of 15 checks passed
@skfegan skfegan deleted the 27-orientational-entropy branch March 13, 2026 14:16
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.

[Bug]: Conformational entropy Orientational Entropy for Molecules Other Than Water

2 participants