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

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

@@ -1,14 +1,15 @@
 Metadata-Version: 2.4
 Name: climate-ref-esmvaltool
-Version: 0.5.4
+Version: 0.6.0
 Summary: ESMValTool diagnostic provider for the Rapid Evaluation Framework
-Author-email: ESMValTool development team <esmvaltool-dev@listserv.dfn.de>
-License: Apache-2.0
+Author-email: ESMValTool development team <esmvaltool-dev@listserv.dfn.de>, Jared Lewis <jared.lewis@climate-resource.com>
+License-Expression: 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.6.0}/pyproject.toml

@@ -1,16 +1,18 @@
 [project]
 name = "climate-ref-esmvaltool"
-version = "0.5.4"
+version = "0.6.0"
 description = "ESMValTool diagnostic provider for the Rapid Evaluation Framework"
 readme = "README.md"
 authors = [
-    { name = "ESMValTool development team", email = "esmvaltool-dev@listserv.dfn.de " }
+    { name = "ESMValTool development team", email = "esmvaltool-dev@listserv.dfn.de" },
+    { name = "Jared Lewis", email = "jared.lewis@climate-resource.com" },
 ]
+license = "Apache-2.0"
 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 +20,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",
@@ -26,9 +29,6 @@ dependencies = [
     "xarray >= 2023.3.0",
 ]
 
-[project.license]
-text = "Apache-2.0"
-
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.6.0}/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.6.0}/src/climate_ref_esmvaltool/dataset_registry/data.txt

@@ -1,3 +1,4 @@
+ESMValTool/obs4MIPs/GPCP-V2.3/v20180519/pr_GPCP-SG_L3_v2.3_197901-201710.nc 4dd4678b79ef139446c8406da5aae4fed210abb2f2160ef95f6988bf83e4525b
 ESMValTool/OBS/Tier2/CERES-EBAF/OBS_CERES-EBAF_sat_Ed4.2_Amon_rlut_200003-202311.nc ede887cf2d83c848a0d71316799232e4d717662bd2f78d5aa1fc166b41d9953b
 ESMValTool/OBS/Tier2/CERES-EBAF/OBS_CERES-EBAF_sat_Ed4.2_Amon_rlutcs_200003-202311.nc e70e3273092edf01527970693271641fc6474d1974887d7d272e7d656bab83c2
 ESMValTool/OBS/Tier2/CERES-EBAF/OBS_CERES-EBAF_sat_Ed4.2_Amon_rsut_200003-202311.nc e31e648886c4fa9c09686672a06ab18fbba687ff0d6de2891616d4c8b74e215d
@@ -84,3 +85,5 @@ ESMValTool/OBS/Tier2/OSI-450-sh/OBS_OSI-450-sh_reanaly_v3_OImon_sic_201101-20111
 ESMValTool/OBS/Tier2/OSI-450-sh/OBS_OSI-450-sh_reanaly_v3_OImon_sic_201201-201212.nc 86187c3d1174053f2cba6dad010af49ceab77d368aa9314bf53c330b5f2217b9
 ESMValTool/OBS/Tier2/OSI-450-sh/OBS_OSI-450-sh_reanaly_v3_OImon_sic_201301-201312.nc 8820353570884b2ef182caaffb5986ed6268bbe199fd867f61b56e798ca01f1a
 ESMValTool/OBS/Tier2/OSI-450-sh/OBS_OSI-450-sh_reanaly_v3_OImon_sic_201401-201412.nc 7102d0db3dc02c5b0eb0cfe3535ee50171007ef5b43eb9aae1220ac21b0b98e9
+ESMValTool/OBS/Tier2/TROPFLUX/OBS6_TROPFLUX_reanaly_v1_Amon_tauu_197901-201812.nc bf313e661b42341d5090038b501ed1ff09e58201009c3fccfe45b78e116fdd78
+ESMValTool/OBS/Tier2/TROPFLUX/OBS6_TROPFLUX_reanaly_v1_Omon_tos_197901-201812.nc 5f10a5a2aa47f5d21378ad3178bf8e4b577b0ed72ef8402dc04f5ff6fc99ec07

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.6.0}/src/climate_ref_esmvaltool/diagnostics/__init__.py

@@ -3,8 +3,9 @@
 from climate_ref_esmvaltool.diagnostics.climate_at_global_warming_levels import ClimateAtGlobalWarmingLevels
 from climate_ref_esmvaltool.diagnostics.cloud_radiative_effects import CloudRadiativeEffects
 from climate_ref_esmvaltool.diagnostics.ecs import EquilibriumClimateSensitivity
+from climate_ref_esmvaltool.diagnostics.enso import ENSOBasicClimatology, ENSOCharacteristics
 from climate_ref_esmvaltool.diagnostics.example import GlobalMeanTimeseries
-from climate_ref_esmvaltool.diagnostics.sea_ice_area_seasonal_cycle import SeaIceAreaSeasonalCycle
+from climate_ref_esmvaltool.diagnostics.sea_ice_area_basic import SeaIceAreaBasic
 from climate_ref_esmvaltool.diagnostics.tcr import TransientClimateResponse
 from climate_ref_esmvaltool.diagnostics.tcre import TransientClimateResponseEmissions
 from climate_ref_esmvaltool.diagnostics.zec import ZeroEmissionCommitment
@@ -12,9 +13,11 @@ from climate_ref_esmvaltool.diagnostics.zec import ZeroEmissionCommitment
 __all__ = [
     "ClimateAtGlobalWarmingLevels",
     "CloudRadiativeEffects",
+    "ENSOBasicClimatology",
+    "ENSOCharacteristics",
     "EquilibriumClimateSensitivity",
     "GlobalMeanTimeseries",
-    "SeaIceAreaSeasonalCycle",
+    "SeaIceAreaBasic",
     "TransientClimateResponse",
     "TransientClimateResponseEmissions",
     "ZeroEmissionCommitment",

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.6.0}/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]:
         """
@@ -101,15 +101,17 @@ class ESMValToolDiagnostic(CommandLineDiagnostic):
         config = {
             "drs": {
                 "CMIP6": "ESGF",
+                "obs4MIPs": "ESGF",
             },
             "output_dir": str(definition.to_output_path("executions")),
             "rootpath": {
-                "default": str(climate_data),
+                "CMIP6": str(climate_data),
+                "obs4MIPs": str(climate_data),
             },
             "search_esgf": "never",
         }
 
-        # Configure the paths to OBS/OBS6/native6 data
+        # Configure the paths to OBS/OBS6/native6 and non-compliant obs4MIPs data
         registry = dataset_registry_manager["esmvaltool"]
         data_dir = registry.abspath / "ESMValTool"  # type: ignore[attr-defined]
         if not data_dir.exists():
@@ -129,10 +131,14 @@ class ESMValToolDiagnostic(CommandLineDiagnostic):
             config["rootpath"].update(  # type: ignore[attr-defined]
                 {
                     "OBS": str(data_dir / "OBS"),
-                    "OBS6": str(data_dir / "OBS6"),
+                    "OBS6": str(data_dir / "OBS"),
                     "native6": str(data_dir / "RAWOBS"),
                 }
             )
+            config["rootpath"]["obs4MIPs"] = [  # type: ignore[index]
+                config["rootpath"]["obs4MIPs"],  # type: ignore[index]
+                str(data_dir),
+            ]
 
         config_dir = definition.to_output_path("config")
         config_dir.mkdir()
@@ -198,15 +204,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.6.0}/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.6.0/src/climate_ref_esmvaltool/diagnostics/enso.py

@@ -0,0 +1,155 @@
+from pathlib import Path
+
+import pandas
+import pandas as pd
+
+from climate_ref_core.constraints import (
+    AddSupplementaryDataset,
+    RequireContiguousTimerange,
+    RequireFacets,
+    RequireOverlappingTimerange,
+)
+from climate_ref_core.datasets import ExecutionDatasetCollection, FacetFilter, SourceDatasetType
+from climate_ref_core.diagnostics import DataRequirement
+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
+
+
+class ENSOBasicClimatology(ESMValToolDiagnostic):
+    """
+    Calculate the ENSO CLIVAR metrics - background climatology.
+    """
+
+    name = "ENSO Basic Climatology"
+    slug = "enso-basic-climatology"
+    base_recipe = "ref/recipe_enso_basicclimatology.yml"
+
+    variables = (
+        "pr",
+        "tos",
+        "tauu",
+    )
+    data_requirements = (
+        DataRequirement(
+            source_type=SourceDatasetType.CMIP6,
+            filters=(
+                FacetFilter(
+                    facets={
+                        "variable_id": variables,
+                        "experiment_id": "historical",
+                    },
+                ),
+            ),
+            group_by=("source_id", "member_id", "grid_label"),
+            constraints=(
+                RequireFacets("variable_id", variables),
+                RequireContiguousTimerange(group_by=("instance_id",)),
+                RequireOverlappingTimerange(group_by=("instance_id",)),
+            ),
+        ),
+    )
+    facets = ()
+
+    @staticmethod
+    def update_recipe(recipe: Recipe, input_files: pandas.DataFrame) -> None:
+        """Update the recipe."""
+        recipe_variables = dataframe_to_recipe(input_files)
+        recipe.pop("datasets")
+        for diagnostic in recipe["diagnostics"].values():
+            for variable in diagnostic["variables"].values():
+                variable["additional_datasets"].extend(
+                    recipe_variables[variable["short_name"]]["additional_datasets"]
+                )
+
+
+class ENSOCharacteristics(ESMValToolDiagnostic):
+    """
+    Calculate the ENSO CLIVAR metrics - basic ENSO characteristics.
+    """
+
+    name = "ENSO Characteristics"
+    slug = "enso-characteristics"
+    base_recipe = "ref/recipe_enso_characteristics.yml"
+
+    data_requirements = (
+        DataRequirement(
+            source_type=SourceDatasetType.CMIP6,
+            filters=(
+                FacetFilter(
+                    facets={
+                        "variable_id": "tos",
+                        "experiment_id": "historical",
+                    },
+                ),
+            ),
+            group_by=("source_id", "member_id", "grid_label"),
+            constraints=(
+                RequireFacets("variable_id", ("tos",)),
+                RequireContiguousTimerange(group_by=("instance_id",)),
+                RequireOverlappingTimerange(group_by=("instance_id",)),
+                AddSupplementaryDataset.from_defaults("areacello", SourceDatasetType.CMIP6),
+            ),
+        ),
+    )
+    facets = ("grid_label", "member_id", "source_id", "region", "metric")
+
+    @staticmethod
+    def update_recipe(recipe: Recipe, input_files: pandas.DataFrame) -> None:
+        """Update the recipe."""
+        recipe_variables = dataframe_to_recipe(input_files)
+        recipe["datasets"] = recipe_variables["tos"]["additional_datasets"]
+        # TODO: update the observational data requirement once available on ESGF.
+        # Observations - use only one per run
+        recipe["datasets"].append(
+            # {
+            #     "dataset": "NOAA-ERSSTv5",
+            #     "version": "v5",
+            #     "project": "OBS6",
+            #     "type": "reanaly",
+            #     "tier": 2,
+            # }
+            {
+                "dataset": "TROPFLUX",
+                "version": "v1",
+                "project": "OBS6",
+                "type": "reanaly",
+                "tier": 2,
+            }
+        )
+
+    @staticmethod
+    def format_result(
+        result_dir: Path,
+        execution_dataset: ExecutionDatasetCollection,
+        metric_args: MetricBundleArgs,
+        output_args: OutputBundleArgs,
+    ) -> tuple[CMECMetric, CMECOutput]:
+        """Format the result."""
+        metrics = pd.read_csv(
+            result_dir / "work" / "diagnostic_metrics" / "plot_script" / "matrix.csv",
+            names=["dataset", "metric_name", "metric_value"],
+        )
+
+        # Update the diagnostic bundle arguments with the computed diagnostics.
+        metric_args[MetricCV.DIMENSIONS.value] = {
+            "json_structure": [
+                "region",
+                "metric",
+            ],
+            "region": {"global": {}},
+            "metric": {metric: {} for metric in metrics.metric_name},
+        }
+        metric_args[MetricCV.RESULTS.value] = {
+            "global": {
+                metric_name: metric_value
+                for metric_name, metric_value in zip(
+                    metrics.metric_name,
+                    metrics.metric_value,
+                )
+            },
+        }
+
+        return CMECMetric.model_validate(metric_args), CMECOutput.model_validate(output_args)

climate_ref_esmvaltool-0.5.4/src/climate_ref_esmvaltool/diagnostics/sea_ice_area_seasonal_cycle.py → climate_ref_esmvaltool-0.6.0/src/climate_ref_esmvaltool/diagnostics/sea_ice_area_basic.py

@@ -11,13 +11,13 @@ from climate_ref_esmvaltool.recipe import dataframe_to_recipe
 from climate_ref_esmvaltool.types import Recipe
 
 
-class SeaIceAreaSeasonalCycle(ESMValToolDiagnostic):
+class SeaIceAreaBasic(ESMValToolDiagnostic):
     """
     Calculate seasonal cycle and time series of NH and SH sea ice area.
     """
 
-    name = "Sea ice area seasonal cycle"
-    slug = "sea-ice-area-seasonal-cycle"
+    name = "Sea ice area basic"
+    slug = "sea-ice-area-basic"
     base_recipe = "ref/recipe_ref_sea_ice_area_basic.yml"
 
     data_requirements = (
@@ -44,14 +44,13 @@ class SeaIceAreaSeasonalCycle(ESMValToolDiagnostic):
     @staticmethod
     def update_recipe(recipe: Recipe, input_files: pandas.DataFrame) -> None:
         """Update the recipe."""
-        # Overlap between observations and historical experiment.
-        timerange = "1995/2014"
-
         # Update datasets
         recipe_variables = dataframe_to_recipe(input_files)
         recipe["datasets"] = recipe_variables["siconc"]["additional_datasets"]
+
+        # Use the timerange from the recipe, as defined in the variable.
         for dataset in recipe["datasets"]:
-            dataset["timerange"] = timerange
+            dataset.pop("timerange")
 
         # Update observational datasets
         nh_obs = {
@@ -65,7 +64,6 @@ class SeaIceAreaSeasonalCycle(ESMValToolDiagnostic):
                 },
             ],
             "tier": 2,
-            "timerange": timerange,
             "type": "reanaly",
             "version": "v3",
         }
@@ -76,3 +74,10 @@ class SeaIceAreaSeasonalCycle(ESMValToolDiagnostic):
         diagnostics["siarea_min"]["variables"]["sea_ice_area_sh_feb"]["additional_datasets"] = [sh_obs]
         diagnostics["siarea_seas"]["variables"]["sea_ice_area_nh"]["additional_datasets"] = [nh_obs]
         diagnostics["siarea_seas"]["variables"]["sea_ice_area_sh"]["additional_datasets"] = [sh_obs]
+
+        # Update the captions.
+        dataset = "{dataset}.{ensemble}.{grid}".format(**recipe["datasets"][0])
+        for diagnostic in diagnostics.values():
+            for script_settings in diagnostic["scripts"].values():
+                for plot_settings in script_settings["plots"].values():
+                    plot_settings["caption"] = plot_settings["caption"].replace("[dataset]", dataset)

{climate_ref_esmvaltool-0.5.4 → climate_ref_esmvaltool-0.6.0}/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)