pyxem/kikuchipy: kikuchipy 0.6.0

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

The highlight in this release is a new simulator setup supporting all crystallographic point groups, which is capable of geometrical and kinematical EBSD simulations in the stereographic, Lambert or spherical projections, as well as on the EBSD detector. The new simulator and returned simulation objects replace the existing simulation generator and returned simulation objects, which are deprecated.

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

• Håkon Wiik Ånes

• EBSDMasterPattern.plot_spherical() for plotting a master pattern in the stereographic projection on the 3D sphere. (#536)
• Projection of master pattern in the stereographic projection to the square Lambert projection via EBSDMasterPattern.to_lambert(). (#536)
• New package dependencies on pyvista for 3D plotting and on pythreejs for the docs are introduced. (#536)
• Reduce time and memory use of the following kikuchipy.signals.EBSD methods by using hyperspy.signal.BaseSignal.map(): remove_static_background(), remove_dynamic_background() and get_image_quality(). (#527)
• progressbar parameter to functions downloading external datasets in the data module. (#515)
• Support for Python 3.10. (#504)
• EBSD.static_background property for easier access to the background pattern. (#475)

• Valid EBSDMasterPattern.hemisphere values from "north" and "south" to "upper" and "lower", respectively, to be in line with orix. (#537)
• Increase minimal version of diffsims to 0.5. (#537)
• Chunking of EBSD signal navigation dimensions in EBSD.average_neighbour_patterns() to reduce memory use. (#532)
• Remove requirement that the crystal map used for EBSD refinement has identical step size(s) to the EBSD signal\'s navigation axes. This raised an error previously, but now only emits a warning. (#531)
• Increase minimal version of HyperSpy to 1.7. (#527)
• Increase minimal version of SciPy to 1.7. (#504)

• The kikuchipy.simulations.GeometricalEBSDSimulation class is deprecated and will be removed in version 0.7. Obtain kikuchipy.simulations.GeometricalKikuchiPatternSimulation via kikuchipy.simulations.KikuchiPatternSimulator.on_detector() instead. The kikuchipy.simulations.features module is also deprecated and will be removed in version 0.7. Obtain Kikuchi line and zone axis detector/gnomonic coordinates of a simulation via lines_coordinates() and zone_axes_coordinates() instead. (#537)
• The kikuchipy.generators.EBSDSimulationGenerator class is deprecated and will be removed in version 0.7. Use the kikuchipy.simulations.KikuchiPatternSimulator class instead. (#537)
• The kikuchipy.crystallography.matrices module is depreacted and will be removed in version 0.7, access the matrices via diffpy.structure.Lattice{.interpreted-text role="class"} attributes instead. (#537)
• The following functions for processing of pattern chunks in the kikuchipy.pattern.chunk module are deprecated and will be removed in version 0.7: get_image_quality(), remove_dynamic_background() and remove_static_background(). Use the EBSD class for processing of many patterns. (#527, #533 )

• The relative parameter in kikuchipy.signals.EBSD.remove_static_background(). The parameter is accepted but not used. Passing it after this release will result in an error. (#527)

• Plotting of geometrical simulation markers on rectangular patterns. (#537)
• Hopefully prevent EBSD refinement tests using random data to fail on Azure. (#465)