pyxem / orix

Analysing crystal orientations and symmetry in Python
https://orix.readthedocs.io
GNU General Public License v3.0
80 stars 48 forks source link

Add row and column indices of points in 2D CrystalMap #402

Closed hakonanes closed 1 year ago

hakonanes commented 1 year ago

Description of the change

Add row and column attributes to CrystalMap to keep track of map point indices. This was necessary to clearly demonstrate indexing/slicing of crystal maps in a new example (see docs built from this PR).

All other changes are related to silencing of many warnings in the tests, some type hints, and removal of setting of parameters with the default values (unnecessary).

Progress of the PR

Minimal example of the bug fix or new feature

See example in the docs built from this PR.

For reviewers

hakonanes commented 1 year ago

@anderscmathisen, I've updated the contributing guide informing that calls like pip install -e .[doc] must be replaced by pip install -e '.[doc]' with zsh shells (Apple's replacement of good ol' bash in newer OS'). Thank you for reporting this issue (in person)!

hakonanes commented 1 year ago

Thanks a lot for reviewing, @harripj!