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

Add test master pattern to data module, IO notebook replace reST in user guide #237

Merged
merged 9 commits into from
Oct 30, 2020

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented Oct 24, 2020

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

Description of the change

  • Continue migrating from reST to Jupyter notebooks in the user guide, this time the IO user guide page.
  • Add 401x401 uint8 nickel master pattern at 20 keV beam energy in a modified version of EMsoft's EBSD master pattern file format returned by their EMMCOpenCL and EMEBSDmaster Fortran programs. The modifications are as follows:
    • Lambert and spherical projection intensities are rescaled from float32 to uint8 with kikuchipy.signals.EBSDMasterPattern.rescale_intensity()
    • A new HDF5 file is created with all groups and datasets of the original EMsoft HDF5 master pattern file, but with the projection datasets as uint8.
    • All datasets are written to the HDF5 file with kikuchipy.io.plugins.h5ebsd.dict2h5ebsdgroup compressed with gzip with compression_opts=9 (highest compression?).

Progress of the PR

Minimal example of the bug fix or new feature

>>> import kikuchipy as kp
>>> smp = kp.data.nickel_master_pattern(projection="lambert", hemisphere="both")
>>> smp
<EBSDMasterPattern, title: , (2|401, 401)>

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 self-assigned this Oct 25, 2020
@hakonanes hakonanes added documentation This relates to the documentation maintenance This relates to package maintenance enhancement New feature or request labels Oct 25, 2020
@hakonanes hakonanes added this to the v0.3.0 milestone Oct 25, 2020
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes
Copy link
Member Author

hakonanes commented Oct 25, 2020

For some reason Readthedocs cannot push an update to this PR telling GitHub that the docs were built successfully as a check: https://kikuchipy--237.org.readthedocs.build/en/237/.

Edit: this now seems to work as expected.

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 October 30, 2020 15:27
@hakonanes hakonanes merged commit 40d9381 into pyxem:master Oct 30, 2020
@hakonanes hakonanes deleted the io-userguide-to-notebook branch October 30, 2020 15:37
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 enhancement New feature or request maintenance This relates to package maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant