==================
Contributors
------------
- Eric Prestat
- Håkon Wiik Ånes
- Lars Andreas Hastad Lervik
Added
-----
- Possibility to specify whether to rechunk experimental and simulated data sets and
which data type to use for dictionary indexing.
(`419 <https://github.com/pyxem/kikuchipy/pull/419>`_)
- How to use the new orientation and/or projection center refinements to the pattern
matching notebook. (`405 <https://github.com/pyxem/kikuchipy/pull/405>`_)
- Notebooks to the documentation as shorter or longer "Examples" that don't fit in the
user guide. (`403 <https://github.com/pyxem/kikuchipy/pull/403>`_)
- Refinement module for EBSD refinement. Allows for the refinement of
orientations and/or projection center estimates.
(`387 <https://github.com/pyxem/kikuchipy/pull/387>`_)
Changed
-------
- 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 <https://github.com/pyxem/kikuchipy/pull/419>`_)
- Dictionary indexing parameter *n_slices* to *n_per_iteration*.
(`419 <https://github.com/pyxem/kikuchipy/pull/419>`_)
- *merge_crystal_maps* parameter *metric* to *greater_is_better*.
(`419 <https://github.com/pyxem/kikuchipy/pull/419>`_)
- *orientation_similarity_map* parameter *normalized* is by default False.
(`419 <https://github.com/pyxem/kikuchipy/pull/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 <https://github.com/pyxem/kikuchipy/pull/418>`_)
- Performance improvements to EBSD dictionary generation, giving a substantial speed-up.
(`405 <https://github.com/pyxem/kikuchipy/pull/405>`_)
- Rename projection methods from `project()`/`iproject()` to
`vector2xy()`/`xy2vector()`. (`405 <https://github.com/pyxem/kikuchipy/pull/405>`_)
- URLs of user guide topics have an extra "/user_guide/<topic>" added to them.
(`403 <https://github.com/pyxem/kikuchipy/pull/403>`_)
Deprecated
----------
- 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 <https://github.com/pyxem/kikuchipy/pull/428>`_)
Removed
-------
- *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 <https://github.com/pyxem/kikuchipy/pull/419>`_)
- *EBSD.match_patterns()* is removed, use *EBSD.dictionary_indexing()* instead.
(`419 <https://github.com/pyxem/kikuchipy/pull/419>`_)
- kikuchipy.pattern.correlate module.
(`419 <https://github.com/pyxem/kikuchipy/pull/419>`_)
Fixed
-----
- Allow static background in EBSD metadata to be a Dask array.
(`413 <https://github.com/pyxem/kikuchipy/pull/413>`_)
- Set newest supported version of Sphinx to 4.0.2 so that nbsphinx works.
(`403 <https://github.com/pyxem/kikuchipy/pull/403>`_)