Kikuchipy

===================

Added
-----
- Reading of unprocessed patterns from H5OINA files is now possible.
(`701 <https://github.com/pyxem/kikuchipy/pull/701>`_)

Fixed
-----
- Reading of Oxford binary `*.ebsp` files with version 6.
(`700 <https://github.com/pyxem/kikuchipy/pull/700>`_)
- Unnecessary reading of unprocessed patterns from H5OINA files into the EBSD original
metadata. (`701 <https://github.com/pyxem/kikuchipy/pull/701>`_)

===================

Added
-----
- HyperSpy 2.0 compatibility. (`695 <https://github.com/pyxem/kikuchipy/pull/695>`_)
- Dependency on RosettaSciIO for read/write of HyperSpy's HDF5 and zarr files.
(`694 <https://github.com/pyxem/kikuchipy/pull/694>`_)

Changed
-------
- Minimum Python version is now 3.10.
(`689 <https://github.com/pyxem/kikuchipy/pull/689>`_)
- Minimum HyperSpy version is now 2.2.
(`695 <https://github.com/pyxem/kikuchipy/pull/695>`_)
- Markers returned from geometrical simulations and the virtual backscatter electron
imager use the new HyperSpy 2.0 markers.
(`695 <https://github.com/pyxem/kikuchipy/pull/695>`_)
- Progressbar when calculating kinematical master pattern shows progress per pole.

Removed
-------
- Contrasting background bounding box for zone axes labels returned as HyperSpy
markers. They are not supported by HyperSpy 2.0.
(`695 <https://github.com/pyxem/kikuchipy/pull/695>`_)

===================

Changed
-------
- Minimum Python version is now 3.8.
(`674 <https://github.com/pyxem/kikuchipy/pull/674>`_)
- Minimum NumPy version is now 1.23.0.
(`674 <https://github.com/pyxem/kikuchipy/pull/674>`_)
- Minimum Numba version is now 0.57.0.
(`674 <https://github.com/pyxem/kikuchipy/pull/674>`_)
- Minimum scikit-image version is now 0.22.0.
(`674 <https://github.com/pyxem/kikuchipy/pull/674>`_)
- Upon creation of an ``EBSDDetector``, the following attributes are forced to be
floats: sample tilt, tilt, azimuthal angle, binning, pixel size, and the projection
centers (PCs). (`677 <https://github.com/pyxem/kikuchipy/pull/677>`_)
- Simpler string representation of an ``EBSDDetector``, also showing the sample tilt.
(`677 <https://github.com/pyxem/kikuchipy/pull/677>`_)
- Exclude PyEBSDIndex versions 0.3.0 and 0.3.1 since these versions cannot perform Hough
indexing with Dask arrays. This was previously unintentionally supported due to a
side-effect. It should now be supported going forward.
(`678 <https://github.com/pyxem/kikuchipy/pull/678>`_)

Fixed
-----
- The order of the new shape of the detector of a downsampled EBSD signal, returned from
``downsample()``, was previously previously incorrect, (n columns, n rows). This is
now correct, (n rows, n columns).
(`674 <https://github.com/pyxem/kikuchipy/pull/674>`_)

==================

Added
-----
- Explicit support for Python 3.11.
(`646 <https://github.com/pyxem/kikuchipy/pull/646>`_)
- Allow Hough indexing of all Laue groups with PyEBSDIndex v0.2 (not just *m-3m*, i.e.
FCC and BCC). (`652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
- Control of reflector lists in Hough indexing. One reflector list per phase in the
phase list can be passed to ``EBSDDetector.get_indexer()`` to obtain an
``EBSDIndexer`` for use in ``EBSD.hough_indexing()``.
(`652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
- Allow passing keyword arguments to ``EBSD.hough_indexing_optimize_pc()`` to control
the new particle swarm optimization algorithm in PyEBSDIndex v0.2.
(`652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
- Allow getting one projection center (PC) per pattern when optimizing PCs using the new
particle swarm optimization in PyEBSDIndex v0.2 (passing ``batch=True``).
(`652 <https://github.com/pyxem/kikuchipy/pull/652>`_)

Changed
-------
- Parameter ``zone_axes_kwargs`` in
``GeometricalKikuchiPatternSimulation.as_collections()`` does not accept ``color``
internally to set the default color to white anymore. It accepts ``fc`` (facecolor)
instead. This change was necessary to improve handling of other keyword arguments.
(`643 <https://github.com/pyxem/kikuchipy/pull/643>`_)
- Increase minimal versions of diffsims, NumPy, Matplotlib, and PyEBSDIndex to 0.5.1,
1.21.6, 3.5, and 0.2, respectively.
(`646 <https://github.com/pyxem/kikuchipy/pull/646>`_,
`652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
- Remove dependency on Panel for documentation, and with that the interactive 3D
visualization of master patterns in the documentation. The plan is to reintroduce the
interactive plots with trame later on.
(`652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
- Restrict HyperSpy to below the forthcoming version 2. The plan is to remove this
restriction once kikuchipy is compatible with this version.
(`657 <https://github.com/pyxem/kikuchipy/pull/657>`_)

Removed
-------
- ``generators`` and ``projections`` modules which were deprecated in version 0.8.
(`612 <https://github.com/pyxem/kikuchipy/pull/612>`_)
- The deprecated PyPI selector ``viz`` is removed.
(`643 <https://github.com/pyxem/kikuchipy/pull/643>`_)
- The data module functions ``silicon_ebsd_moving_screen_x()``, where "x" is "in",
"out5mm" or "out10mm". They were deprecated in version 0.8.
(`656 <https://github.com/pyxem/kikuchipy/pull/656>`_)

Fixed
-----
- Conversion from EDAX TSL projection center (PC) convention for (PCy, PCz) for
rectangular detectors is corrected.
(`652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
- Downloading files in the ``data`` module to the local cache on Windows.
(`655 <https://github.com/pyxem/kikuchipy/pull/655>`_)

==================

Fixed
-----
- Passing a 3-component PC array with more than one dimension to
``EBSD.hough_indexing_optimize_pc()`` works.
(`647 <https://github.com/pyxem/kikuchipy/pull/647>`_)

==================

Changed
-------
- Use memory mapping (``numpy.memmap()``) instead of reading into memory
(``numpy.fromfile()``) for non-lazy reading of EBSD patterns from EDAX binary .up1/2
files. (`641 <https://github.com/pyxem/kikuchipy/pull/641>`_)

Fixed
-----
- EBSD patterns from some EDAX binary .up1/2 files were incorrectly read due to an
incorrect file offset, making the patterns appear shifted horizontally.
(`641 <https://github.com/pyxem/kikuchipy/pull/641>`_)
- Reading of EBSD patterns from H5OINA files with the "Camera Binning Mode" dataset not
containing the detector binning.
(`641 <https://github.com/pyxem/kikuchipy/pull/641>`_)