Skip to content

Improve error message when scipy is missing for NDPointIndex #11085

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dcherian merged 10 commits into from
Jan 28, 2026
+21 −3
Merged

Improve error message when scipy is missing for NDPointIndex #11085

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
78691c8
Improve error message when scipy is missing for NDPointIndex
Sakshee-D Jan 12, 2026
ffe9a7a
Add test for missing scipy error in NDPointIndex
Sakshee-D Jan 14, 2026
eefac3a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 14, 2026
d855290
Merge branch 'main' into ndpointindex-scipy-error-clean
Sakshee-D Jan 14, 2026
9b26615
Fix missing scipy test to avoid leaking import state
Sakshee-D Jan 14, 2026
6f60e96
Test missing scipy via ScipyKDTreeAdapter constructor
Sakshee-D Jan 14, 2026
a836d83
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 14, 2026
d070859
Test missing scipy via ScipyKDTreeAdapter without monkeypatch
Sakshee-D Jan 14, 2026
f8da704
cleanup
dcherian Jan 28, 2026
c1a2cb5
Merge branch 'main' into ndpointindex-scipy-error-clean
dcherian Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion xarray/indexes/nd_point_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,13 @@ class ScipyKDTreeAdapter(TreeAdapter):
_kdtree: KDTree

def __init__(self, points: np.ndarray, options: Mapping[str, Any]):
from scipy.spatial import KDTree
try:
from scipy.spatial import KDTree
except ImportError as err:
raise ImportError(
"`NDPointIndex` requires `scipy` when used with `ScipyKDTreeAdapter`. "
"Please ensure that `scipy` is installed and importable."
) from err

self._kdtree = KDTree(points, **options)

Expand Down
16 changes: 14 additions & 2 deletions xarray/tests/test_nd_point_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,19 @@

import xarray as xr
from xarray.indexes import NDPointIndex
from xarray.tests import assert_identical
from xarray.indexes.nd_point_index import ScipyKDTreeAdapter
from xarray.tests import assert_identical, has_scipy, requires_scipy

pytest.importorskip("scipy")

@pytest.mark.skipif(has_scipy, reason="requires scipy to be missing")
def test_scipy_kdtree_adapter_missing_scipy():
points = np.random.rand(4, 2)

with pytest.raises(ImportError, match=r"scipy"):
ScipyKDTreeAdapter(points, options={})


@requires_scipy
def test_tree_index_init() -> None:
from xarray.indexes.nd_point_index import ScipyKDTreeAdapter

Expand All @@ -26,6 +34,7 @@ def test_tree_index_init() -> None:
assert ds_indexed1.xindexes["xx"].equals(ds_indexed2.xindexes["yy"])


@requires_scipy
def test_tree_index_init_errors() -> None:
xx, yy = np.meshgrid([1.0, 2.0], [3.0, 4.0])
ds = xr.Dataset(coords={"xx": (("y", "x"), xx), "yy": (("y", "x"), yy)})
Expand All @@ -39,6 +48,7 @@ def test_tree_index_init_errors() -> None:
ds2.set_xindex(("xx", "yy"), NDPointIndex)


@requires_scipy
def test_tree_index_sel() -> None:
xx, yy = np.meshgrid([1.0, 2.0], [3.0, 4.0])
ds = xr.Dataset(coords={"xx": (("y", "x"), xx), "yy": (("y", "x"), yy)}).set_xindex(
Expand Down Expand Up @@ -112,6 +122,7 @@ def test_tree_index_sel() -> None:
assert_identical(actual, expected)


@requires_scipy
def test_tree_index_sel_errors() -> None:
xx, yy = np.meshgrid([1.0, 2.0], [3.0, 4.0])
ds = xr.Dataset(coords={"xx": (("y", "x"), xx), "yy": (("y", "x"), yy)}).set_xindex(
Expand All @@ -137,6 +148,7 @@ def test_tree_index_sel_errors() -> None:
)


@requires_scipy
def test_tree_index_equals() -> None:
xx1, yy1 = np.meshgrid([1.0, 2.0], [3.0, 4.0])
ds1 = xr.Dataset(
Expand Down
Loading