Merge pull request #702 from hakonanes/692-h5oina-un-processed-patterns

Load either unprocessed or processed patterns from H5OINA files

CHANGELOG.rst

@@ -16,10 +16,17 @@ were listed in alphabetical order by first name until version 0.7.0.
 0.11.1 (2024-11-24)
 ===================
 
+Added
+-----
+- Reading of unprocessed patterns from H5OINA files is now possible.
+  (`#701 <https://github.com/pyxem/kikuchipy/pull/701>`_)
+
 Fixed
 -----
 - Reading of Oxford binary `*.ebsp` files with version 6.
- (`#700 <https://github.com/pyxem/kikuchipy/pull/700>`_)
+  (`#700 <https://github.com/pyxem/kikuchipy/pull/700>`_)
+- Unnecessary reading of unprocessed patterns from H5OINA files into the EBSD original
+  metadata. (`#701 <https://github.com/pyxem/kikuchipy/pull/701>`_)
 
 0.11.0 (2024-11-10)
 ===================

doc/conf.py

@@ -6,8 +6,10 @@
 import inspect
 import os
 from os.path import dirname, relpath
+from pathlib import Path
 import re
 import sys
+import warnings
 
 from numpydoc.docscrape_sphinx import SphinxDocString
 import pyvista as pv
@@ -53,7 +55,6 @@
 # Create links to references within kikuchipy's documentation to these
 # packages
 intersphinx_mapping = {
-    # Package
     "black": ("https://black.readthedocs.io/en/stable", None),
     "conda": ("https://docs.conda.io/projects/conda/en/latest", None),
     "coverage": ("https://coverage.readthedocs.io/en/latest", None),
@@ -358,7 +359,15 @@ def _str_examples(self):
 }
 autosummary_generate = True
 
-# Download example datasets prior to building the docs
-print("[kikuchipy] Downloading example datasets (if not found in cache)")
-_ = kp.data.nickel_ebsd_large(allow_download=True)
-_ = kp.data.si_ebsd_moving_screen(0, allow_download=True)
+
+def custom_setup():
+    """Download files used in the documentation."""
+    print("[kikuchipy] Downloading example datasets (if not found in cache)")
+    try:
+        _ = kp.data.nickel_ebsd_large(allow_download=True)
+        _ = kp.data.si_ebsd_moving_screen(0, allow_download=True)
+    except () as e:
+        warnings.warn(f"Download failed. Error: {e}")
+
+
+custom_setup()

doc/tutorials/load_save_data.ipynb

@@ -983,7 +983,10 @@
     "As with the kikuchipy h5ebsd reader, multiple scans can be read at once.\n",
     "\n",
     "The projection center (PC) arrays are read into the `detector` attribute and the static background pattern is read into the `static_background` attribute.\n",
-    "The orientation and phase data are so far not read."
+    "The orientation and phase data are so far not read.\n",
+    "\n",
+    "Oxford Instruments allow writing both processed and unprocessed patterns.\n",
+    "To read the unprocessed patterns, pass `processed=False` when loading."
    ]
   },
   {