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 large experimental datasets and master patterns to data module #584

Merged
merged 12 commits into from
Jan 3, 2023

Conversation

hakonanes
Copy link
Member

Description of the change

This PR adds five datasets to the data module, which will be used in coming documentation of new functionality in follow-up PRs:

  • si_wafer(): (50, 50) patterns of (480, 480) pixel, available for download from Zenodo at https://zenodo.org/record/7491388. About 500 MB.
  • ni_gain0(): (149, 200) patterns of (60, 60) pixels, available for download from Zenodo at https://zenodo.org/record/7498632. The existing experimental Ni datasets in the package are extracted from this dataset. About 110 MB.
  • ni_gain0_calibration(): Nine calibration patterns of (480, 480) pixels acquired with the above dataset (available from the same Zenodo repository).
  • ni_ebsd_master_pattern(): Full (1001, 1001) pixel resolution dynamical simulation with EMsoft of Ni, energies 5-20 kV. Available for download from Zenodo at https://zenodo.org/record/7498645. About 310 MB.
  • si_ebsd_master_pattern(): Full (1001, 1001) pixel resolution dynamical simulation with EMsoft of Si, energies 5-20 kV. Available for download from Zenodo at https://zenodo.org/record/7498729. About 310 MB.

Other changes:

  • Update year in license headers

Progress of the PR

Minimal example of the bug fix or new feature

>>> import kikuchipy as kp
>>> s = kp.data.ni_ebsd_master_pattern(allow_download=True, hemisphere="both", energy=20)
# Progressbar displayed here if not already downloaded to the local cache
>>> s
<EBSDMasterPattern, title: ni_mc_mp_20kv, dimensions: (2|1001, 1001)>
>>> s.plot(navigator=None)

ni_mp

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, .zenodo.json and
    .all-contributorsrc with the table 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>
@hakonanes hakonanes added the enhancement New feature or request label Jan 3, 2023
@hakonanes hakonanes added this to the v0.8.0 milestone Jan 3, 2023
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes merged commit 76028df into pyxem:develop Jan 3, 2023
@hakonanes hakonanes deleted the add-data-to-module branch January 3, 2023 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant