Merge pull request #646 from hakonanes/python-3-11-support

List explicit Python 3.11 support

.github/workflows/test_documentation_notebooks.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.11'
 
       - name: Install package and dependencies
         shell: bash

.github/workflows/tests.yml

@@ -39,7 +39,7 @@ jobs:
 
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.11'
 
       - name: Install dependencies
         run: |
@@ -57,14 +57,14 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: [3.9, '3.10']
+        python-version: ['3.10', '3.11']
         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.1 scikit-image==0.16.2
+            DEPENDENCIES: dask==2021.8.1 diffsims==0.5.1 hyperspy==1.7.3 matplotlib==3.5 numba==0.55 numpy==1.21.6 orix==0.11.1 pooch==1.3.0 scikit-image==0.16.2
             LABEL: -oldest
           - os: ubuntu-latest
-            python-version: 3.10
+            python-version: 3.11
             LABEL: -minimum_requirement
     steps:
       - uses: actions/checkout@v3

CHANGELOG.rst

@@ -18,6 +18,8 @@ Unreleased
 
 Added
 -----
+- Explicit support for Python 3.11.
+  (`#645 <https://github.com/pyxem/kikuchipy/pull/645>`_)
 
 Changed
 -------
@@ -26,6 +28,8 @@ Changed
   internally to set the default color to white anymore, but uses ``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, and Matplotlib to 0.5.1, 1.21.6, and
+  3.5 respectively. (`#645 <https://github.com/pyxem/kikuchipy/pull/645>`_)
 
 Deprecated
 ----------

doc/conf.py

@@ -112,7 +112,7 @@
     ],
     "logo": {
         "alt_text": "kikuchipy",
-        "image_dark": "logo/plasma_banner_dark.png",
+        "image_dark": "_static/logo/plasma_banner_dark.png",
     },
     "navigation_with_keys": False,
     "show_toc_level": 2,

doc/user/applications.rst

@@ -16,16 +16,18 @@ Most of these works are also listed when searching for ``"kikuchipy"`` `on Googl
 ====
 - A. V. Bugten, L. Michels, R. B. Brurok, C. Hartung, E. Ott, L. Vines, Y. Li,
   L. Arnberg and M. Di Sabatino, "The Role of Boron in Low Copper Spheroidal Graphite
-  Irons," *Metallurgical and Materials Transactions A* (2023).
+  Irons," *Metallurgical and Materials Transactions A* **54** (2023).
   https://doi.org/10.1007/s11661-023-07014-y.
 - O. W. Sandvik, A. M. Müller, H. W. Ånes, M. Zahn, J. He, M. Fiebig, T. Lottermoser,
-  Th. Rojac, D. Meier and J. Schultheiß, "Pressure-control of non-ferroelastic
-  ferroelectric domains in ErMnO3," *arXiv* (2023).
-  https://doi.org/10.48550/arXiv.2304.08423.
+  Th. Rojac, D. Meier and J. Schultheiß, "Pressure Control of Nonferroelastic
+  Ferroelectric Domains in ErMnO3," *Nano Letters* (2023).
+  https://doi.org/10.1021/acs.nanolett.3c01638
+  (`arXiv <https://doi.org/10.48550/arXiv.2304.08423>`__).
 - H. W. Ånes, A. T. J. van Helvoort and K. Marthinsen, "Orientation dependent pinning
   of (sub)grains by dispersoids during recovery and recrystallization in an Al-Mn
   alloy," *Acta Materialia* **248** (2023).
-  https://doi.org/10.1016/j.actamat.2023.118761.
+  https://doi.org/10.1016/j.actamat.2023.118761
+  (`arXiv <https://doi.org/10.48550/arxiv.2212.03527>`__).
 - T. Bergh, H. W. Ånes, R. Aune, S. Wenner, R. Holmestad, X. Ren and P. E. Vullum,
   "Intermetallic Phase Layers in Cold Metal Transfer Aluminium-Steel Welds with an
   Al-Si–Mn Filler Alloy," *Materials Transactions* **64(2)** (2023).
@@ -40,11 +42,13 @@ Most of these works are also listed when searching for ``"kikuchipy"`` `on Googl
 - H. W. Ånes, A. T. J. van Helvoort and K. Marthinsen, "Correlated subgrain and
   particle analysis of a recovered Al-Mn alloy by directly combining EBSD and
   backscatter electron imaging," *Materials Characterization* **193** (2022).
-  https://doi.org/10.1016/j.matchar.2022.112228.
+  https://doi.org/10.1016/j.matchar.2022.112228
+  (`arXiv <https://doi.org/10.48550/arXiv.2205.05514>`__).
 - J. Schultheiß, F. Xue, E. Roede, H. W. Ånes, F. H. Danmo, S. M. Selbach, L.-Q. Chen
   and D. Meier, "Confinement-driven inverse domain scaling in polycrystalline ErMnO3,"
   *Advanced Materials*, **34** (2022).
-  https://doi.org/10.1002/adma.202203449.
+  https://doi.org/10.1002/adma.202203449
+  (`arXiv <https://doi.org/10.48550/arxiv.2204.07979>`__).
 
 2021
 ====

doc/user/installation.rst

@@ -22,9 +22,9 @@ To update kikuchipy to the latest release::
 
     pip install --upgrade kikuchipy
 
-To install a specific version of kikuchipy (say version 0.5.8)::
+To install a specific version of kikuchipy (say version 0.8.5)::
 
-    pip install kikuchipy==0.5.8
+    pip install kikuchipy==0.8.5
 
 .. _optional-dependencies:
 
@@ -59,7 +59,7 @@ To install with Anaconda, we recommend you install it in a
 `Miniconda distribution <https://docs.conda.io/en/latest/miniconda.html>`__.
 To create an environment and activate it, run the following::
 
-   conda create --name kp-env python=3.9
+   conda create --name kp-env python=3.11
    conda activate kp-env
 
 If you prefer a graphical interface to manage packages and environments, you can install
@@ -73,9 +73,9 @@ To update kikuchipy to the latest release::
 
     conda update kikuchipy
 
-To install a specific version of kikuchipy (say version 0.5.8)::
+To install a specific version of kikuchipy (say version 0.8.5)::
 
-    conda install kikuchipy==0.5.8
+    conda install kikuchipy==0.8.5
 
 .. _install-with-hyperspy-bundle:
 

doc/user/related_projects.rst

@@ -23,13 +23,16 @@ EBSD data that users of kikuchipy might find useful:
   kikuchipy depends on this library for Hough indexing.
 - `OpenECCI <https://github.com/gorliks/OpenECCI>`__: GUI-based software for controlled
   Electron Channelling Contrast Imaging (ECCI) analysis of crystal defects in an SEM.
-- `MTEX <https://mtex-toolbox.github.io/>`__: Matlab toolbox for analyzing and modeling
+- `MTEX <https://mtex-toolbox.github.io/>`__: MATLAB toolbox for analyzing and modeling
   crystallographic textures by means of EBSD or pole figure data.
-- `AstroEBSD <https://github.com/benjaminbritton/AstroEBSD>`__: Matlab package with
+- `Dream.3D <http://dream3d.bluequartz.net/>`__: C++ library to reconstruct, instatiate,
+  quantify, mesh, handle, and visualize multidimensional (3D), multimodal data (mainly
+  EBSD orientation data).
+- `AstroEBSD <https://github.com/benjaminbritton/AstroEBSD>`__: MATLAB package with
   indexing tools for EBSD patterns.
 - :doc:`xcdskd <xcdskd:index>`: Python library with tools for Kikuchi Diffraction in the
   SEM, with example Jupyter Notebooks.
-- `OpenXY <https://github.com/BYU-MicrostructureOfMaterials/OpenXY>`_: Matlab tool for
+- `OpenXY <https://github.com/BYU-MicrostructureOfMaterials/OpenXY>`_: MATLAB tool for
   cross-correlation analysis of EBSD patterns.
 - :doc:`DefDAP <defdap:index>`: Python package for correlating EBSD and high-resolution
   digital image correlation data.

environment.yml

@@ -2,7 +2,7 @@ name: doc-dependencies-for-binder
 channels:
   - conda-forge
 dependencies:
-  - python=3.9
+  - python=3.11
   - pip
   - pip:
       - --editable .[doc,all]

readthedocs.yaml

@@ -13,7 +13,7 @@ sphinx:
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.10"
+    python: "3.11"
     nodejs: "19"
   # See https://docs.pyvista.org/user-guide/jupyter/panel.html#configuration-considerations.
   # Some of these packages are needed by PyVista/panel to render 3D
@@ -35,4 +35,3 @@ python:
       path: .
       extra_requirements:
         - doc
-        - viz

setup.py

@@ -49,7 +49,7 @@
         "nlopt",
         "panel",  # Used in the docs by PyVista
         "pydata-sphinx-theme",
-        "pyebsdindex                    >= 0.1.1",
+        "pyebsdindex                    ~= 0.1",
         "pyvista",
         "sphinx                         >= 3.0.2",
         "sphinx-codeautolink[ipython]   < 0.14",
@@ -103,6 +103,7 @@
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
         "Development Status :: 4 - Beta",
         "Intended Audience :: Science/Research",
         (
@@ -145,15 +146,15 @@
     install_requires=[
         "dask[array]        >= 2021.8.1",
         "diffpy.structure   >= 3",
-        "diffsims           >= 0.5",
+        "diffsims           >= 0.5.1",
         "hyperspy           >= 1.7.3",
         "h5py               >= 2.10",
         "imageio",
-        "matplotlib         >= 3.3",
+        "matplotlib         >= 3.5",
         "numba              >= 0.55",
-        "numpy              >= 1.19",
+        "numpy              >= 1.21.6",
         "orix               >= 0.11.1",
-        "pooch              >= 0.13",
+        "pooch              >= 1.3.0",
         "pyyaml",
         "tqdm               >= 0.5.2",
         "scikit-image       >= 0.16.2",