Merge pull request #530 from scipp/example-data-instead-of-paths

Make functions in `data.examples` return loaded DataArrays instead of paths

Author: nvaytet

docs/gallery/nyc-taxi.ipynb

@@ -35,7 +35,7 @@
     "from scipp.scipy.ndimage import gaussian_filter\n",
     "import ipywidgets as ipw\n",
     "\n",
-    "data = sc.io.load_hdf5(examples.nyc_taxi())\n",
+    "data = examples.nyc_taxi()\n",
     "data"
    ]
   },

docs/plotting/inspector-plot.ipynb

@@ -225,10 +225,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import scipp as sc\n",
     "from plopp.data.examples import air_temperature\n",
     "\n",
-    "air = sc.io.load_hdf5(air_temperature())\n",
+    "air = air_temperature()\n",
     "air"
    ]
   },

docs/plotting/mesh3d-plot.ipynb

@@ -49,7 +49,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dg = sc.io.load_hdf5(examples.teapot())\n",
+    "dg = examples.teapot()\n",
     "dg"
    ]
   },

src/plopp/data/examples.py

@@ -39,7 +39,7 @@ def get_path(name: str) -> str:
     return _pooch.fetch(name)
 
 
-def nyc_taxi() -> str:
+def nyc_taxi() -> sc.DataArray:
     """
     Return the path to the NYC taxi dataset from 2015 histogrammed in latitude,
     longitude, and hour-of-the-dat, stored in scipp's HDF5 format.
@@ -50,10 +50,10 @@ def nyc_taxi() -> str:
     ---------
     This data has been manipulated!
     """
-    return get_path('nyc_taxi_data.h5')
+    return sc.io.load_hdf5(get_path('nyc_taxi_data.h5'))
 
 
-def teapot() -> str:
+def teapot() -> sc.DataArray:
     """
     Values extracted from the Utah teapot:
     https://graphics.cs.utah.edu/courses/cs6620/fall2013/?prj=5
@@ -63,15 +63,15 @@ def teapot() -> str:
     >> vertices = scene.vertices
     >> faces = scene.meshes[None].faces
     """
-    return get_path('teapot.h5')
+    return sc.io.load_hdf5(get_path('teapot.h5'))
 
 
-def air_temperature() -> str:
+def air_temperature() -> sc.DataArray:
     """
     North American air temperature dataset from Xarray.
     See https://docs.xarray.dev/en/latest/user-guide/plotting.html
     """
-    return get_path('air_temperature.h5')
+    return sc.io.load_hdf5(get_path('air_temperature.h5'))
 
 
 def three_bands(

tests/graphics/artists_test.py

@@ -4,7 +4,6 @@
 from functools import partial
 
 import pytest
-import scipp as sc
 
 import plopp as pp
 from plopp.data import examples
@@ -71,12 +70,12 @@
     "mesh3d-pythreejs": (
         ('3d', 'pythreejs'),
         pp.mesh3d,
-        dict(sc.io.load_hdf5(examples.teapot())),
+        dict(examples.teapot()),
     ),
     "mesh3d-pythreejs-edges": (
         ('3d', 'pythreejs'),
         partial(pp.mesh3d, edgecolor='blue'),
-        dict(sc.io.load_hdf5(examples.teapot())),
+        dict(examples.teapot()),
     ),
 }
 

tests/plotting/mesh3d_test.py

@@ -2,34 +2,30 @@
 # Copyright (c) 2024 Scipp contributors (https://github.com/scipp)
 
 import numpy as np
-import pytest
-import scipp as sc
 
 import plopp as pp
 from plopp.data import examples
 
 
-@pytest.fixture
-def teapot_data():
-    return sc.io.load_hdf5(examples.teapot())
-
-
-def test_mesh3d_default(teapot_data):
+def test_mesh3d_default():
+    teapot_data = examples.teapot()
     pp.mesh3d(
         vertices=teapot_data["vertices"],
         faces=teapot_data["faces"],
     )
 
 
-def test_mesh3d_solid_color(teapot_data):
+def test_mesh3d_solid_color():
+    teapot_data = examples.teapot()
     fig = pp.mesh3d(
         vertices=teapot_data["vertices"], faces=teapot_data["faces"], color='red'
     )
     (mesh,) = fig.artists.values()
     assert np.array_equal(mesh.geometry.attributes["color"].array[0, :], (1, 0, 0))
 
 
-def test_mesh3d_vertexcolors(teapot_data):
+def test_mesh3d_vertexcolors():
+    teapot_data = examples.teapot()
     z = teapot_data["vertices"].fields.z
     fig = pp.mesh3d(
         vertices=teapot_data["vertices"],
@@ -44,7 +40,8 @@ def test_mesh3d_vertexcolors(teapot_data):
     assert not np.array_equal(colors[imin, :], colors[imax, :])
 
 
-def test_mesh3d_edgecolor(teapot_data):
+def test_mesh3d_edgecolor():
+    teapot_data = examples.teapot()
     fig = pp.mesh3d(
         vertices=teapot_data["vertices"],
         faces=teapot_data["faces"],
@@ -55,7 +52,8 @@ def test_mesh3d_edgecolor(teapot_data):
     assert mesh.edges.material.color == 'blue'
 
 
-def test_mesh3d_cmap(teapot_data):
+def test_mesh3d_cmap():
+    teapot_data = examples.teapot()
     fig = pp.mesh3d(
         vertices=teapot_data["vertices"],
         faces=teapot_data["faces"],