Merge pull request #660 from hakonanes/main-into-develop-post-0.9.0

Main onto develop post 0.9.0

.zenodo.json

@@ -6,7 +6,7 @@
       "affiliation": "Norwegian University of Science and Technology"
     },
     {
-      "name": "Lars Lervik"
+      "name": "Lars Andreas Hastad Lervik"
     },
     {
       "name": "Ole Natlandsmyr"
@@ -19,6 +19,11 @@
     {
       "name": "Eric Prestat"
     },
+    {
+      "name": "Andreas V. Bugten",
+      "orcid": "0000-0003-0311-8584",
+      "affiliation": "Norwegian University of Science and Technology"
+    },
     {
       "name": "Erlend Mikkelsen Østvold",
       "affiliation": "Norwegian University of Science and Technology"
@@ -27,11 +32,6 @@
       "name": "Zhou Xu",
       "affiliation": "Monash Centre for Electron Microscopy"
     },
-    {
-      "name": "Andreas V. Bugten",
-      "orcid": "0000-0003-0311-8584",
-      "affiliation": "Norwegian University of Science and Technology"
-    },
     {
       "name": "Carter Francis",
       "orcid": "0000-0003-2564-1851",

CHANGELOG.rst

@@ -16,48 +16,64 @@ were listed in alphabetical order by first name until version 0.7.0.
 Unreleased
 ==========
 
+Added
+-----
+
+Changed
+-------
+
+Deprecated
+----------
+
+Removed
+-------
+
+Fixed
+-----
+
+0.9.0 (2023-11-03)
+==================
+
 Added
 -----
 - Explicit support for Python 3.11.
   (`#646 <https://github.com/pyxem/kikuchipy/pull/646>`_)
 - Allow Hough indexing of all Laue groups with PyEBSDIndex v0.2 (not just *m-3m*, i.e.
   FCC and BCC). (`#652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
 - Control of reflector lists in Hough indexing. One reflector list per phase in the
-  phase list can be passed to ``EBSDDetector.get_indexer()`` when obtaining the
+  phase list can be passed to ``EBSDDetector.get_indexer()`` to obtain an
   ``EBSDIndexer`` for use in ``EBSD.hough_indexing()``.
   (`#652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
 - Allow passing keyword arguments to ``EBSD.hough_indexing_optimize_pc()`` to control
-  particle swarm optimization (PSO). These are passed on to the new PSO algorithm in
-  PyEBSDIndex v0.2. (`#652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
+  the new particle swarm optimization algorithm in PyEBSDIndex v0.2.
+  (`#652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
 - Allow getting one projection center (PC) per pattern when optimizing PCs using the new
   particle swarm optimization in PyEBSDIndex v0.2 (passing ``batch=True``).
   (`#652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
 
 Changed
 -------
-- ``zone_axes_kwargs`` parameter in
-  ``GeometricalKikuchiPatternSimulation.as_collections()`` does not use ``color``
-  internally to set the default color to white anymore, but uses ``fc`` (facecolor)
+- Parameter ``zone_axes_kwargs`` in
+  ``GeometricalKikuchiPatternSimulation.as_collections()`` does not accept ``color``
+  internally to set the default color to white anymore. It accepts ``fc`` (facecolor)
   instead. This change was necessary to improve handling of other keyword arguments.
   (`#643 <https://github.com/pyxem/kikuchipy/pull/643>`_)
 - Increase minimal versions of diffsims, NumPy, Matplotlib, and PyEBSDIndex to 0.5.1,
   1.21.6, 3.5, and 0.2, respectively.
   (`#646 <https://github.com/pyxem/kikuchipy/pull/646>`_,
   `#652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
-- Remove dependency on panel for documentation, and with that interactive 3D
-  visualization of master patterns in the documentation (the hope is to reintroduce it
-  with trame at some point). (`#652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
+- Remove dependency on Panel for documentation, and with that the interactive 3D
+  visualization of master patterns in the documentation. The plan is to reintroduce the
+  interactive plots with trame later on.
+  (`#652 <https://github.com/pyxem/kikuchipy/pull/652>`_)
 - Restrict HyperSpy to below the forthcoming version 2. The plan is to remove this
   restriction once kikuchipy is compatible with this version.
   (`#657 <https://github.com/pyxem/kikuchipy/pull/657>`_)
 
-Deprecated
-----------
-
 Removed
 -------
-- Removed ``generators`` and ``projections`` modules which were deprecated in version
-  0.8. (`#612 <https://github.com/pyxem/kikuchipy/pull/612>`_)
+- ``generators`` and ``projections`` modules which were deprecated in version 0.8.
+  (`#612 <https://github.com/pyxem/kikuchipy/pull/612>`_)
 - The deprecated PyPI selector ``viz`` is removed.
   (`#643 <https://github.com/pyxem/kikuchipy/pull/643>`_)
 - The data module functions ``silicon_ebsd_moving_screen_x()``, where "x" is "in",

RELEASE.rst

@@ -14,37 +14,37 @@ Preparation
 - Locally, create a minor release branch from the ``develop`` branch when making a minor
   release, or create a patch release branch from the ``main`` branch when making a patch
   release. Ideally, a patch release is published immediately after a bug fix is merged
-  in ``main``. Therefore, it might be best to do the release updates directly on the bug
-  fix branch, so that no separate patch release branch has to be made.
+  on ``main``. Therefore, it might be best to do the release updates directly on the bug
+  fix branch. This way, we do not have to create a separate patch release 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 linkcheck``) and fix any
-  broken ones.
+- Run tutorial notebooks and examples in the documentation locally.
+  Confirm that they produce the expected results.
+  From time to time, check the documentation links (``make linkcheck``).
+  Fix broken links.
 
-- Review the contributor list ``__credits__`` in ``kikuchipy/release.py`` to ensure all
-  contributors are included and sorted correctly.
+- Ensure all contributors are included and sorted correctly by reviewing the contributor
+  list ``__credits__`` in ``kikuchipy/release.py``.
   Do the same for the Zenodo contributors file ``.zenodo.json``.
   Review ``.all-contributorsrc`` and regenerate the table if necessary.
 
 - Increment the version number in ``kikuchipy/release.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
+  Discuss the changelog with others and make any changes *directly* to the release
   branch.
-  Merge the branch into ``main``.
+  Merge the branch onto ``main``.
 
 Tag and release
 ---------------
 - If the ``__version__`` in ``kikuchipy/release.py`` on ``main`` has changed in a new
   commit, a tagged, annotated release *draft* is automatically created.
-  If ``__version__`` is now "0.42.0", the release name is "kikuchipy 0.42.0", and the
+  If ``__version__`` is now "0.42.0", the release name is "kikuchipy 0.42.0" and the
   tag name is "v0.42.0".
   The tag target will be the ``main`` branch.
   The release body contains a static description and a link to the changelog.
-  This release draft can be published as is, or changes to the release body can be made
-  before publishing.
+  This release draft can be published as is.
+  Or, changes to the release body can be made before publishing.
 
 - Monitor the publish workflow to ensure the release is successfully published to PyPI.
 
@@ -56,21 +56,22 @@ Post-release action
 - Ensure that `Zenodo <https://doi.org/10.5281/zenodo.3597646>`__ displays the new
   release.
 
-- Ensure that Binder can run the user guide notebooks by clicking the Binder badges in
-  the top banner of one of the tutorials via `Read The Docs
+- Ensure that Binder can run the tutorial notebooks by clicking the Binder badge in the
+  top banner of one of the tutorials in the `online documentation
   <https://kikuchipy.org/en/stable>`__.
 
-- Bring changes on ``main`` into ``develop`` by branching from ``main``, merge
-  ``develop`` into the new branch and fix potential conflicts.
-  After these conflicts are fixed, update or revert ``__version__`` and make any updates
+- Bring changes on ``main`` onto ``develop`` by branching from ``main``, merging
+  ``develop`` onto the new branch, and fixing potential conflicts.
+  After any conflicts are fixed, update or revert ``__version__`` and make any updates
   to this guide if necessary.
   Make a PR to ``develop`` and merge.
 
 - 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
+- A PR to the conda-forge feedstock will automatically be created by the conda-forge
+  bot.
+  Follow the instructions in the PR and any relevant instructions in the conda-forge
+  documentation on updating packages.
+  Merge the PR after checks pass.
+  Monitor the Azure pipeline CI to ensure that the release is successfully published to
   conda-forge.

kikuchipy/release.py

@@ -27,9 +27,9 @@
     "Ole Natlandsmyr",
     "Tina Bergh",
     "Eric Prestat",
+    "Andreas V. Bugten",
     "Erlend Mikkelsen Østvold",
     "Zhou Xu",
-    "Andreas V. Bugten",
     "Carter Francis",
     "Magnus Nord",
 ]
@@ -39,4 +39,4 @@
 name = "kikuchipy"
 platforms = ["Linux", "MacOS X", "Windows"]
 status = "Development"
-version = "0.9.dev0"
+version = "0.10.dev0"

readthedocs.yaml

@@ -24,7 +24,6 @@ build:
 
 # Build doc in all formats (HTML, PDF and ePub)
 formats:
-  - htmlzip
   - pdf
 
 conda: