pyxem/kikuchipy: kikuchipy 0.5.0

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

The most notable addition to this release is the possibility to refine EBSD orientations and/or projection/pattern center (PC) coordinates using SciPy's optimization algorithms. Also, the time to generate a dictionary of simulated EBSD patterns from a master pattern has been reduced substantially. A signal/detector mask can be used with dictionary indexing, and memory usage can be controlled somewhat by setting some parameters.

Some previously deprecated functionality has been removed, and some existing functionality has been deprecated to be removed in the future. Note that some functionality has also been changed in this release without a previous warning.

All updates from the previous release are listed below.

• Eric Prestat
• Håkon Wiik Ånes
• Lars Andreas Hastad Lervik

• Possibility to specify whether to rechunk experimental and simulated data sets and which data type to use for dictionary indexing. (#419)
• How to use the new orientation and/or projection center refinements to the pattern matching notebook. (#405)
• Notebooks to the documentation as shorter or longer "Examples" that don't fit in the user guide. (#403)
• Refinement module for EBSD refinement. Allows for the refinement of orientations and/or projection center estimates. (#387)

• If a custom metric is to be used for dictionary indexing, it must now be a class inheriting from an abstract SimilarityMetric class. This replaces the previous SimilarityMetric class and the make_similarity_metric() function. (#419)
• Dictionary indexing parameter n_slices to n_per_iteration. (#419)
• merge_crystal_maps parameter metric to greater_is_better. (#419)
• orientation_similarity_map parameter normalized is by default False. (#419)
• Dependency versions for dask >= 2021.8.1, fixing some memory issues encountered after 2021.3.1, and HyperSpy >= 1.6.4. Remove importlib_metadata from package dependencies. (#418)
• Performance improvements to EBSD dictionary generation, giving a substantial speed-up. (#405)
• Rename projection methods from project()/iproject() to vector2xy()/xy2vector(). (#405)
• URLs of user guide topics have an extra "/user_guide/<topic>" added to them. (#403)

• Custom EBSD metadata, meaning the Acquisition_instrument.SEM.EBSD.Detector and Sample.Phases nodes, as well as the EBSD set_experimental_parameters() and set_phase_parameters() methods. This will be removed in v0.6 The static_background metadata array will become available as an EBSD property. (#428)

• make_similarity_metric() function is replaced by the need to create a class inheriting from a new abstract SimilarityMetric class, which provides more freedom over preparations of arrays before dictionary indexing. (#419)
• EBSD.match_patterns() is removed, use EBSD.dictionary_indexing() instead. (#419)
• kikuchipy.pattern.correlate module. (#419)

• Allow static background in EBSD metadata to be a Dask array. (#413)
• Set newest supported version of Sphinx to 4.0.2 so that nbsphinx works. (#403)