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

Replace reST with Jupyter Notebook for visualizing signal guide #245

Merged
merged 15 commits into from
Dec 21, 2020

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented Nov 4, 2020

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

Description of the change

  • Replace reStructuredText file with Jupyter notebook for the signal visualization user guide
  • Remove some images from the documentation (generated in the notebook by readthedocs)

Progress of the PR

  • Docstrings for all functions
  • Unit tests with pytest for all lines
  • Clean style in as per black
  • Find a nice colour image to turn into navigator for the kikuchipy.data.nickel_ebsd_large() dataset (orientation map? RGB orientation map?)
  • Decide whether to use a GIF to show multiple scan plotting, or just a static inline plot. Further, include simulated patterns from EMsoft, or just the orientations and wait for Detector Pattern Simulation #239 and get the dictionary of simulated patterns ourselves?
  • Changelog entry

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.

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added the documentation This relates to the documentation label Nov 4, 2020
@hakonanes hakonanes added this to the v0.3.0 milestone Nov 4, 2020
@hakonanes hakonanes self-assigned this Nov 4, 2020
@hakonanes hakonanes marked this pull request as draft November 4, 2020 11:17
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 hakonanes marked this pull request as ready for review December 21, 2020 09:26
@hakonanes hakonanes merged commit 6928f51 into pyxem:master Dec 21, 2020
@hakonanes hakonanes deleted the user-guide-notebook-visualization branch December 21, 2020 09:26
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.

1 participant