Better inform about PC convention used in kikuchipy (Bruker's)

pyxem / kikuchipy

Toolbox for analysis of electron backscatter diffraction (EBSD) patterns

https://kikuchipy.org

GNU General Public License v3.0

80 stars 30 forks source link

Better inform about PC convention used in kikuchipy (Bruker's) #628

Closed Erlendos12 closed 1 year ago

Erlendos12 commented 1 year ago

Inserting "Bruker" into the print statement from Hough indexing to clarify according to https://github.com/pyxem/kikuchipy/discussions/626.

Output looks something like this now:

Hough indexing with PyEBSDIndex information:
  PyOpenCL: True
  Projection center (Bruker): (0.496, 0.342, 0.519)
  Indexing 13299 pattern(s) in 26 chunk(s)
  Indexing speed: 229.76526 patterns/s

For reviewers

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

Erlendos12 commented 1 year ago

@hakonanes Should be ready for your changes and review now.

Erlendos12 commented 1 year ago

FYI, I have not edited the tests however, so I see they fail when trying to assert the print information.

hakonanes commented 1 year ago

Good you got to this, will make my changes this evening, with hopefully a release then or tomorrow. Feel free to update the failing test, seems like the only change needed is to change the string comparison following your change.

hakonanes commented 1 year ago

Have to update some more tutorials (they have cell outputs stored since they take long to run, so have to re-run them when code changes affecting their cell outputs are made) tomorrow, will merge and release then.

hakonanes commented 1 year ago

Done, will merge when checks pass.

Erlendos12 commented 1 year ago

Thanks! Appreciate you doing the necessary changes in such short notice to bring us this clarification.

hakonanes commented 1 year ago

Your feedback in issues and discussions is valuable, so I'm happy to accomodate requests like these. Keep them coming!

Also, the current release workflow (auto release draft when new commits to main contains a change in __version__ in release.py -> auto upload to PyPI when the release draft is published -> auto PR to conda-forge when PyPI updates -> conda-forge release after PR merge) makes bringing changes out quickly very easy to do...

hakonanes commented 1 year ago

Version 0.8.3 is now available from PyPI.

Erlendos12 commented 1 year ago

Your feedback in issues and discussions is valuable, so I'm happy to accomodate requests like these. Keep them coming!

Also, the current release workflow (auto release draft when new commits to main contains a change in __version__ in release.py -> auto upload to PyPI when the release draft is published -> auto PR to conda-forge when PyPI updates -> conda-forge release after PR merge) makes bringing changes out quickly very easy to do...

I see, useful to know!