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 H5OINA reader and restructure h5ebsd readers #562

Merged
merged 40 commits into from
Aug 25, 2022

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented Aug 23, 2022

Description of the change

  • Add minimal H5OINA reader (Oxford h5ebsd format)
  • Separate h5ebsd plugin into four plugins for the four h5ebsd formats of kikuchipy (reader/writer), EDAX, Bruker Nano and Oxford Instruments (H5OINA)
  • Change the metadata structure returned from all EBSD readers
  • Remove deprecated ebsd_metadata() and metadat_nodes()
  • Remove deprecated EBSD methods set_experimental_parameters() and set_phase_parameters()

Closes: #141, #466, and #559.

Progress of the PR

  • Docstrings for all functions
  • Unit tests with pytest for all lines
  • Clean code style by running black via pre-commit
  • Test H5OINA reader with a dummy dataset
  • Remove custom metadata nodes
  • Remove EBSD methods set_experimental_parameters() and set_phase_parameters()
  • Remove references to deprecations in docs, and generally update them following these changes
  • Add H5OINA plugin to list in docs
  • Update changelog with added h5ebsd plugin, changed h5ebsd plugins, removed functions and methods, and changed metadata structure (returned from most EBSD readers)

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 release.py and .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>
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>
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 added enhancement New feature or request deprecation Deprecated functionality labels Aug 23, 2022
@hakonanes hakonanes added this to the v0.7.0 milestone Aug 23, 2022
@hakonanes hakonanes marked this pull request as draft August 23, 2022 22:05
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>
This was linked to issues Aug 24, 2022
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>
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

@IMBalENce, I'm done with the H5OINA reader for now and intend to merge this after checks pass so that people can start to use it. If you find the reader cannot read some of your data, we can fix this at some later point.

@hakonanes hakonanes marked this pull request as ready for review August 25, 2022 15:24
@hakonanes hakonanes merged commit b467a6b into pyxem:develop Aug 25, 2022
@hakonanes hakonanes deleted the write-read-xmap-kikuchipy-h5ebsd branch August 25, 2022 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation Deprecated functionality enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

H5OINA reader Removing custom EBSD metadata nodes Remove all use of HyperSpy's DictionaryTreeBrowser
1 participant