climate-ref-ilamb 0.8.1__tar.gz → 0.9.0__tar.gz

{climate_ref_ilamb-0.8.1 → climate_ref_ilamb-0.9.0}/.gitignore

@@ -150,7 +150,7 @@ dmypy.json
 
 # Generated output
 out
-.ref
+.ref*
 
 # Ignore copied LICENCE/NOTICE files
 packages/*/LICENCE
@@ -158,3 +158,12 @@ packages/*/NOTICE
 
 # Local directory for data
 /data
+
+# Generated SDK
+/climate_ref_client
+
+# User-specific catalog paths (test data)
+*.paths.yaml
+
+# Helm dependencies
+helm/charts/*

{climate_ref_ilamb-0.8.1 → climate_ref_ilamb-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: climate-ref-ilamb
-Version: 0.8.1
+Version: 0.9.0
 Summary: ILAMB diagnostic provider for the Rapid Evaluation Framework
 Author-email: Nathan Collier <nathaniel.collier@gmail.com>, Jared Lewis <jared.lewis@climate-resource.com>
 License-Expression: Apache-2.0
@@ -21,6 +21,7 @@ Requires-Python: >=3.11
 Requires-Dist: climate-ref-core
 Requires-Dist: ilamb3>=2025.9.9
 Requires-Dist: scipy<1.16
+Requires-Dist: xarray<2025.11
 Description-Content-Type: text/markdown
 
 # climate-ref-ilamb

{climate_ref_ilamb-0.8.1 → climate_ref_ilamb-0.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "climate-ref-ilamb"
-version = "0.8.1"
+version = "0.9.0"
 description = "ILAMB diagnostic provider for the Rapid Evaluation Framework"
 readme = "README.md"
 authors = [
@@ -25,7 +25,8 @@ classifiers = [
 dependencies = [
   "climate-ref-core",
   "ilamb3>=2025.9.9",
-  "scipy<1.16",       # https://github.com/statsmodels/statsmodels/issues/9584
+  "scipy<1.16",        # https://github.com/statsmodels/statsmodels/issues/9584
+  "xarray<2025.11",    # ilamb3 incompatibility with integrate_space units handling
 ]
 [project.entry-points."climate-ref.providers"]
 ilamb = "climate_ref_ilamb:provider"

climate_ref_ilamb-0.9.0/src/climate_ref_ilamb/__init__.py

@@ -0,0 +1,98 @@
+"""
+Diagnostic provider for ILAMB
+
+This module provides a diagnostics provider for ILAMB, a tool for evaluating
+climate models against observations.
+"""
+
+from __future__ import annotations
+
+import importlib.metadata
+import importlib.resources
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+import pooch
+import yaml
+from loguru import logger
+
+from climate_ref_core.dataset_registry import (
+    DATASET_URL,
+    dataset_registry_manager,
+    fetch_all_files,
+    validate_registry_cache,
+)
+from climate_ref_core.providers import DiagnosticProvider
+from climate_ref_ilamb.standard import ILAMBStandard
+
+if TYPE_CHECKING:
+    from climate_ref.config import Config
+
+__version__ = importlib.metadata.version("climate-ref-ilamb")
+
+# Registry names used by ILAMB
+_REGISTRY_NAMES = ("ilamb-test", "ilamb", "iomb")
+
+
+class ILAMBProvider(DiagnosticProvider):
+    """Provider for ILAMB diagnostics."""
+
+    def fetch_data(self, config: Config) -> None:
+        """Fetch ILAMB reference data from all registries."""
+        for name in _REGISTRY_NAMES:
+            registry = dataset_registry_manager[name]
+            fetch_all_files(registry, name, output_dir=None)
+
+    def validate_setup(self, config: Config) -> bool:
+        """Validate that all ILAMB data is cached with correct checksums."""
+        all_errors: list[str] = []
+        for name in _REGISTRY_NAMES:
+            registry = dataset_registry_manager[name]
+            errors = validate_registry_cache(registry, name)
+            all_errors.extend(errors)
+
+        if all_errors:
+            for error in all_errors:
+                logger.error(f"ILAMB validation failed: {error}")
+            logger.error(
+                f"Data for {self.slug} is missing or corrupted. "
+                f"Please run `ref providers setup --provider {self.slug}` to fetch data."
+            )
+            return False
+        return True
+
+    def get_data_path(self) -> Path | None:
+        """Get the path where ILAMB data is cached."""
+        # All ILAMB registries use the same cache
+        return Path(pooch.os_cache("climate_ref"))
+
+
+provider = ILAMBProvider("ILAMB", __version__)
+
+# Register some datasets
+dataset_registry_manager.register(
+    "ilamb-test",
+    base_url=DATASET_URL,
+    package="climate_ref_ilamb.dataset_registry",
+    resource="test.txt",
+)
+dataset_registry_manager.register(
+    "ilamb",
+    base_url=DATASET_URL,
+    package="climate_ref_ilamb.dataset_registry",
+    resource="ilamb.txt",
+)
+dataset_registry_manager.register(
+    "iomb",
+    base_url=DATASET_URL,
+    package="climate_ref_ilamb.dataset_registry",
+    resource="iomb.txt",
+)
+
+# Dynamically register ILAMB diagnostics
+for yaml_file in importlib.resources.files("climate_ref_ilamb.configure").iterdir():
+    with open(str(yaml_file)) as fin:
+        metrics = yaml.safe_load(fin)
+    registry_filename = metrics.pop("registry")
+    for metric, options in metrics.items():
+        provider.register(ILAMBStandard(registry_filename, metric, options.pop("sources"), **options))

climate_ref_ilamb-0.9.0/tests/integration/test_diagnostics.py

@@ -0,0 +1,132 @@
+from pathlib import Path
+
+import pytest
+from climate_ref_ilamb import provider
+
+from climate_ref.testing import TestCaseRunner, validate_result
+from climate_ref_core.diagnostics import Diagnostic
+from climate_ref_core.testing import (
+    RegressionValidator,
+    TestCasePaths,
+    collect_test_case_params,
+    load_datasets_from_yaml,
+)
+
+
+@pytest.fixture(scope="session")
+def provider_test_data_dir() -> Path:
+    """Path to the package-local test data directory."""
+    return Path(__file__).parent.parent / "test-data"
+
+
+xfail_diagnostics = [
+    "ohc-noaa",  # Missing sample data
+]
+skipped_diagnostics = []
+
+
+diagnostics = [
+    pytest.param(
+        diagnostic,
+        id=diagnostic.slug,
+        marks=[
+            *([pytest.mark.xfail(reason="Expected failure")] if diagnostic.slug in xfail_diagnostics else []),
+            *([pytest.mark.skip(reason="Problem test")] if diagnostic.slug in skipped_diagnostics else []),
+        ],
+    )
+    for diagnostic in provider.diagnostics()
+]
+
+# Test case params for parameterized test_case tests
+test_case_params = collect_test_case_params(provider)
+
+
+@pytest.mark.slow
+@pytest.mark.parametrize("diagnostic", diagnostics)
+def test_diagnostics(diagnostic: Diagnostic, diagnostic_validation):
+    validator = diagnostic_validation(diagnostic)
+
+    definition = validator.get_definition()
+    validator.execute(definition)
+
+
+@pytest.mark.parametrize("diagnostic", diagnostics)
+def test_build_results(diagnostic: Diagnostic, diagnostic_validation):
+    validator = diagnostic_validation(diagnostic)
+
+    definition = validator.get_regression_definition()
+    validator.validate(definition)
+    validator.execution_regression.check(definition.key, definition.output_directory)
+
+
+@pytest.mark.parametrize("diagnostic,test_case_name", test_case_params)
+def test_validate_test_case_regression(
+    diagnostic: Diagnostic,
+    test_case_name: str,
+    provider_test_data_dir: Path,
+    config,
+    tmp_path: Path,
+):
+    """
+    Validate pre-stored test case regression outputs as CMEC bundles.
+
+    Each diagnostic/test_case is a separate parameterized test.
+    """
+    diagnostic.provider.configure(config)
+
+    paths = TestCasePaths.from_test_data_dir(
+        provider_test_data_dir,
+        diagnostic.slug,
+        test_case_name,
+    )
+
+    if not paths.catalog.exists():
+        pytest.skip(f"No catalog file for {diagnostic.slug}/{test_case_name}")
+    if not paths.regression.exists():
+        pytest.skip(f"No regression data for {diagnostic.slug}/{test_case_name}")
+
+    validator = RegressionValidator(
+        diagnostic=diagnostic,
+        test_case_name=test_case_name,
+        test_data_dir=provider_test_data_dir,
+    )
+
+    definition = validator.load_regression_definition(tmp_path / diagnostic.slug / test_case_name)
+    validator.validate(definition)
+
+
+@pytest.mark.slow
+@pytest.mark.test_cases
+@pytest.mark.parametrize("diagnostic,test_case_name", test_case_params)
+def test_run_test_cases(
+    diagnostic: Diagnostic,
+    test_case_name: str,
+    provider_test_data_dir: Path,
+    config,
+    tmp_path: Path,
+):
+    """
+    Run diagnostic test cases end-to-end with ESGF data.
+
+    Requires: `ref test-cases fetch --provider ilamb` to have been run first.
+    """
+    diagnostic.provider.configure(config)
+
+    paths = TestCasePaths.from_test_data_dir(
+        provider_test_data_dir,
+        diagnostic.slug,
+        test_case_name,
+    )
+
+    if not paths.catalog.exists():
+        pytest.skip(f"No catalog file for {diagnostic.slug}/{test_case_name}")
+
+    datasets = load_datasets_from_yaml(paths.catalog)
+
+    runner = TestCaseRunner(config=config, datasets=datasets)
+    output_dir = tmp_path / diagnostic.slug / test_case_name
+
+    result = runner.run(diagnostic, test_case_name, output_dir)
+
+    assert result.successful, f"Diagnostic {diagnostic.slug} failed"
+    validate_result(diagnostic, config, result)

climate_ref_ilamb-0.9.0/tests/unit/test_provider.py

@@ -0,0 +1,80 @@
+import importlib.resources
+from pathlib import Path
+
+import pooch
+from climate_ref_ilamb import __version__, provider
+
+
+def test_provider():
+    assert provider.name == "ILAMB"
+    assert provider.slug == "ilamb"
+    assert provider.version == __version__
+
+    counts = []
+    for f in importlib.resources.files("climate_ref_ilamb.configure").iterdir():
+        with open(f) as fin:
+            counts.append(fin.read().count("sources"))
+    assert len(provider) == sum(counts)
+
+
+class TestILAMBProviderHooks:
+    """Tests for ILAMBProvider lifecycle hooks."""
+
+    def test_get_data_path(self):
+        """Test that get_data_path returns the pooch cache path."""
+        data_path = provider.get_data_path()
+        assert data_path is not None
+        assert isinstance(data_path, Path)
+        assert data_path == Path(pooch.os_cache("climate_ref"))
+
+    def test_fetch_data(self, mocker):
+        """Test that fetch_data calls fetch_all_files for all registries."""
+        mock_fetch = mocker.patch("climate_ref_ilamb.fetch_all_files")
+        mock_config = mocker.Mock()
+
+        provider.fetch_data(mock_config)
+
+        # Should be called once for each registry (ilamb-test, ilamb, iomb)
+        assert mock_fetch.call_count == 3
+        registry_names = [call[0][1] for call in mock_fetch.call_args_list]
+        assert "ilamb-test" in registry_names
+        assert "ilamb" in registry_names
+        assert "iomb" in registry_names
+
+    def test_validate_setup_all_valid(self, mocker):
+        """Test validate_setup returns True when all data is valid."""
+        mock_config = mocker.Mock()
+        mocker.patch(
+            "climate_ref_ilamb.validate_registry_cache",
+            return_value=[],
+        )
+
+        result = provider.validate_setup(mock_config)
+        assert result is True
+
+    def test_validate_setup_data_invalid(self, mocker):
+        """Test validate_setup returns False when any registry has errors."""
+        mock_config = mocker.Mock()
+        # Return errors for one registry
+        mocker.patch(
+            "climate_ref_ilamb.validate_registry_cache",
+            side_effect=[[], ["File missing: test.nc"], []],
+        )
+
+        result = provider.validate_setup(mock_config)
+        assert result is False
+
+    def test_validate_setup_multiple_errors(self, mocker):
+        """Test validate_setup collects errors from all registries."""
+        mock_config = mocker.Mock()
+        mocker.patch(
+            "climate_ref_ilamb.validate_registry_cache",
+            side_effect=[
+                ["Error 1"],
+                ["Error 2", "Error 3"],
+                [],
+            ],
+        )
+
+        result = provider.validate_setup(mock_config)
+        assert result is False

climate_ref_ilamb-0.8.1/src/climate_ref_ilamb/__init__.py

@@ -1,47 +0,0 @@
-"""
-Diagnostic provider for ILAMB
-
-This module provides a diagnostics provider for ILAMB, a tool for evaluating
-climate models against observations.
-"""
-
-import importlib.metadata
-import importlib.resources
-
-import yaml
-
-from climate_ref_core.dataset_registry import DATASET_URL, dataset_registry_manager
-from climate_ref_core.providers import DiagnosticProvider
-from climate_ref_ilamb.standard import ILAMBStandard
-
-__version__ = importlib.metadata.version("climate-ref-ilamb")
-
-provider = DiagnosticProvider("ILAMB", __version__)
-
-# Register some datasets
-dataset_registry_manager.register(
-    "ilamb-test",
-    base_url=DATASET_URL,
-    package="climate_ref_ilamb.dataset_registry",
-    resource="test.txt",
-)
-dataset_registry_manager.register(
-    "ilamb",
-    base_url=DATASET_URL,
-    package="climate_ref_ilamb.dataset_registry",
-    resource="ilamb.txt",
-)
-dataset_registry_manager.register(
-    "iomb",
-    base_url=DATASET_URL,
-    package="climate_ref_ilamb.dataset_registry",
-    resource="iomb.txt",
-)
-
-# Dynamically register ILAMB diagnostics
-for yaml_file in importlib.resources.files("climate_ref_ilamb.configure").iterdir():
-    with open(str(yaml_file)) as fin:
-        metrics = yaml.safe_load(fin)
-    registry_filename = metrics.pop("registry")
-    for metric, options in metrics.items():
-        provider.register(ILAMBStandard(registry_filename, metric, options.pop("sources"), **options))

climate_ref_ilamb-0.8.1/tests/integration/test_diagnostics.py

@@ -1,40 +0,0 @@
-import pytest
-from climate_ref_ilamb import provider as ilamb_provider
-
-from climate_ref_core.diagnostics import Diagnostic
-
-xfail_diagnostics = [
-    "ohc-noaa",  # Missing sample data
-]
-skipped_diagnostics = []
-
-
-diagnostics = [
-    pytest.param(
-        diagnostic,
-        id=diagnostic.slug,
-        marks=[
-            *([pytest.mark.xfail(reason="Expected failure")] if diagnostic.slug in xfail_diagnostics else []),
-            *([pytest.mark.skip(reason="Problem test")] if diagnostic.slug in skipped_diagnostics else []),
-        ],
-    )
-    for diagnostic in ilamb_provider.diagnostics()
-]
-
-
-@pytest.mark.slow
-@pytest.mark.parametrize("diagnostic", diagnostics)
-def test_diagnostics(diagnostic: Diagnostic, diagnostic_validation):
-    validator = diagnostic_validation(diagnostic)
-
-    definition = validator.get_definition()
-    validator.execute(definition)
-
-
-@pytest.mark.parametrize("diagnostic", diagnostics)
-def test_build_results(diagnostic: Diagnostic, diagnostic_validation):
-    validator = diagnostic_validation(diagnostic)
-
-    definition = validator.get_regression_definition()
-    validator.validate(definition)
-    validator.execution_regression.check(definition.key, definition.output_directory)

climate_ref_ilamb-0.8.1/tests/unit/test_provider.py

@@ -1,15 +0,0 @@
-import importlib.resources
-
-from climate_ref_ilamb import __version__, provider
-
-
-def test_provider():
-    assert provider.name == "ILAMB"
-    assert provider.slug == "ilamb"
-    assert provider.version == __version__
-
-    counts = []
-    for f in importlib.resources.files("climate_ref_ilamb.configure").iterdir():
-        with open(f) as fin:
-            counts.append(fin.read().count("sources"))
-    assert len(provider) == sum(counts)