Published May 24, 2026 | Version v0.12.0
Software Open

pyxem/kikuchipy: kikuchipy 0.12.0

  • 1. Norwegian University of Science and Technology
  • 2. Leibniz Institute for Solid State and Materials Research Dresden (ROR: https://ror.org/04zb59n70)
  • 3. National Institute of Standards and Technology
  • 4. Monash Centre for Electron Microscopy
  • 5. University of Wisconsin Madison
  • 6. Empa

Description

kikuchipy is an open-source Python library for processing, simulating and indexing of electron backscatter diffraction (EBSD) patterns.

See below, the changelog or the GitHub changelog for all updates from the previous release.

Added

  • Download from conda-forge of kikuchipy-base without optional dependencies.
  • Can now read simulated master patterns from EMsoft's EMEBSDmasterOpenCL.f90 program. (#730)
  • Added error handling for setting various properties of the EBSDDetector. (#785)
  • Dependency on typing-extensions for type hints only available from Python >= 3.11. (#785)
  • Optional dependency on ipywidgets and IPython for IPython widgets. (#792)
  • Optional dependency on psygnal to allow triggering actions based on state changes. (#792)
  • A mutable EBSDDetector.twist attribute which represents the angle about the detector normal, pointing towards the sample, in degrees. A positive angle means features on the detector appear to move counter-clockwise about the detector center (assuming all other defaults). (#792)
  • Two new EBSDDetector plot methods for plotting a side view and top view of the detector-sample geometry (non-interactive).
  • An EBSDDetectorPlotter for an interactive plot of the detector-sample geometry, showing the side and top views as well as the detector plane. Additionally, a geometrical and/or kinematical/dynamical simulation can be projected onto the detector plane. (#792)
  • Two new EBSDDetector methods to convert between detector pixel and gnomonic coordinates. (#793)
  • Explicit support for Python 3.13 and 3.14.

Changed

  • Made the string representation of the EBSDDetector more informative. (#785)
  • Styling of the projection center (PC) in EBSD detector plot changed to a white filled circle with a black cross overlayed. The only PC keyword arguments used when given in a dictionary to a plot method is the size ("s") and the z-order ("zorder"). (#792)
  • Detector coordinate parameter "detector" to "pixel" in EBSDDetector.plot(). (#793)

Fixed

  • Removed possibility for a silent out-of-bounds array indexing with Numba when projecting a single pattern from a master pattern in the Lambert projection to the detector. (#718)
  • Getting Matplotlib collections of zone axes and zone axes labels in geometrical EBSD simulations with a 2D navigation shape. (#720)

Deprecated

  • Option to pass EBSDDetector(..., convention=None) has been deprecated and will emit a warning. To avoid the warning, use the default value convention="bruker" instead. The warning will change to an error in version 0.14. (#785)
  • Detector coordinate parameter "detector", replaced with "pixel" in EBSDDetector.plot(). Passing "detector" after 0.13.0 is released will throw an error. (#793)

Files

pyxem/kikuchipy-v0.12.0.zip

Files (21.2 MB)

Name Size Download all
md5:fc51cd9b62615ead460fdcb0df03c3f9
21.2 MB Preview Download

Additional details

Related works

Is supplement to
Software: https://github.com/pyxem/kikuchipy/tree/v0.12.0 (URL)

Software