climate-ref-core 0.5.2__tar.gz → 0.5.3__tar.gz

{climate_ref_core-0.5.2 → climate_ref_core-0.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: climate-ref-core
-Version: 0.5.2
+Version: 0.5.3
 Summary: Core library for the CMIP Rapid Evaluation Framework
 Author-email: Jared Lewis <jared.lewis@climate-resource.com>, Mika Pflueger <mika.pflueger@climate-resource.com>, Bouwe Andela <b.andela@esciencecenter.nl>, Jiwoo Lee <lee1043@llnl.gov>, Min Xu <xum1@ornl.gov>, Nathan Collier <collierno@ornl.gov>, Dora Hegedus <dora.hegedus@stfc.ac.uk>
 License: Apache-2.0
@@ -18,8 +18,10 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.11
 Requires-Dist: attrs>=23.2.0
+Requires-Dist: loguru>=0.7.0
 Requires-Dist: numpy>=1.25.0
 Requires-Dist: pandas>=2.1.0
+Requires-Dist: pooch<2,>=1.8.0
 Requires-Dist: pydantic>=2.10.6
 Requires-Dist: requests
 Requires-Dist: rich

{climate_ref_core-0.5.2 → climate_ref_core-0.5.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "climate-ref-core"
-version = "0.5.2"
+version = "0.5.3"
 description = "Core library for the CMIP Rapid Evaluation Framework"
 readme = "README.md"
 authors = [
@@ -31,6 +31,8 @@ dependencies = [
     "typing_extensions",
     "requests",
     "rich",
+    "loguru>=0.7.0",
+    "pooch>=1.8.0,<2",
 
     # SPEC 0000 constraints
     # We follow [SPEC-0000](https://scientific-python.org/specs/spec-0000/)

{climate_ref_core-0.5.2 → climate_ref_core-0.5.3}/src/climate_ref_core/dataset_registry.py

@@ -148,7 +148,7 @@ class DatasetRegistryManager:
             path=pooch.os_cache(cache_name),
             base_url=base_url,
             version=version,
-            retry_if_failed=5,
+            retry_if_failed=10,
             env="REF_DATASET_CACHE_DIR",
         )
         registry.load_registry(str(importlib.resources.files(package) / resource))

{climate_ref_core-0.5.2 → climate_ref_core-0.5.3}/src/climate_ref_core/diagnostics.py

@@ -5,7 +5,6 @@ Diagnostic interface
 from __future__ import annotations
 
 import pathlib
-from abc import abstractmethod
 from collections.abc import Iterable, Sequence
 from typing import TYPE_CHECKING, Any, Protocol, runtime_checkable
 
@@ -438,12 +437,28 @@ class AbstractDiagnostic(Protocol):
     The provider that provides the diagnostic.
     """
 
-    def run(self, definition: ExecutionDefinition) -> ExecutionResult:
+    def execute(self, definition: ExecutionDefinition) -> None:
         """
-        Run the diagnostic on the given configuration.
+        Execute the diagnostic on the given configuration.
 
         The implementation of this method is left to the diagnostic providers.
+        The results should be written to the output directory of the execution definition.
+        These are later used to build the output bundle and the diagnostic bundle.
+
+        This may occur in a separate process (or python environment in the case of a `CommandLineDiagnostic`).
+
+        Parameters
+        ----------
+        definition
+            The configuration to run the diagnostic on.
+        """
+        ...
+
+    def build_execution_result(self, definition: ExecutionDefinition) -> ExecutionResult:
+        """
+        Build the result from running the diagnostic on the given configuration.
 
+        This can be replayed later to build the result from the output execution.
 
         Parameters
         ----------
@@ -455,6 +470,7 @@ class AbstractDiagnostic(Protocol):
         :
             The result of running the diagnostic.
         """
+        ...
 
 
 class Diagnostic(AbstractDiagnostic):
@@ -506,6 +522,24 @@ class Diagnostic(AbstractDiagnostic):
     def provider(self, value: DiagnosticProvider) -> None:
         self._provider = value
 
+    def run(self, definition: ExecutionDefinition) -> ExecutionResult:
+        """
+        Run the diagnostic on the given configuration.
+
+        This executes the diagnostic and builds the result from the output bundle.
+
+        Parameters
+        ----------
+        definition
+            The configuration to run the diagnostic on.
+        """
+        # Execute the diagnostic
+        # This may be run in a separate process (or python environment)
+        self.execute(definition)
+
+        # Build the result from the output bundle
+        return self.build_execution_result(definition)
+
 
 class CommandLineDiagnostic(Diagnostic):
     """
@@ -514,7 +548,6 @@ class CommandLineDiagnostic(Diagnostic):
 
     provider: CommandLineDiagnosticProvider
 
-    @abstractmethod
     def build_cmd(self, definition: ExecutionDefinition) -> Iterable[str]:
         """
         Build the command to run the diagnostic on the given configuration.
@@ -529,24 +562,9 @@ class CommandLineDiagnostic(Diagnostic):
         :
             A command that can be run with :func:`subprocess.run`.
         """
+        return []
 
-    @abstractmethod
-    def build_execution_result(self, definition: ExecutionDefinition) -> ExecutionResult:
-        """
-        Build the result from running the diagnostic on the given configuration.
-
-        Parameters
-        ----------
-        definition
-            The configuration to run the diagnostic on.
-
-        Returns
-        -------
-        :
-            The result of running the diagnostic.
-        """
-
-    def run(self, definition: ExecutionDefinition) -> ExecutionResult:
+    def execute(self, definition: ExecutionDefinition) -> None:
         """
         Run the diagnostic on the given configuration.
 
@@ -562,4 +580,3 @@ class CommandLineDiagnostic(Diagnostic):
         """
         cmd = self.build_cmd(definition)
         self.provider.run(cmd)
-        return self.build_execution_result(definition)

{climate_ref_core-0.5.2 → climate_ref_core-0.5.3}/tests/unit/pycmec/test_cmec_metric.py

@@ -477,6 +477,15 @@ def test_remove():
     }
 
 
+def test_iter_results(cmec_metric):
+    assert list(cmec_metric.iter_results())
+
+
+def test_iter_results_empty(cmec_right_metric_dict):
+    cmec_metric = CMECMetric.model_validate(CMECMetric.create_template())
+    assert not list(cmec_metric.iter_results())
+
+
 @pytest.mark.xfail(reason="No need to currently support removing deeper dimensions")
 def test_remove_not_first(cmec_right_metric_dict):
     remove_dimensions(cmec_right_metric_dict, ["metric"])

{climate_ref_core-0.5.2 → climate_ref_core-0.5.3}/tests/unit/test_dataset_registry/test_dataset_registry.py

@@ -107,7 +107,7 @@ def test_fetch_all_files(mocker, tmp_path, symlink):
     registry.fetch = mocker.MagicMock(return_value=downloaded_file)
 
     fetch_all_files(registry, "obs4ref", tmp_path, symlink=symlink)
-    assert registry.fetch.call_count == 2
+    assert registry.fetch.call_count == 36
 
     expected_file = (
         tmp_path / "obs4REF/MOHC/HadISST-1-1/mon/ts/gn/v20210727/ts_mon_HadISST-1-1_PCMDI_gn_187001-201907.nc"
@@ -123,4 +123,4 @@ def test_fetch_all_files_no_output(mocker):
     registry.fetch = mocker.MagicMock()
 
     fetch_all_files(registry, "obs4ref", None)
-    assert registry.fetch.call_count == 2
+    assert registry.fetch.call_count == 36

climate_ref_core-0.5.3/tests/unit/test_datasets/dataset_collection_obs4mips_hash.yml

@@ -0,0 +1,2 @@
+2267913680803057005
+...

{climate_ref_core-0.5.2 → climate_ref_core-0.5.3}/tests/unit/test_datasets.py

@@ -120,11 +120,11 @@ class TestDatasetCollectionObs4MIPs:
         assert dataset_collection_obs4mips.instance_id.equals(expected)
 
     def test_hash(self, dataset_collection_obs4mips, obs4mips_data_catalog, data_regression):
-        ta_datasets = obs4mips_data_catalog[obs4mips_data_catalog.variable_id == "ta"]
-        dataset_hash = hash(DatasetCollection(ta_datasets, "instance_id"))
+        ts_datasets = obs4mips_data_catalog[obs4mips_data_catalog.variable_id == "ts"]
+        dataset_hash = hash(DatasetCollection(ts_datasets, "instance_id"))
         assert isinstance(dataset_hash, int)
 
-        assert dataset_hash != hash(DatasetCollection(ta_datasets.iloc[[0, 0]], "instance_id"))
+        assert dataset_hash != hash(DatasetCollection(ts_datasets.iloc[[0, 0]], "instance_id"))
 
         # This hash will change if the data catalog changes
         # Specifically if more tas datasets are provided

climate_ref_core-0.5.2/tests/unit/test_datasets/dataset_collection_obs4mips_hash.yml

@@ -1,2 +0,0 @@
-1517690654223609976
-...