What's left before a minor release v0.3 late 2020

[hakonanes]

List of issues and PRs that I think should be concluded before we release v0.3:

• Before all else: Replace Travis CI with GitHub Actions to run CI builds #248
• pattern matching
  • Pattern Matching: Compare experimental with simulated data #233
  • Static pattern matching framework, orientation similarity map and crystal map merging #234
• Detector Pattern Simulation #239 Sampling of master patterns
• Add xmap to EBSD signal with crystal orientations as returned by orix after EBSDMasterPattern.get_patterns()
• Remove master pattern metadata, add projection, hemisphere and phase attributes #246 Remove setting of master pattern metadata parameters, replace by EBSDMasterPattern class properties
• improve and streamline use of the EBSD.xmap attribute This takes a lot of work, see EBSD.xmap property needs vast improvements #227, will leave for v0.4 and later.
• improve and streamline use of the EBSD.detector attribute This is more work than anticipated, see Rethinking the EBSD.detector attribute #277, will leave for v0.4 or v0.3.1.
• notebook examples included in documentation with nbsphinx (should preferably replace user guide)
  • Add test master pattern to data module, IO notebook replace reST in user guide #237 io
  • Use nbsphinx and Jupyter notebooks as user guide instead of .rst files + data module #236 pattern processing
  • Replace reST user guide with Jupyter Notebook for image quality guide, remove unused images #244 feature maps
  • Virtual backscatter electron imaging RST to notebook #279 virtual backscatter electron imaging
  • Geometrical EBSD simulation notebook #281 geometrical EBSD simulations (+ visualization)
  • Add test/notebook for matching projected to experimental patterns #263 master pattern sampling (very simple, not in detail, we need a more thorough notebook later)
  • Add test/notebook for matching projected to experimental patterns #263 pattern matching (very simple, not in detail, we need a more thorough notebook later)
  • Replace change scan/pattern size user guide with notebook #247 change scan/pattern size (slicing with inav/isig)
  • Add external 13 MB Ni EBSD dataset to module, pooch/tqdm dependencies #243 visualizing patterns
  • Use Sphinx gallery for simple, focused example uses #238 sphinx-gallery from notebooks
• Fix IndexError in average_neighbour_patterns() for LazyEBSD #230
• Merge Average dot product, neighbour dot product matrices, map helper, rework averaging #280
• Release candidate
• Release

I hope we can get this ready for late November early January.

@friedkitteh and @onatlandsmyr, please add or change any tasks if necessary.

[hakonanes]

Great work, @friedkitteh and @onatlandsmyr!

Now that both the static pattern matching and sampling of simulated patterns from the master pattern are in, I see that there are mostly changes to the user guide and improvements to the EBSD class metadata/property handling left. My plan is to work on the notebook user guides with a workflow I would like to use, and make changes when I encounter something that doesn't work quite as desired.

I'm confident we will get this out in a (really awesome) v0.3 release early-to-mid december.

[hakonanes]

Due to #251, I propose we try to release v0.3 this month, and rather release some patches, since with HyperSpy 1.6.1, the kikuchipy.io._io.save() method is broken (fix in #250).

[hakonanes]

The goal is to include the two current PRs and then release a release candidate as diffsims and pyxem has done lately.

[pc494]

Just as a note.

I didn't find release candidates that useful generally (conda doesn't acknowledge them). The diffsims one was primarily so that I had a fixed commit to build pyxem on top of, and the pyxem one for building the demos unrelated to new functionality. Given the structure of kikuchipy you might I would just release it once you're happy with it.

[hakonanes]

Thanks for the note. It's seven months since the last release, so I just want to be sure everything goes as planned.

[pc494]

Thanks for the note. It's seven months since the last release, so I just want to be sure everything goes as planned.

Makes sense, (that was why I built a couple for orix a while back, but most of my problems tended to be at the conda stage)

[hakonanes]

The release candidate is available here https://pypi.org/project/kikuchipy/0.3.0rc1/ as

> conda create -n kp-0.3.0rc1 python=3.8
> conda activate kp-0.3.0rc1
> pip install kikuchipy[dev]==0.3.0rc1
> pytest --pyargs kikuchipy

[hakonanes]

Will publish the v0.3.0 release tag tomorrow morning.

[hakonanes]

v0.3.0 is now available via PyPI 🎉! In a couple of hours, it should be available via conda-forge as well.

[hakonanes]

The conda-forge feedstock was just updated, v0.3.1 should be available via conda shortly.