Skip to content

Deprecate map_into_symmetry_reduced_zone() in favor of reduce()#590

Merged
argerlt merged 11 commits intopyxem:developfrom
argerlt:Rename-map_to_symmetry_reduced_zone-to-reduce
Sep 29, 2025
Merged

Deprecate map_into_symmetry_reduced_zone() in favor of reduce()#590
argerlt merged 11 commits intopyxem:developfrom
argerlt:Rename-map_to_symmetry_reduced_zone-to-reduce

Conversation

@argerlt
Copy link
Copy Markdown
Collaborator

@argerlt argerlt commented Sep 22, 2025

Description of the change

#558 was having a bad case of scope creep, so I'm breaking it up into some concise additions.

Additionally, some recent folder renaming and style changes meant a rebase made fore a confusing commit history.

This PR just depreciated map_into_symmetry_reduced_zone to reduce. Some clarifying code comments
were added, but other than that functionality is identical to before.

Progress of the PR

Minimal example of the bug fix or new feature

>>> from orix.quaternion.symmetry import C4, C2
>>> data = np.array([[0.5, 0.5, 0.5, 0.5], [0, 1, 0, 0]])
>>> M = Misorientation(data)
>>> M.symmetry = (C4, C2)```

Before:
>>> M.map_into_symmetry_reduced_zone()

After:
>>> M.reduce()

For reviewers

  • The PR title is short, concise, and will make sense 1 year later.
  • [n/a] New functions are imported in corresponding __init__.py.
  • New features, API changes, and deprecations are mentioned in the unreleased
    section in CHANGELOG.rst.
  • Contributor(s) are listed correctly in __credits__ in orix/__init__.py and in
    .zenodo.json.

@review-notebook-app
Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@argerlt argerlt added the status: needs-review This pull request needs a maintainer's review label Sep 23, 2025
@hakonanes hakonanes changed the title Changing map_into_symmetry_reduced_zone() to reduce() Deprecate map_into_symmetry_reduced_zone() in favor of reduce() Sep 28, 2025
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
…ne()

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
…zy loading was introduced

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Copy link
Copy Markdown
Member

@hakonanes hakonanes 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 making this PR!

I added a few extra internal improvements. I'd appreciate it if you could glance over them before merging.

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added this to the v0.14.0 milestone Sep 28, 2025
@hakonanes hakonanes added deprecation Deprecated functionality and/or names bug Something isn't working and removed status: needs-review This pull request needs a maintainer's review labels Sep 28, 2025
@argerlt argerlt merged commit e048564 into pyxem:develop Sep 29, 2025
11 checks passed
@argerlt argerlt deleted the Rename-map_to_symmetry_reduced_zone-to-reduce branch October 22, 2025 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working deprecation Deprecated functionality and/or names

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants