Use Hough indexing from PyEBSDIndex in documentation - Githubissues

pyxem / kikuchipy

Toolbox for analysis of electron backscatter diffraction (EBSD) patterns

https://kikuchipy.org

GNU General Public License v3.0

81 stars 30 forks source link

Use Hough indexing from PyEBSDIndex in documentation #555

Closed hakonanes closed 2 years ago

hakonanes commented 2 years ago

Description of the change

This PR adds Hough indexing (FCC/BCC) from PyEBSDIndex to the documentation in the following tutorials:

Reference frames: Confirming the vendor/software PC conventions in kikuchipy and PyEBSDIndex
PC "moving screen" calibration: Optimize PC estimation from the "moving screen" technique, and index Si pattern
New Hough indexing notebook, taking most of the elements from a notebook in my fork
Geometrical EBSD simulations: Finding the detector-sample geometry and indexing the nine nickel patterns

Progress of the PR

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

Minimal example of the bug fix or new feature

See the docs built from this PR.

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 and .all-contributorsrc and the table is regenerated.