Merge pull request #624 from hakonanes/main-into-develop-post-0.8.2-r…

…elease Main into develop post 0.8.2 release
pyxem · Mar 14, 2023 · 188b301 · 188b301
2 parents 550c305 + e237eb0
commit 188b301
Show file tree

Hide file tree

Showing 8 changed files with 60 additions and 19 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -88,6 +88,15 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "Erlendos12",
+      "name": "erlenmos",
+      "avatar_url": "https://avatars.githubusercontent.com/u/99336047?v=4",
+      "profile": "https://github.com/Erlendos12",
+      "contributions": [
+        "bug"
+      ]
     }
   ]
 }
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -61,7 +61,7 @@ jobs:
         include:
           - os: ubuntu-latest
             python-version: 3.7
-            DEPENDENCIES: dask==2021.8.1 diffsims==0.5.0 hyperspy==1.7.3 matplotlib==3.3 numba==0.55 numpy==1.19 orix==0.11.0 scikit-image==0.16.2
+            DEPENDENCIES: dask==2021.8.1 diffsims==0.5.0 hyperspy==1.7.3 matplotlib==3.3 numba==0.55 numpy==1.19 orix==0.11.1 scikit-image==0.16.2
             LABEL: -oldest
           - os: ubuntu-latest
             python-version: 3.10

diff --git a/.zenodo.json b/.zenodo.json
@@ -23,6 +23,10 @@
       "name": "Zhou Xu",
       "affiliation": "Monash Centre for Electron Microscopy"
     },
+    {
+      "name": "Erlend Mikkelsen Østvold",
+      "affiliation": "Norwegian University of Science and Technology"
+    },
     {
       "name": "Magnus Nord",
       "orcid": "0000-0001-7981-5293",

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -36,6 +36,14 @@ Fixed
 Security
 --------
 
+0.8.2 (2023-03-14)
+==================
+
+Changed
+-------
+- Set minimal version of orix to >= 0.11.1.
+  (`#623 <https://github.com/pyxem/kikuchipy/pull/623>`_)
+
 0.8.1 (2023-02-20)
 ==================
 

diff --git a/README.md b/README.md
@@ -58,15 +58,20 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
 <table>
-  <tr>
-    <td align="center"><a href="https://github.com/ericpre"><img src="https://avatars.githubusercontent.com/u/11851990?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Eric Prestat</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/commits?author=ericpre" title="Code">💻</a> <a href="#maintenance-ericpre" title="Maintenance">🚧</a></td>
-    <td align="center"><a href="https://www.ntnu.edu/employees/hakon.w.anes"><img src="https://avatars.githubusercontent.com/u/12139781?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Håkon Wiik Ånes</b></sub></a><br /></td>
-    <td align="center"><a href="https://github.com/friedkitteh"><img src="https://avatars.githubusercontent.com/u/11888052?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Lars Lervik</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/issues?q=author%3Afriedkitteh" title="Bug reports">🐛</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=friedkitteh" title="Code">💻</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=friedkitteh" title="Documentation">📖</a> <a href="#question-friedkitteh" title="Answering Questions">💬</a> <a href="https://github.com/pyxem/kikuchipy/pulls?q=is%3Apr+reviewed-by%3Afriedkitteh" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=friedkitteh" title="Tests">⚠️</a></td>
-    <td align="center"><a href="https://www.ntnu.edu/employees/magnus.nord"><img src="https://avatars.githubusercontent.com/u/1690979?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Magnus Nord</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/commits?author=magnunor" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://github.com/onatlandsmyr"><img src="https://avatars.githubusercontent.com/u/34620114?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ole Natlandsmyr</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/commits?author=onatlandsmyr" title="Code">💻</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=onatlandsmyr" title="Documentation">📖</a> <a href="#question-onatlandsmyr" title="Answering Questions">💬</a> <a href="https://github.com/pyxem/kikuchipy/pulls?q=is%3Apr+reviewed-by%3Aonatlandsmyr" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=onatlandsmyr" title="Tests">⚠️</a></td>
-    <td align="center"><a href="https://github.com/tinabe"><img src="https://avatars.githubusercontent.com/u/22915119?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tina Bergh</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/commits?author=tinabe" title="Code">💻</a> <a href="https://github.com/pyxem/kikuchipy/pulls?q=is%3Apr+reviewed-by%3Atinabe" title="Reviewed Pull Requests">👀</a></td>
-    <td align="center"><a href="https://github.com/IMBalENce"><img src="https://avatars.githubusercontent.com/u/2986794?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Zhou Xu</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/issues?q=author%3AIMBalENce" title="Bug reports">🐛</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=IMBalENce" title="Code">💻</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=IMBalENce" title="Documentation">📖</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=IMBalENce" title="Tests">⚠️</a></td>
-  </tr>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ericpre"><img src="https://avatars.githubusercontent.com/u/11851990?v=4?s=100" width="100px;" alt="Eric Prestat"/><br /><sub><b>Eric Prestat</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/commits?author=ericpre" title="Code">💻</a> <a href="#maintenance-ericpre" title="Maintenance">🚧</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.ntnu.edu/employees/hakon.w.anes"><img src="https://avatars.githubusercontent.com/u/12139781?v=4?s=100" width="100px;" alt="Håkon Wiik Ånes"/><br /><sub><b>Håkon Wiik Ånes</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/friedkitteh"><img src="https://avatars.githubusercontent.com/u/11888052?v=4?s=100" width="100px;" alt="Lars Lervik"/><br /><sub><b>Lars Lervik</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/issues?q=author%3Afriedkitteh" title="Bug reports">🐛</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=friedkitteh" title="Code">💻</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=friedkitteh" title="Documentation">📖</a> <a href="#question-friedkitteh" title="Answering Questions">💬</a> <a href="https://github.com/pyxem/kikuchipy/pulls?q=is%3Apr+reviewed-by%3Afriedkitteh" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=friedkitteh" title="Tests">⚠️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.ntnu.edu/employees/magnus.nord"><img src="https://avatars.githubusercontent.com/u/1690979?v=4?s=100" width="100px;" alt="Magnus Nord"/><br /><sub><b>Magnus Nord</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/commits?author=magnunor" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/onatlandsmyr"><img src="https://avatars.githubusercontent.com/u/34620114?v=4?s=100" width="100px;" alt="Ole Natlandsmyr"/><br /><sub><b>Ole Natlandsmyr</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/commits?author=onatlandsmyr" title="Code">💻</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=onatlandsmyr" title="Documentation">📖</a> <a href="#question-onatlandsmyr" title="Answering Questions">💬</a> <a href="https://github.com/pyxem/kikuchipy/pulls?q=is%3Apr+reviewed-by%3Aonatlandsmyr" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=onatlandsmyr" title="Tests">⚠️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/tinabe"><img src="https://avatars.githubusercontent.com/u/22915119?v=4?s=100" width="100px;" alt="Tina Bergh"/><br /><sub><b>Tina Bergh</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/commits?author=tinabe" title="Code">💻</a> <a href="https://github.com/pyxem/kikuchipy/pulls?q=is%3Apr+reviewed-by%3Atinabe" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/IMBalENce"><img src="https://avatars.githubusercontent.com/u/2986794?v=4?s=100" width="100px;" alt="Zhou Xu"/><br /><sub><b>Zhou Xu</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/issues?q=author%3AIMBalENce" title="Bug reports">🐛</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=IMBalENce" title="Code">💻</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=IMBalENce" title="Documentation">📖</a> <a href="https://github.com/pyxem/kikuchipy/commits?author=IMBalENce" title="Tests">⚠️</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Erlendos12"><img src="https://avatars.githubusercontent.com/u/99336047?v=4?s=100" width="100px;" alt="erlenmos"/><br /><sub><b>erlenmos</b></sub></a><br /><a href="https://github.com/pyxem/kikuchipy/issues?q=author%3AErlendos12" title="Bug reports">🐛</a></td>
+    </tr>
+  </tbody>
 </table>
 
 <!-- markdownlint-restore -->

diff --git a/RELEASE.rst b/RELEASE.rst
@@ -4,6 +4,11 @@ How to make a new release of ``kikuchipy``
 kikuchipy's branching model is similar to the Gitflow Workflow (`original blog post
 <https://nvie.com/posts/a-successful-git-branching-model/>`_).
 
+kikuchipy versioning adheres 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
 -----------
 - If a minor release is to be made, create a release branch named e.g.
@@ -15,18 +20,22 @@ Preparation
   directly on the bug fix branch, so that no separate patch release branch has to be
   made.
   The bug fix branch should of course be branched off of ``main``.
+
 - Run all user guide notebooks locally and confirm that they produce the expected
   results.
+
 - Review the contributor list ``__credits__`` in ``release.py`` to ensure all
   contributors are included and sorted correctly.
   Do the same for the Zenodo contributors file ``.zenodo.json``.
   Review ``.all-contributorsrc`` and regenerate the table if necessary.
+
 - Increment the version number in ``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
   branch.
-  Merge the branch onto ``main``.
+  Merge the branch into ``main``.
 
 Release (and tag)
 -----------------
@@ -38,23 +47,30 @@ Release (and tag)
   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.
+
 - Monitor the publish GitHub Action to ensure the release is successfully published to
   PyPI.
 
 Post-release action
 -------------------
 - Monitor the `documentation build <https://readthedocs.org/projects/kikuchipy/builds>`_
   to make sure the new stable documentation is successfully built from the release.
+
 - Ensure that `Zenodo <https://doi.org/10.5281/zenodo.3597646>`_ received 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 user guide notebooks via `Read The Docs
   <https://kikuchipy.org/en/stable>`_.
-- Bring changes on ``main`` onto ``develop`` by branching off of ``main``, merge
-  ``develop`` onto the new branch, fix conflicts, and make a PR to ``develop``.
-- Make a post-release PR to ``develop`` with ``__version__`` updated (or reverted), e.g.
-  from "0.42.0" to "0.43.dev0", and any updates to this guide if necessary.
+
+- Bring changes in ``main`` into ``develop`` by first branching from ``main``, merge
+  ``develop`` into the new branch and fix conflicts.
+  After these 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.

diff --git a/kikuchipy/release.py b/kikuchipy/release.py
@@ -28,6 +28,7 @@
     "Tina Bergh",
     "Eric Prestat",
     "Zhou Xu",
+    "Erlend Mikkelsen Østvold",
     "Magnus Nord",
 ]
 license = "GPLv3+"

diff --git a/setup.py b/setup.py
@@ -43,8 +43,6 @@
 # fmt: off
 extra_feature_requirements = {
     "doc": [
-        # TODO: Remove once https://github.com/pyxem/kikuchipy/issues/566 is resolved
-        "ipywidgets                     <= 7.7.1",
         "memory_profiler",
         "nbsphinx                       >= 0.7",
         "numpydoc",
@@ -57,7 +55,7 @@
         "sphinx-codeautolink[ipython]   < 0.14",
         "sphinx-copybutton              >= 0.2.5",
         "sphinx-design",
-        "sphinx-gallery                 < 0.11",
+        "sphinx-gallery",
         "sphinxcontrib-bibtex           >= 1.0",
     ],
     "tests": [
@@ -159,7 +157,7 @@
         "matplotlib         >= 3.3",
         "numba              >= 0.55",
         "numpy              >= 1.19",
-        "orix               >= 0.11",
+        "orix               >= 0.11.1",
         "pooch              >= 0.13",
         "pyyaml",
         "tqdm               >= 0.5.2",