climate-ref-esmvaltool 0.5.3__py3-none-any.whl → 0.5.5__py3-none-any.whl

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/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/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/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/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/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.3.dist-info → climate_ref_esmvaltool-0.5.5.dist-info}/METADATA

@@ -1,14 +1,15 @@
 Metadata-Version: 2.4
 Name: climate-ref-esmvaltool
-Version: 0.5.3
+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.3.dist-info → climate_ref_esmvaltool-0.5.5.dist-info}/RECORD

@@ -1,4 +1,4 @@
-climate_ref_esmvaltool/__init__.py,sha256=RVxZNLdGs9Tl0VPfCibijf1ENytoatrev79K4wzkSEk,1015
+climate_ref_esmvaltool/__init__.py,sha256=4WHuuZJvK50Djb831ws_Y2EtFLWicwsLIxhOvRld2BE,994
 climate_ref_esmvaltool/_version.py,sha256=Ed7geC_W9fxIocCdAvK1fk2k-pDt6FGOM_LEgR06-24,94
 climate_ref_esmvaltool/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 climate_ref_esmvaltool/recipe.py,sha256=wt-KTypBnx8fVfkix6UPJqOEjIv84YW4njasTqdbdzU,5111
@@ -6,19 +6,19 @@ climate_ref_esmvaltool/recipes.txt,sha256=DJZa_kMV9xn6AAkBk05Fzf2Ru44j8wRHq0CWxC
 climate_ref_esmvaltool/types.py,sha256=luUMNS3LJGJEecVrHRDh5l5ElnQgz7G0auCtA_Jwnno,117
 climate_ref_esmvaltool/dataset_registry/data.txt,sha256=uovw8JYEyTF7DSIRQ_PzLG2paETpG9FdJta8djivDrM,12910
 climate_ref_esmvaltool/diagnostics/__init__.py,sha256=9PpcQ3aSnwCdUHa54hkELfVrUgVjUzDguHqkG3B1xTs,1004
-climate_ref_esmvaltool/diagnostics/base.py,sha256=jTxqMBlzGtjUXPvU9_3Dy1gBYm7PG_deqH5Xu2nY7RM,7208
+climate_ref_esmvaltool/diagnostics/base.py,sha256=1FSIvANKoBIg8VSW-1CizWqajqZgk9If6_ACU0W47DE,7575
 climate_ref_esmvaltool/diagnostics/climate_at_global_warming_levels.py,sha256=o5xSAiZJnuMhG3i8lO1QPsN4YSk3s2jhEWi3pdMAJNw,3532
 climate_ref_esmvaltool/diagnostics/cloud_radiative_effects.py,sha256=WdG49r6zDbikpKiM5bFckl3oOwyFgBfARLrYR6OzlPs,2815
-climate_ref_esmvaltool/diagnostics/ecs.py,sha256=dqa3Tn1I6gJ8WcpnAcMNktnPXeb9qfj6-Kk3PgdsI2g,5060
+climate_ref_esmvaltool/diagnostics/ecs.py,sha256=7Zb1llwOqW0vs-7j5iri3HWQEuvcgyeh0O0CDlBwrIA,5290
 climate_ref_esmvaltool/diagnostics/example.py,sha256=F2mazDsSju68v3JE9aU6u4SwszIN3wFR5dRlQExvNns,1981
 climate_ref_esmvaltool/diagnostics/sea_ice_area_seasonal_cycle.py,sha256=KdpXdunin-Yz2RIZms09FJwdw8Dm2Rh3z305oh8LZTA,2874
-climate_ref_esmvaltool/diagnostics/tcr.py,sha256=69cTs4PrfslTy5JqyQc7fzsx1LqSYajFBl-7D5lJwsM,4522
-climate_ref_esmvaltool/diagnostics/tcre.py,sha256=yke0h2ZrYqzmpGcNoVoSgE1yX4wlkiN9xiEjHZ257d0,4996
-climate_ref_esmvaltool/diagnostics/zec.py,sha256=s5Zp7TUtHtKwbPtRKiG5nJkMguiWv6jo5kaWAoYHHFM,4002
+climate_ref_esmvaltool/diagnostics/tcr.py,sha256=v1HwKG6JZwGZ4_lOBWj2YeqT5Ha83HliBqBeuTs-lN0,4668
+climate_ref_esmvaltool/diagnostics/tcre.py,sha256=iMiPklrRdO7tFyv21OZ5oemp4fXUycMF4s_GNNaqCZk,4880
+climate_ref_esmvaltool/diagnostics/zec.py,sha256=iB1pO0VGOlXAtTzyQlFN0tMfDfL9Leq1QGVE70TagOM,3925
 climate_ref_esmvaltool/requirements/conda-lock.yml,sha256=i9jv2YX1KylXWl4oJQJWEgD6ZmY5pAsj_cbKAxzudFs,588058
 climate_ref_esmvaltool/requirements/environment.yml,sha256=Pc3Vq0ZGwSEc_bOxDYJsgoro13-YrGWjpdyO1UQwHEM,78
-climate_ref_esmvaltool-0.5.3.dist-info/METADATA,sha256=R0zhAmDqQMzNlO7R9dwQ8_lK1HJ85Nyun-WMmmd3LVk,2302
-climate_ref_esmvaltool-0.5.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-climate_ref_esmvaltool-0.5.3.dist-info/licenses/LICENCE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-climate_ref_esmvaltool-0.5.3.dist-info/licenses/NOTICE,sha256=4qTlax9aX2-mswYJuVrLqJ9jK1IkN5kSBqfVvYLF3Ws,128
-climate_ref_esmvaltool-0.5.3.dist-info/RECORD,,
+climate_ref_esmvaltool-0.5.5.dist-info/METADATA,sha256=ZPRN9S-XD1koXnffBCa1GI42pq5TYM9QCSqkDvlVFhM,2366
+climate_ref_esmvaltool-0.5.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+climate_ref_esmvaltool-0.5.5.dist-info/licenses/LICENCE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+climate_ref_esmvaltool-0.5.5.dist-info/licenses/NOTICE,sha256=4qTlax9aX2-mswYJuVrLqJ9jK1IkN5kSBqfVvYLF3Ws,128
+climate_ref_esmvaltool-0.5.5.dist-info/RECORD,,