climate-ref-esmvaltool 0.5.4__tar.gz → 0.5.5__tar.gz

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.5.5}/PKG-INFO

@@ -1,14 +1,15 @@
 Metadata-Version: 2.4
 Name: climate-ref-esmvaltool
-Version: 0.5.4
+Version: 0.5.5
 Summary: ESMValTool diagnostic provider for the Rapid Evaluation Framework
 Author-email: ESMValTool development team <esmvaltool-dev@listserv.dfn.de>
 License: Apache-2.0
 License-File: LICENCE
 License-File: NOTICE
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.5.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "climate-ref-esmvaltool"
-version = "0.5.4"
+version = "0.5.5"
 description = "ESMValTool diagnostic provider for the Rapid Evaluation Framework"
 readme = "README.md"
 authors = [
@@ -8,9 +8,9 @@ authors = [
 ]
 requires-python = ">=3.11"
 classifiers = [
-    "Development Status :: 4 - Beta",
-    "Intended Audience :: Developers",
+    "Development Status :: 3 - Alpha",
     "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
     "Intended Audience :: Science/Research",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
@@ -18,6 +18,7 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Topic :: Scientific/Engineering",
+    "License :: OSI Approved :: Apache Software License",
 ]
 dependencies = [
     "pooch >= 1.8",

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.5.5}/src/climate_ref_esmvaltool/__init__.py

@@ -3,7 +3,7 @@ Rapid evaluating CMIP data with ESMValTool.
 """
 
 import climate_ref_esmvaltool.diagnostics
-from climate_ref_core.dataset_registry import dataset_registry_manager
+from climate_ref_core.dataset_registry import DATASET_URL, dataset_registry_manager
 from climate_ref_core.providers import CondaDiagnosticProvider
 from climate_ref_esmvaltool._version import __version__
 from climate_ref_esmvaltool.recipe import _ESMVALTOOL_COMMIT
@@ -24,7 +24,7 @@ for _diagnostic_cls_name in climate_ref_esmvaltool.diagnostics.__all__:
 # Register OBS, OBS6, and raw data
 dataset_registry_manager.register(
     "esmvaltool",
-    "https://pub-b093171261094c4ea9adffa01f94ee06.r2.dev/",
+    base_url=DATASET_URL,
     package="climate_ref_esmvaltool.dataset_registry",
     resource="data.txt",
 )

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.5.5}/src/climate_ref_esmvaltool/diagnostics/base.py

@@ -14,7 +14,7 @@ from climate_ref_core.diagnostics import (
     ExecutionDefinition,
     ExecutionResult,
 )
-from climate_ref_core.pycmec.metric import CMECMetric
+from climate_ref_core.pycmec.metric import CMECMetric, MetricCV
 from climate_ref_core.pycmec.output import CMECOutput, OutputCV
 from climate_ref_esmvaltool.recipe import load_recipe, prepare_climate_data
 from climate_ref_esmvaltool.types import MetricBundleArgs, OutputBundleArgs, Recipe
@@ -48,7 +48,7 @@ class ESMValToolDiagnostic(CommandLineDiagnostic):
         execution_dataset: ExecutionDatasetCollection,
         metric_args: MetricBundleArgs,
         output_args: OutputBundleArgs,
-    ) -> tuple[MetricBundleArgs, OutputBundleArgs]:
+    ) -> tuple[CMECMetric, CMECOutput]:
         """
         Update the arguments needed to create a CMEC diagnostic and output bundle.
 
@@ -67,7 +67,7 @@ class ESMValToolDiagnostic(CommandLineDiagnostic):
         -------
             The arguments needed to create a CMEC diagnostic and output bundle.
         """
-        return metric_args, output_args
+        return CMECMetric.model_validate(metric_args), CMECOutput.model_validate(output_args)
 
     def build_cmd(self, definition: ExecutionDefinition) -> Iterable[str]:
         """
@@ -198,15 +198,20 @@ class ESMValToolDiagnostic(CommandLineDiagnostic):
         output_args[OutputCV.PROVENANCE.value][OutputCV.LOG.value] = f"{result_dir}/run/main_log_debug.txt"
 
         # Update the diagnostic and output bundle with diagnostic specific executions.
-        metric_args, output_args = self.format_result(
+        metric_bundle, output_bundle = self.format_result(
             result_dir=result_dir,
             execution_dataset=definition.datasets,
             metric_args=metric_args,
             output_args=output_args,
         )
 
+        # Add the extra information from the groupby operations
+        if len(metric_bundle.DIMENSIONS[MetricCV.JSON_STRUCTURE.value]):
+            input_selectors = definition.datasets[SourceDatasetType.CMIP6].selector_dict()
+            metric_bundle = metric_bundle.prepend_dimensions(input_selectors)
+
         return ExecutionResult.build_from_output_bundle(
             definition,
-            cmec_output_bundle=output_args,
-            cmec_metric_bundle=metric_args,
+            cmec_output_bundle=output_bundle,
+            cmec_metric_bundle=metric_bundle,
         )

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.5.5}/src/climate_ref_esmvaltool/diagnostics/ecs.py

@@ -11,7 +11,8 @@ from climate_ref_core.constraints import (
 )
 from climate_ref_core.datasets import ExecutionDatasetCollection, FacetFilter, SourceDatasetType
 from climate_ref_core.diagnostics import DataRequirement
-from climate_ref_core.pycmec.metric import MetricCV
+from climate_ref_core.pycmec.metric import CMECMetric, MetricCV
+from climate_ref_core.pycmec.output import CMECOutput
 from climate_ref_esmvaltool.diagnostics.base import ESMValToolDiagnostic
 from climate_ref_esmvaltool.recipe import dataframe_to_recipe
 from climate_ref_esmvaltool.types import MetricBundleArgs, OutputBundleArgs, Recipe
@@ -57,14 +58,14 @@ class EquilibriumClimateSensitivity(ESMValToolDiagnostic):
             ),
         ),
     )
-    facets = ("source_id", "region", "metric")
+    facets = ("grid_label", "member_id", "source_id", "region", "metric")
 
     @staticmethod
     def update_recipe(recipe: Recipe, input_files: pandas.DataFrame) -> None:
         """Update the recipe."""
         # Only run the diagnostic that computes ECS for a single model.
         recipe["diagnostics"] = {
-            "cmip6": {
+            "ecs": {
                 "description": "Calculate ECS.",
                 "variables": {
                     "tas": {
@@ -76,7 +77,7 @@ class EquilibriumClimateSensitivity(ESMValToolDiagnostic):
                     },
                 },
                 "scripts": {
-                    "ecs": {
+                    "calculate": {
                         "script": "climate_metrics/ecs.py",
                         "calculate_mmm": False,
                     },
@@ -103,6 +104,18 @@ class EquilibriumClimateSensitivity(ESMValToolDiagnostic):
         for dataset in datasets:
             dataset["timerange"] = timerange
 
+        # Remove keys from the recipe that are only used for YAML anchors
+        keys_to_remove = [
+            "CMIP5_RTMT",
+            "CMIP6_RTMT",
+            "CMIP5_RTNT",
+            "CMIP6_RTNT",
+            "ECS_SCRIPT",
+            "SCATTERPLOT",
+        ]
+        for key in keys_to_remove:
+            recipe.pop(key, None)
+
         recipe["datasets"] = datasets
 
     @staticmethod
@@ -111,34 +124,27 @@ class EquilibriumClimateSensitivity(ESMValToolDiagnostic):
         execution_dataset: ExecutionDatasetCollection,
         metric_args: MetricBundleArgs,
         output_args: OutputBundleArgs,
-    ) -> tuple[MetricBundleArgs, OutputBundleArgs]:
+    ) -> tuple[CMECMetric, CMECOutput]:
         """Format the result."""
-        input_files = next(c.datasets for _, c in execution_dataset.items())
-        source_id = input_files.iloc[0].source_id
-
-        ecs_ds = xarray.open_dataset(result_dir / "work" / "cmip6" / "ecs" / "ecs.nc")
+        ecs_ds = xarray.open_dataset(result_dir / "work" / "ecs" / "calculate" / "ecs.nc")
         ecs = float(ecs_ds["ecs"].values[0])
-        lambda_ds = xarray.open_dataset(result_dir / "work" / "cmip6" / "ecs" / "lambda.nc")
+        lambda_ds = xarray.open_dataset(result_dir / "work" / "ecs" / "calculate" / "lambda.nc")
         lambda_ = float(lambda_ds["lambda"].values[0])
 
         # Update the diagnostic bundle arguments with the computed diagnostics.
         metric_args[MetricCV.DIMENSIONS.value] = {
             MetricCV.JSON_STRUCTURE.value: [
-                "source_id",
                 "region",
                 "metric",
             ],
-            "source_id": {source_id: {}},
             "region": {"global": {}},
             "metric": {"ecs": {}, "lambda": {}},
         }
         metric_args[MetricCV.RESULTS.value] = {
-            source_id: {
-                "global": {
-                    "ecs": ecs,
-                    "lambda": lambda_,
-                },
+            "global": {
+                "ecs": ecs,
+                "lambda": lambda_,
             },
         }
 
-        return metric_args, output_args
+        return CMECMetric.model_validate(metric_args), CMECOutput.model_validate(output_args)

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.5.5}/src/climate_ref_esmvaltool/diagnostics/tcr.py

@@ -11,7 +11,8 @@ from climate_ref_core.constraints import (
 )
 from climate_ref_core.datasets import ExecutionDatasetCollection, FacetFilter, SourceDatasetType
 from climate_ref_core.diagnostics import DataRequirement
-from climate_ref_core.pycmec.metric import MetricCV
+from climate_ref_core.pycmec.metric import CMECMetric, MetricCV
+from climate_ref_core.pycmec.output import CMECOutput
 from climate_ref_esmvaltool.diagnostics.base import ESMValToolDiagnostic
 from climate_ref_esmvaltool.recipe import dataframe_to_recipe
 from climate_ref_esmvaltool.types import MetricBundleArgs, OutputBundleArgs, Recipe
@@ -50,14 +51,14 @@ class TransientClimateResponse(ESMValToolDiagnostic):
             ),
         ),
     )
-    facets = ("source_id", "region", "metric")
+    facets = ("grid_label", "member_id", "source_id", "region", "metric")
 
     @staticmethod
     def update_recipe(recipe: Recipe, input_files: pandas.DataFrame) -> None:
         """Update the recipe."""
         # Only run the diagnostic that computes TCR for a single model.
         recipe["diagnostics"] = {
-            "cmip6": {
+            "tcr": {
                 "description": "Calculate TCR.",
                 "variables": {
                     "tas": {
@@ -65,7 +66,7 @@ class TransientClimateResponse(ESMValToolDiagnostic):
                     },
                 },
                 "scripts": {
-                    "tcr": {
+                    "calculate": {
                         "script": "climate_metrics/tcr.py",
                         "calculate_mmm": False,
                     },
@@ -92,6 +93,15 @@ class TransientClimateResponse(ESMValToolDiagnostic):
         for dataset in datasets:
             dataset["timerange"] = timerange
 
+        # Remove keys from the recipe that are only used for YAML anchors
+        keys_to_remove = [
+            "TCR",
+            "SCATTERPLOT",
+            "VAR_SETTING",
+        ]
+        for key in keys_to_remove:
+            recipe.pop(key, None)
+
         recipe["datasets"] = datasets
 
     @staticmethod
@@ -100,31 +110,24 @@ class TransientClimateResponse(ESMValToolDiagnostic):
         execution_dataset: ExecutionDatasetCollection,
         metric_args: MetricBundleArgs,
         output_args: OutputBundleArgs,
-    ) -> tuple[MetricBundleArgs, OutputBundleArgs]:
+    ) -> tuple[CMECMetric, CMECOutput]:
         """Format the result."""
-        input_files = next(c.datasets for _, c in execution_dataset.items())
-        source_id = input_files.iloc[0].source_id
-
-        tcr_ds = xarray.open_dataset(result_dir / "work" / "cmip6" / "tcr" / "tcr.nc")
+        tcr_ds = xarray.open_dataset(result_dir / "work" / "tcr" / "calculate" / "tcr.nc")
         tcr = float(tcr_ds["tcr"].values[0])
 
         # Update the diagnostic bundle arguments with the computed diagnostics.
         metric_args[MetricCV.DIMENSIONS.value] = {
             "json_structure": [
-                "source_id",
                 "region",
                 "metric",
             ],
-            "source_id": {source_id: {}},
             "region": {"global": {}},
             "metric": {"tcr": {}},
         }
         metric_args[MetricCV.RESULTS.value] = {
-            source_id: {
-                "global": {
-                    "tcr": tcr,
-                },
+            "global": {
+                "tcr": tcr,
             },
         }
 
-        return metric_args, output_args
+        return CMECMetric.model_validate(metric_args), CMECOutput.model_validate(output_args)

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.5.5}/src/climate_ref_esmvaltool/diagnostics/tcre.py

@@ -11,7 +11,8 @@ from climate_ref_core.constraints import (
 )
 from climate_ref_core.datasets import ExecutionDatasetCollection, FacetFilter, SourceDatasetType
 from climate_ref_core.diagnostics import DataRequirement
-from climate_ref_core.pycmec.metric import MetricCV
+from climate_ref_core.pycmec.metric import CMECMetric, MetricCV
+from climate_ref_core.pycmec.output import CMECOutput
 from climate_ref_esmvaltool.diagnostics.base import ESMValToolDiagnostic
 from climate_ref_esmvaltool.recipe import dataframe_to_recipe
 from climate_ref_esmvaltool.types import MetricBundleArgs, OutputBundleArgs, Recipe
@@ -63,7 +64,7 @@ class TransientClimateResponseEmissions(ESMValToolDiagnostic):
             ),
         ),
     )
-    facets = ("source_id", "region", "metric")
+    facets = ("grid_label", "member_id", "source_id", "region", "metric")
 
     @staticmethod
     def update_recipe(recipe: Recipe, input_files: pandas.DataFrame) -> None:
@@ -107,30 +108,23 @@ class TransientClimateResponseEmissions(ESMValToolDiagnostic):
         execution_dataset: ExecutionDatasetCollection,
         metric_args: MetricBundleArgs,
         output_args: OutputBundleArgs,
-    ) -> tuple[MetricBundleArgs, OutputBundleArgs]:
+    ) -> tuple[CMECMetric, CMECOutput]:
         """Format the result."""
-        input_files = next(c.datasets for _, c in execution_dataset.items())
-        source_id = input_files.iloc[0].source_id
-
         tcre_ds = xarray.open_dataset(result_dir / "work" / "tcre" / "calculate_tcre" / "tcre.nc")
         tcre = float(tcre_ds["tcre"].values[0])
 
         # Update the diagnostic bundle arguments with the computed diagnostics.
         metric_args[MetricCV.DIMENSIONS.value] = {
             "json_structure": [
-                "source_id",
                 "region",
                 "metric",
             ],
-            "source_id": {source_id: {}},
             "region": {"global": {}},
             "metric": {"tcre": {}},
         }
         metric_args[MetricCV.RESULTS.value] = {
-            source_id: {
-                "global": {
-                    "tcre": tcre,
-                },
+            "global": {
+                "tcre": tcre,
             },
         }
-        return metric_args, output_args
+        return CMECMetric.model_validate(metric_args), CMECOutput.model_validate(output_args)

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.5.5}/src/climate_ref_esmvaltool/diagnostics/zec.py

@@ -11,7 +11,8 @@ from climate_ref_core.constraints import (
 )
 from climate_ref_core.datasets import ExecutionDatasetCollection, FacetFilter, SourceDatasetType
 from climate_ref_core.diagnostics import DataRequirement
-from climate_ref_core.pycmec.metric import MetricCV
+from climate_ref_core.pycmec.metric import CMECMetric, MetricCV
+from climate_ref_core.pycmec.output import CMECOutput
 from climate_ref_esmvaltool.diagnostics.base import ESMValToolDiagnostic
 from climate_ref_esmvaltool.recipe import dataframe_to_recipe
 from climate_ref_esmvaltool.types import MetricBundleArgs, OutputBundleArgs, Recipe
@@ -50,7 +51,7 @@ class ZeroEmissionCommitment(ESMValToolDiagnostic):
             ),
         ),
     )
-    facets = ("source_id", "region", "metric")
+    facets = ("grid_label", "member_id", "source_id", "region", "metric")
 
     @staticmethod
     def update_recipe(recipe: Recipe, input_files: pandas.DataFrame) -> None:
@@ -83,27 +84,21 @@ class ZeroEmissionCommitment(ESMValToolDiagnostic):
         execution_dataset: ExecutionDatasetCollection,
         metric_args: MetricBundleArgs,
         output_args: OutputBundleArgs,
-    ) -> tuple[MetricBundleArgs, OutputBundleArgs]:
+    ) -> tuple[CMECMetric, CMECOutput]:
         """Format the result."""
-        input_files = next(c.datasets for _, c in execution_dataset.items())
-        source_id = input_files.iloc[0].source_id
-
         zec_ds = xarray.open_dataset(result_dir / "work" / "zec" / "zec" / "zec_50.nc")
         zec = float(zec_ds["zec"].values[0])
 
         # Update the diagnostic bundle arguments with the computed diagnostics.
         metric_args[MetricCV.DIMENSIONS.value] = {
-            "json_structure": cls.facets,
-            "source_id": {source_id: {}},
+            "json_structure": ["region", "metric"],
             "region": {"global": {}},
             "metric": {"zec": {}},
         }
         metric_args[MetricCV.RESULTS.value] = {
-            source_id: {
-                "global": {
-                    "zec": zec,
-                },
+            "global": {
+                "zec": zec,
             },
         }
 
-        return metric_args, output_args
+        return CMECMetric.model_validate(metric_args), CMECOutput.model_validate(output_args)

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.5.5}/tests/integration/test_diagnostics.py

@@ -21,3 +21,4 @@ def test_build_results(diagnostic: Diagnostic, diagnostic_validation):
 
     definition = validator.get_regression_definition()
     validator.validate(definition)
+    validator.execution_regression.check(definition.key, definition.output_directory)

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.5.5}/tests/unit/diagnostics/test_ecs.py

@@ -30,12 +30,22 @@ def test_update_recipe(metric_dataset):
     EquilibriumClimateSensitivity().update_recipe(recipe, input_files)
     assert len(recipe["datasets"]) == 2
     assert len(recipe["diagnostics"]) == 1
-    assert set(recipe["diagnostics"]["cmip6"]["variables"]) == {"tas", "rtnt"}
+    assert set(recipe["diagnostics"]["ecs"]["variables"]) == {"tas", "rtnt"}
+    undesired_keys = [
+        "CMIP5_RTMT",
+        "CMIP6_RTMT",
+        "CMIP5_RTNT",
+        "CMIP6_RTNT",
+        "ECS_SCRIPT",
+        "SCATTERPLOT",
+    ]
+    for key in undesired_keys:
+        assert key not in recipe
 
 
 def test_format_output(tmp_path, metric_dataset):
     result_dir = tmp_path
-    subdir = result_dir / "work" / "cmip6" / "ecs"
+    subdir = result_dir / "work" / "ecs" / "calculate"
     subdir.mkdir(parents=True)
     ecs = xr.Dataset(
         data_vars={
@@ -58,6 +68,6 @@ def test_format_output(tmp_path, metric_dataset):
     )
 
     CMECMetric.model_validate(metric_args)
-    assert metric_args["RESULTS"]["ACCESS-ESM1-5"]["global"]["ecs"] == 1.0
-    assert metric_args["RESULTS"]["ACCESS-ESM1-5"]["global"]["lambda"] == 2.0
+    assert metric_args.RESULTS["global"]["ecs"] == 1.0
+    assert metric_args.RESULTS["global"]["lambda"] == 2.0
     CMECOutput.model_validate(output_args)

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.5.5}/tests/unit/diagnostics/test_tcr.py

@@ -30,12 +30,19 @@ def test_update_recipe(metric_dataset):
     TransientClimateResponse().update_recipe(recipe, input_files)
     assert len(recipe["datasets"]) == 2
     assert len(recipe["diagnostics"]) == 1
-    assert set(recipe["diagnostics"]["cmip6"]["variables"]) == {"tas"}
+    assert set(recipe["diagnostics"]["tcr"]["variables"]) == {"tas"}
+    undesired_keys = [
+        "TCR",
+        "SCATTERPLOT",
+        "VAR_SETTING",
+    ]
+    for key in undesired_keys:
+        assert key not in recipe
 
 
 def test_format_output(tmp_path, metric_dataset):
     result_dir = tmp_path
-    subdir = result_dir / "work" / "cmip6" / "tcr"
+    subdir = result_dir / "work" / "tcr" / "calculate"
     subdir.mkdir(parents=True)
     tcr = xr.Dataset(
         data_vars={
@@ -52,5 +59,5 @@ def test_format_output(tmp_path, metric_dataset):
     )
 
     CMECMetric.model_validate(metric_args)
-    assert metric_args["RESULTS"]["ACCESS-ESM1-5"]["global"]["tcr"] == 1.0
+    assert metric_args.RESULTS["global"]["tcr"] == 1.0
     CMECOutput.model_validate(output_args)

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.5.5}/tests/unit/diagnostics/test_tcre.py

@@ -104,5 +104,5 @@ def test_format_output(tmp_path, metric_dataset):
     )
 
     CMECMetric.model_validate(metric_args)
-    assert metric_args["RESULTS"]["MPI-ESM1-2-LR"]["global"]["tcre"] == 1.0
+    assert metric_args.RESULTS["global"]["tcre"] == 1.0
     CMECOutput.model_validate(output_args)

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.5.5}/tests/unit/diagnostics/test_zec.py

@@ -88,5 +88,5 @@ def test_format_output(tmp_path, metric_dataset):
     )
 
     CMECMetric.model_validate(metric_args)
-    assert metric_args["RESULTS"]["ACCESS-ESM1-5"]["global"]["zec"] == -0.11
+    assert metric_args.RESULTS["global"]["zec"] == -0.11
     CMECOutput.model_validate(output_args)