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.

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

Improve qualitative orientation analysis in user guide #491

Merged
merged 14 commits into from
Jan 1, 2022

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented Dec 25, 2021

Description of the change

  • Improve the qualitative orientation analysis in the pattern matching user guide with newest inverse pole figure (IPF) functionality in orix 0.8.
  • Store cell output in the pattern matching notebook so it doesn't have to be built on the Readthedocs (RTD) server. This is necessary because without storing cell output, the RTD server takes 800 s out of 900 available s to build our docs, which is too close to the limit. All notebooks are tested every Monday morning via a GitHub Action, so it isn't so dangerous that this notebook isn't tested on every (PR) commit.
  • Restrict lowest version of orix to 0.8.
  • Update year in license to 2019-2022
  • Remove unnecessary encoding notice in the first line of Python files

See the docs built from this PR for the user guide changes.

Progress of the PR

  • Docstrings for all functions
  • Unit tests with pytest for all lines
  • Clean code style by running black via pre-commit
  • Complete other minor updates of user guide notebooks
  • Make a convenience function in kikuchipy.draw to create an RGB navigator
  • Prepare changelog for release
  • Bump release version to 0.5.6

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

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added the documentation This relates to the documentation label Dec 25, 2021
@hakonanes hakonanes added this to the v0.5.6 milestone Dec 25, 2021
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Copy link
Member Author

I'll release 0.5.6 tomorrow.

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes merged commit 5311982 into pyxem:main Jan 1, 2022
@hakonanes hakonanes deleted the improve-user-guide-with-ipf-etc branch January 1, 2022 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This relates to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant