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

Reader for Oxford Instruments master pattern #706

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented Dec 1, 2024

Description of the change

Implements #705, a reader for master patterns in *.sdf5 files created with Oxford Instruments MapSweeper.

Progress of the PR

  • Docstrings for all functions
  • Unit tests with pytest for all lines
  • Clean code style by running black via pre-commit
  • Complete tests
  • Address problem of different alignments of crystal axes to Cartesian coordinates (orix.crystal_map.Phase assumes x||a and z||c*, but OI uses x||a* anc z||c, for hexagonal at least; this point means the PR may take a while..., as it requires changes in orix).

Minimal example of the bug fix or new feature

Can read dynamical, two-beam, or kinematic simulations from the file

>>> import kikuchipy as kp
>>> s = kp.load("data.sdf5", hemisphere="upper", simulation="dynamical")
>>> s
<EBSDMasterPattern, title: data, dimensions: (|1001, 1001)>

For reviewers

  • The PR title is short, concise, and will make sense 1 year later.
  • New functions are imported in corresponding __init__.py.
  • New features, API changes, and deprecations are mentioned in the unreleased
    section in CHANGELOG.rst.
  • New contributors are added to kikuchipy/__init__.py and .zenodo.json.

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added the enhancement New feature or request label Dec 1, 2024
@hakonanes hakonanes added this to the v0.12.0 milestone Dec 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant