Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document EBSD reference frames #215

Merged
merged 13 commits into from
Sep 15, 2020
Merged

Document EBSD reference frames #215

merged 13 commits into from
Sep 15, 2020

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented Sep 10, 2020 •
edited
Loading

Signed-off-by: Håkon Wiik Ånes hwaanes@gmail.com

Description of the change

Closes #208 and #211.

Progress of the PR

  • Docstrings for all functions with examples!
  • Unit tests with pytest for all lines in ebsd_detector.py
  • Clean style in as per black
  • Double check conversions between vendor projection center conventions (Jackson et al. (2019)).
  • Continue on the reference frame part of the documentation, with clear explanations of how to use the EBSDDetector class
  • Add detector stuff to the API

For reviewers

  • Check that the PR title is short, concise, and will make sense 1 year
    later.
  • Check that new functions are imported in corresponding __init__.py.
  • Check that new features, API changes, and deprecations are mentioned in
    the unreleased section in doc/changelog.rst.

@hakonanes
Almost finish testing of EBSDDetector, fix some errors
7c24764 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added the tests This relates to the tests label Sep 10, 2020
@hakonanes hakonanes added this to the v0.3.0 milestone Sep 10, 2020
@hakonanes hakonanes self-assigned this Sep 10, 2020
@hakonanes hakonanes added the documentation This relates to the documentation label Sep 10, 2020
@hakonanes hakonanes changed the title Almost finish testing of EBSDDetector, fix some errors Complete tests of EBSDDetector class, add to API, improve reference frames documentation Sep 10, 2020
@hakonanes
Add simple detector plotting, more correct PC converts. [skip ci]
64de779 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes marked this pull request as draft September 11, 2020 17:33
@hakonanes
More PC conversion tests, should be correct now [skip ci]
c575cc9 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
More edits to EBSD detector [skip ci]
4b9aeb8 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Complete tests of EBSDDetector
c08acc1 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Finish EBSDDetector class docstrings with examples
1216649 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Add examples to EBSDDetector.plot() [skip ci]
58df8d5 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Add detector-sample reference frames
1a048b1 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Update documentation with EBSD reference frames
a7750b6 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes changed the title Complete tests of EBSDDetector class, add to API, improve reference frames documentation Document EBSD reference frames Sep 14, 2020
@hakonanes
Update changelog
c7fa77d 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes marked this pull request as ready for review September 14, 2020 16:44
@hakonanes
Start documenting projection center conversions
f371326 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Complete the EBSD reference frame documentation
3fbab4a 
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Merge branch 'master' of https://github.com/pyxem/kikuchipy into comp…
7222969 
…lete-ebsddetector-tests-documentation

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes merged commit c241438 into pyxem:master Sep 15, 2020
@hakonanes hakonanes deleted the complete-ebsddetector-tests-documentation branch September 15, 2020 18:31
@hakonanes hakonanes mentioned this pull request Sep 15, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@hakonanes hakonanes

Labels
documentation This relates to the documentation tests This relates to the tests
Projects
None yet
Milestone
v0.3.0
Development

Successfully merging this pull request may close these issues.

Complete tests and documentation of the EBSDDetector class
1 participant
@hakonanes