Fix EDAX binary reader and prepare for 0.8.6 patch release - Githubissues

pyxem / kikuchipy

Toolbox for analysis of electron backscatter diffraction (EBSD) patterns

https://kikuchipy.org

GNU General Public License v3.0

78 stars 30 forks source link

Fix EDAX binary reader and prepare for 0.8.6 patch release #641

Closed hakonanes closed 1 year ago

hakonanes commented 1 year ago

Description of the change

Fixes:

A bug where patterns from an EDAX binary .up1 file appears shifted horizontally. This was because of an incorrect offset for the pattern starts.
Allow reading of EBSD patterns from H5OINA files without explicit information about the camera binning factor.

Other changes:

Use numpy.memmap() instead of numpy.fromfile() for non-lazy reading of patterns from EDAX binary up1/up2 files. This should reduce memory use when the pattern array is only read and not written to.
List OpenECCI and PyEBSDIndex among related projects.
Add two recent publications using kikuchipy to the list of applications.

Prepare to release these fixes and change as a 0.8.6 patch.

Progress of the PR

[x] Docstrings for all functions
[x] Unit tests with pytest for all lines
[x] Clean code style by running black via pre-commit

For reviewers

[ ] The PR title is short, concise, and will make sense 1 year later.
[ ] New functions are imported in corresponding __init__.py.
[ ] New features, API changes, and deprecations are mentioned in the unreleased section in CHANGELOG.rst.
[ ] New contributors are added to release.py, .zenodo.json and .all-contributorsrc with the table regenerated.

hakonanes commented 1 year ago

I plan to merge and release the 0.8.6 patch tomorrow Monday 29th.