Skip to content

Read dynamical EBSD master patterns from ebsdsim#809

Merged
hakonanes merged 28 commits into
pyxem:developfrom
hakonanes:ebsdsim-mp-reader
Jun 14, 2026
Merged

Read dynamical EBSD master patterns from ebsdsim#809
hakonanes merged 28 commits into
pyxem:developfrom
hakonanes:ebsdsim-mp-reader

Conversation

@hakonanes

@hakonanes hakonanes commented Jun 13, 2026

Copy link
Copy Markdown
Member

Description of the change

This PR adds a reader for dynamical simulations of EBSD master patterns from a NumPy zipped archive (npz) file generated with ebsdsim. It solves #806.

I've opted to license the new reader under the BSD 3-Clause license. The BSD licensed files have no imports from GPL code. I've added notices in the repo README and in a new user guide license page in the docs.

Progress of the PR

Minimal example of the bug fix or new feature

import kikuchipy as kp
import ebsdsim

mp_ebsdsim = ebsdsim.master_pattern_from_cif("Ni.cif")
mp_ebsdsim.save("ni_mp_20kv.h5")

mp = kp.load("ni_mp_20kv.h5")

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.

hakonanes added 12 commits June 13, 2026 15:24
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>
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>
@hakonanes hakonanes added this to the v0.13.0 milestone Jun 13, 2026
@hakonanes hakonanes added the enhancement New feature or request label Jun 13, 2026
@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

hakonanes added 15 commits June 13, 2026 20:24
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>
… GPL/BSD

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>
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>
@hakonanes
hakonanes marked this pull request as ready for review June 14, 2026 11:49
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
hakonanes merged commit b8087e5 into pyxem:develop Jun 14, 2026
9 checks passed
@hakonanes
hakonanes deleted the ebsdsim-mp-reader branch June 14, 2026 12:22
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