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

Fix/noncubic diffraction #943

Merged
merged 8 commits into from
Apr 19, 2022
Merged

Fix/noncubic diffraction #943

merged 8 commits into from
Apr 19, 2022

Conversation

tommy-waltmann
Copy link
Collaborator

Description

This PR disables the diffraction calculation for noncubic boxes

Motivation and Context

The diffraction calculation doesn't give correct results if the box is not a cube, and we don't want users getting incorrect results and not realizing it. This is discussed on #940 and is a change that is overdue.

How Has This Been Tested?

Tests have been added which assert that the proper exception is raised.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds or improves functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation improvement (updates to user guides, docstrings, or developer docs)

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • I have updated the documentation (if relevant).
  • I have added tests that cover my changes (if relevant).
  • All new and existing tests passed.
  • I have updated the credits.
  • I have updated the Changelog.

@tommy-waltmann tommy-waltmann requested a review from a team as a code owner April 14, 2022 18:24
@tommy-waltmann tommy-waltmann requested review from b-butler and removed request for a team April 14, 2022 18:24
freud/box.pyx Outdated Show resolved Hide resolved
@tommy-waltmann tommy-waltmann added this to the v2.9.0 milestone Apr 19, 2022
@tommy-waltmann tommy-waltmann merged commit b11763c into master Apr 19, 2022
@tommy-waltmann tommy-waltmann deleted the fix/noncubic-diffraction branch April 19, 2022 17:35
@@ -329,6 +329,7 @@ Tommy Waltmann
* Remove CI build configurations from CircleCI which were already covered by CIBuildWheel.
* Change property names in ``StaticStructureFactorDebye`` class.
* Reformat static structure factor tests.
* ``DiffractionPattern`` now raises an error when used with non-cubic boxes.
Copy link
Collaborator

Choose a reason for hiding this comment

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

It's sort of odd that the names here are not fully qualified like the ones in the Changelog, but I guess that's following the existing pattern so no worries.

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