Pyxem

===========================

Added
-----
- Faster rotation indexing, using in plane speeds up, added as AcceleratedIndexationGenerator (673)
- get_direct_beam_position now supports lazy processing (648)
- center_direct_beam now supports lazy processing (658)
- Several functions for processing large datasets using dask (648, 658)
- Methods to retrieve phase from DPC signal are added (662)
- Add VirtualImageGenerator.set_ROI_mesh method to set mesh of CircleROI (700)
- Added a setup.cfg

Changed
-------
- The importing of pyxem objects has been standardized (704)
- get_direct_beam_position now has reversed order of the shifts [y, x] to [x, y] (653)
- .apply_affine_transform now uses a default order of 1 (changed from 3)
- find_peaks is now provided by hyperspy, method 'xc' now called 'template_matching'
- virtual_annular_dark_field and virtual_bright_field renamed; now have a `lazy\_` prefixing (698)
- Plotting large, lazy, datasets will be much faster now (655)
- Calibration workflow has been altered (see PR 640 for details)
- Azimuthal integration has been refactored (see PRs 625,676 for details)

Removed
-------
- Diffraction2D.remove_dead_pixels has been removed, use .correct_bad_pixels (681)
- Diffraction2D.remove_background, has been moved to .subtract_diffraction_background (697)
- The diffraction_component and scalable_reference_pattern modules have been removed (674)
- local_gaussian_method for subpixel refinement has been removed
- utils.plot removed, functionality now in signals.diffraction_vectors
- utils.subpixelrefinement_utils removed, functionality in subpxielrefinement_generator
- utils.dpc_tools removed, either downstreamed to diffsims or up to differential_phase_contrast.py
- utils.diffraction_tools removed, downstreamed to diffsims
- utils.sim_utils removed, instead use the relevant diffsims functionality
- utils.calibration_utils removed, downstreamed to diffsims

===========================

Changed
-------
- CI is now provided by github actions
- Code now depends on hyperspy==1.6.1 and skimage>=0.17.0

===========================

Added
-----
- This project now keeps a Changelog

Changed
-------
- Slow tests now don't run by default
- Depend only on hyperspy-base and pyfai-base


How to make a new release of pyxem
==================================

pyxem versioning tries its best to adhere to `Semantic Versioning
<https://semver.org/spec/v2.0.0.html>`__.
See the `Python Enhancement Proposal (PEP) 440 <https://peps.python.org/pep-0440/>`__
for supported version identifiers.

Preparation
-----------
- Locally, create release branch from the ``main`` branch.

- Run tutorial notebooks and examples in the documentation locally and confirm that they
produce the expected results.
From time to time, check the documentation links (``make linkchecker``) and fix any
broken ones.

- Review the contributor list ``credits`` in ``pyxem/release_info.py`` to ensure all
contributors are included and sorted correctly.
Do the same for the Zenodo contributors file ``.zenodo.json``.

- Increment the version number in ``pyxem/release_info.py``.
Review and clean up ``CHANGELOG.rst`` as per Keep a Changelog.

- Make a PR of the release branch to ``main``.
Discuss the changelog with others, and make any changes *directly* to the release
branch.
Merge the branch into ``main``.

Tag and release
---------------
- Make a tagged release on GitHub.
The tag target is the ``main`` branch.
If ``version`` is now "0.16.0", the release name is "pyxem 0.16.0".
The tag name is "v0.16.0".
The release body should contain a description of what has changed and a link to the
changelog.

- Monitor the publish workflow to ensure the release is successfully uploaded to PyPI.
If the upload fails, the upload workflow can be re-run.

Post-release action
-------------------
- Monitor the `documentation build <https://readthedocs.org/projects/pyxem/builds>`__
to ensure that the new stable documentation is successfully built from the release.

- Ensure that `Zenodo <https://doi.org/10.5281/zenodo.2649351>`__ displays the new
release.

- Make a new PR to ``main``, update ``version`` in ``pyxem/release_info.py`` and make
any updates to this guide if necessary.

- Tidy up GitHub issues and close the corresponding milestone.

- A PR to the conda-forge feedstock will be created by the conda-forge bot.
Follow the relevant instructions from the conda-forge documentation on updating
packages, as well as the instructions in the PR.
Merge after checks pass.
Monitor the Azure pipeline CI to ensure the release is successfully published to
conda-forge.

- Update the version switcher in ``doc/_static/switcher.json`` to include the new
build for the documentation.