climate-ref-esmvaltool 0.6.6__py3-none-any.whl → 0.8.0__py3-none-any.whl

climate_ref_esmvaltool/diagnostics/tcre.py

@@ -13,7 +13,7 @@ from climate_ref_core.datasets import ExecutionDatasetCollection, FacetFilter, S
 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.diagnostics.base import ESMValToolDiagnostic, fillvalues_to_nan
 from climate_ref_esmvaltool.recipe import dataframe_to_recipe
 from climate_ref_esmvaltool.types import MetricBundleArgs, OutputBundleArgs, Recipe
 
@@ -27,10 +27,6 @@ class TransientClimateResponseEmissions(ESMValToolDiagnostic):
     slug = "transient-climate-response-emissions"
     base_recipe = "recipe_tcre.yml"
 
-    experiments = (
-        "esm-1pctCO2",
-        "esm-piControl",
-    )
     variables = (
         "tas",
         "fco2antt",
@@ -42,29 +38,31 @@ class TransientClimateResponseEmissions(ESMValToolDiagnostic):
                 FacetFilter(
                     facets={
                         "variable_id": variables,
-                        "frequency": "mon",
-                        "experiment_id": experiments,
+                        "experiment_id": "esm-1pctCO2",
+                        "table_id": "Amon",
                     },
                 ),
                 FacetFilter(
                     facets={
-                        "variable_id": "fco2antt",
+                        "variable_id": "tas",
                         "experiment_id": "esm-piControl",
+                        "table_id": "Amon",
                     },
-                    keep=False,
                 ),
             ),
             group_by=("source_id", "member_id", "grid_label"),
             constraints=(
-                RequireFacets("experiment_id", experiments),
-                RequireFacets("variable_id", variables),
                 RequireContiguousTimerange(group_by=("instance_id",)),
                 RequireOverlappingTimerange(group_by=("instance_id",)),
+                RequireFacets("experiment_id", ("esm-1pctCO2", "esm-piControl")),
+                RequireFacets("variable_id", variables),
                 AddSupplementaryDataset.from_defaults("areacella", SourceDatasetType.CMIP6),
             ),
         ),
     )
     facets = ("grid_label", "member_id", "source_id", "region", "metric")
+    # TODO: the ESMValTool diagnostic script does not save the data for the timeseries.
+    series = tuple()
 
     @staticmethod
     def update_recipe(
@@ -125,7 +123,7 @@ class TransientClimateResponseEmissions(ESMValToolDiagnostic):
     ) -> tuple[CMECMetric, CMECOutput]:
         """Format the result."""
         tcre_ds = xarray.open_dataset(result_dir / "work" / "tcre" / "calculate_tcre" / "tcre.nc")
-        tcre = float(tcre_ds["tcre"].values[0])
+        tcre = float(fillvalues_to_nan(tcre_ds["tcre"].values)[0])
 
         # Update the diagnostic bundle arguments with the computed diagnostics.
         metric_args[MetricCV.DIMENSIONS.value] = {

climate_ref_esmvaltool/diagnostics/zec.py

@@ -11,9 +11,10 @@ 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.metric_values.typing import SeriesDefinition
 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.diagnostics.base import ESMValToolDiagnostic, fillvalues_to_nan
 from climate_ref_esmvaltool.recipe import dataframe_to_recipe
 from climate_ref_esmvaltool.types import MetricBundleArgs, OutputBundleArgs, Recipe
 
@@ -39,19 +40,32 @@ class ZeroEmissionCommitment(ESMValToolDiagnostic):
                     facets={
                         "variable_id": ("tas",),
                         "experiment_id": experiments,
+                        "table_id": "Amon",
                     },
                 ),
             ),
             group_by=("source_id", "member_id", "grid_label"),
             constraints=(
-                RequireFacets("experiment_id", experiments),
                 RequireContiguousTimerange(group_by=("instance_id",)),
                 RequireOverlappingTimerange(group_by=("instance_id",)),
+                RequireFacets("experiment_id", experiments),
                 AddSupplementaryDataset.from_defaults("areacella", SourceDatasetType.CMIP6),
             ),
         ),
     )
     facets = ("grid_label", "member_id", "source_id", "region", "metric")
+    series = (
+        SeriesDefinition(
+            file_pattern="work/zec/zec/zec.nc",
+            sel={"dim0": 0},
+            dimensions={
+                "statistic": "zec",
+            },
+            values_name="zec",
+            index_name="time",
+            attributes=[],
+        ),
+    )
 
     @staticmethod
     def update_recipe(
@@ -90,7 +104,7 @@ class ZeroEmissionCommitment(ESMValToolDiagnostic):
     ) -> tuple[CMECMetric, CMECOutput]:
         """Format the result."""
         zec_ds = xarray.open_dataset(result_dir / "work" / "zec" / "zec" / "zec_50.nc")
-        zec = float(zec_ds["zec"].values[0])
+        zec = float(fillvalues_to_nan(zec_ds["zec"].values)[0])
 
         # Update the diagnostic bundle arguments with the computed diagnostics.
         metric_args[MetricCV.DIMENSIONS.value] = {

climate_ref_esmvaltool/recipe.py

@@ -87,11 +87,11 @@ def as_facets(
 
     """
     facets = {}
-    first_row = group.iloc[0]
-    project = first_row.instance_id.split(".", 2)[0]
+    project = group.iloc[0].instance_id.split(".", 2)[0]
     facets["project"] = project
     for esmvaltool_name, ref_name in FACETS[project].items():
-        facets[esmvaltool_name] = getattr(first_row, ref_name)
+        values = group[ref_name].unique().tolist()
+        facets[esmvaltool_name] = values if len(values) > 1 else values[0]
     timerange = as_timerange(group)
     if timerange is not None:
         facets["timerange"] = timerange
@@ -100,6 +100,7 @@ def as_facets(
 
 def dataframe_to_recipe(
     files: pd.DataFrame,
+    group_by: tuple[str, ...] = ("instance_id",),
     equalize_timerange: bool = False,
 ) -> dict[str, Any]:
     """Convert the datasets dataframe to a recipe "variables" section.
@@ -108,14 +109,17 @@ def dataframe_to_recipe(
     ----------
     files
         The pandas dataframe describing the input files.
+    group_by
+        The columns to group the input files by.
+    equalize_timerange
+        If True, use the timerange that is covered by all datasets.
 
     Returns
     -------
         A "variables" section that can be used in an ESMValTool recipe.
     """
     variables: dict[str, Any] = {}
-    # TODO: refine to make it possible to combine historical and scenario runs.
-    for _, group in files.groupby("instance_id"):
+    for _, group in files.groupby(list(group_by)):
         facets = as_facets(group)
         short_name = facets.pop("short_name")
         if short_name not in variables:

{climate_ref_esmvaltool-0.6.6.dist-info → climate_ref_esmvaltool-0.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: climate-ref-esmvaltool
-Version: 0.6.6
+Version: 0.8.0
 Summary: ESMValTool diagnostic provider for the Rapid Evaluation Framework
 Author-email: ESMValTool development team <esmvaltool-dev@listserv.dfn.de>, Jared Lewis <jared.lewis@climate-resource.com>
 License-Expression: Apache-2.0
@@ -19,6 +19,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.11
 Requires-Dist: climate-ref-core
+Requires-Dist: netcdf4>=1.7.2
 Requires-Dist: pooch>=1.8
 Requires-Dist: pyyaml
 Requires-Dist: xarray>=2023.3.0

climate_ref_esmvaltool-0.8.0.dist-info/RECORD

@@ -0,0 +1,30 @@
+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=elf_LnZaqXzMnOsh87Kp75SqdmeqFOrcZfDE2lj-bl0,6722
+climate_ref_esmvaltool/recipes.txt,sha256=X8yzdTW-TDJH5j-kJ5aq57ztZ6uvFItelVflJcTNEjs,1744
+climate_ref_esmvaltool/types.py,sha256=luUMNS3LJGJEecVrHRDh5l5ElnQgz7G0auCtA_Jwnno,117
+climate_ref_esmvaltool/dataset_registry/data.txt,sha256=aD5lg5x9O1mn2e9ueKefxmuBGH2OED1sqSdoeLrnIBk,24339
+climate_ref_esmvaltool/diagnostics/__init__.py,sha256=GRCsqpp9XY3p9nWQII05IhfzKSSwAoTQ0vc21mlPEbo,2022
+climate_ref_esmvaltool/diagnostics/base.py,sha256=gYp6wZG8Wy_TFFOt3Wwl0ddncrId6b21oM8o3KaDjS8,12735
+climate_ref_esmvaltool/diagnostics/climate_at_global_warming_levels.py,sha256=hL-aXHjJZKIilUqORBu-LjOe_GYBemszkZlqJuF64rg,4136
+climate_ref_esmvaltool/diagnostics/climate_drivers_for_fire.py,sha256=CadaNKAUNv7MeUNAP-4betQluAXyMTOZJx9OW7h2SwI,3041
+climate_ref_esmvaltool/diagnostics/cloud_radiative_effects.py,sha256=m0y-dFrQOvfgdLI2Y5rSadSQkIi6BLWgY_AfLoGcXco,3495
+climate_ref_esmvaltool/diagnostics/cloud_scatterplots.py,sha256=XKTI6WQZALK_2k2IQIz4xcxnOHQ3I5SjscxRac7tFAY,7460
+climate_ref_esmvaltool/diagnostics/ecs.py,sha256=tH80UWBViYWjVCGqi3aLId3wPcksFWHfXA9anlRTWXE,5651
+climate_ref_esmvaltool/diagnostics/enso.py,sha256=QGlOAbMIrbHdCxhJ_oxNVlhE4n13gkIuYLgNQMuG-PI,9215
+climate_ref_esmvaltool/diagnostics/example.py,sha256=-6nsJnRJJx4E1ZHlAe_MRbdJdVSoKviPdSQgYyrVwDA,2453
+climate_ref_esmvaltool/diagnostics/regional_historical_changes.py,sha256=LuIoYJ0OyX78fjgJ1aEFU3xNa9J3omH_hcAm0vmGIqo,15746
+climate_ref_esmvaltool/diagnostics/sea_ice_area_basic.py,sha256=yuqe4HbANXJD78iHEHlXoL6BMpRD8hq-tecfexuLgx0,4980
+climate_ref_esmvaltool/diagnostics/sea_ice_sensitivity.py,sha256=F0UnoWScbBtVzgC7iMvxGMZIQDPa6uu5Oj05BIP_T0U,4790
+climate_ref_esmvaltool/diagnostics/tcr.py,sha256=RrLnO_ox_wnHBHlD6qDxMgvrmqk4off7iFUvg7PnH3M,4701
+climate_ref_esmvaltool/diagnostics/tcre.py,sha256=0dihcBODDmalwohJLcarmvdM3g7S3nkCAzbU5zksxR0,5564
+climate_ref_esmvaltool/diagnostics/zec.py,sha256=WEQKw90Jm-QisAGh7B9AskpMMSM1ojCrvoNmomaFw4Q,4447
+climate_ref_esmvaltool/requirements/conda-lock.yml,sha256=XPQEC3mUJ7Yyr-UaFtbBaceA2pPP22f7JtOTmO1dBDY,596683
+climate_ref_esmvaltool/requirements/environment.yml,sha256=9yDKJyQpOgNx1hbjuncjrqCjTZJ4EhGXmP7fBCI1tyI,88
+climate_ref_esmvaltool-0.8.0.dist-info/METADATA,sha256=Hhl_gov6y5H90--Tuf3gn4kOHjm5ADfCAg4_UB0qs-o,2444
+climate_ref_esmvaltool-0.8.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+climate_ref_esmvaltool-0.8.0.dist-info/entry_points.txt,sha256=zhPwPv0Fu67MgdOCF8GAilZUHa9wl4T4xlkQ3HX4Sno,69
+climate_ref_esmvaltool-0.8.0.dist-info/licenses/LICENCE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+climate_ref_esmvaltool-0.8.0.dist-info/licenses/NOTICE,sha256=4qTlax9aX2-mswYJuVrLqJ9jK1IkN5kSBqfVvYLF3Ws,128
+climate_ref_esmvaltool-0.8.0.dist-info/RECORD,,

{climate_ref_esmvaltool-0.6.6.dist-info → climate_ref_esmvaltool-0.8.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

climate_ref_esmvaltool-0.6.6.dist-info/RECORD

@@ -1,30 +0,0 @@
-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=m8-wWVRla2VRzkZWx2M-Okjvr0X2wUon0ZgXHcTALcw,6561
-climate_ref_esmvaltool/recipes.txt,sha256=X8yzdTW-TDJH5j-kJ5aq57ztZ6uvFItelVflJcTNEjs,1744
-climate_ref_esmvaltool/types.py,sha256=luUMNS3LJGJEecVrHRDh5l5ElnQgz7G0auCtA_Jwnno,117
-climate_ref_esmvaltool/dataset_registry/data.txt,sha256=aD5lg5x9O1mn2e9ueKefxmuBGH2OED1sqSdoeLrnIBk,24339
-climate_ref_esmvaltool/diagnostics/__init__.py,sha256=GRCsqpp9XY3p9nWQII05IhfzKSSwAoTQ0vc21mlPEbo,2022
-climate_ref_esmvaltool/diagnostics/base.py,sha256=nfNviO8pAftm_OlwNMzJ2cb2bb7_QaTNO-UmEfUPf6Q,10917
-climate_ref_esmvaltool/diagnostics/climate_at_global_warming_levels.py,sha256=mkA6WHR_GIdnYwjsaoRbWIgc4nAYD2wtgwmJ7JCsYoM,3605
-climate_ref_esmvaltool/diagnostics/climate_drivers_for_fire.py,sha256=CatVUeVixzeGHITJrZfa47cICI79uKxOZ9tYIK4CLKw,2198
-climate_ref_esmvaltool/diagnostics/cloud_radiative_effects.py,sha256=hmncLzKwZh5zTXUJb_08AVQa6JJqofKIdpdZ1RdAxTk,2865
-climate_ref_esmvaltool/diagnostics/cloud_scatterplots.py,sha256=TKjaQWGWx495IVH8LXGCf0OuDJk37oI0vH7c81Savgc,7169
-climate_ref_esmvaltool/diagnostics/ecs.py,sha256=c1VsowWSJKU0PbZR1dpQnkWSWSr2o3aUK3AGTMsGa30,4818
-climate_ref_esmvaltool/diagnostics/enso.py,sha256=LfaXbf0VRe14stfWXNv7OwfBEVTI7XDpmYtgIos3Dzw,5505
-climate_ref_esmvaltool/diagnostics/example.py,sha256=uJUBmJ9g0OBI_y8JKyH_tAV9BKC6P1Sjc2L31n03I6g,2347
-climate_ref_esmvaltool/diagnostics/regional_historical_changes.py,sha256=dBy-sVGCcgqKzugw5ZaF2KlsTym7QTmpR4lcF_ahS1E,12279
-climate_ref_esmvaltool/diagnostics/sea_ice_area_basic.py,sha256=95DL1PZfB2JoQSloh9cyLb_qeiUBSItxGC4QX5uJcRE,3253
-climate_ref_esmvaltool/diagnostics/sea_ice_sensitivity.py,sha256=-70cmXEi2sM6wFxUiP4sGZCGf9TrR1cvFM-8j5yeo-4,4267
-climate_ref_esmvaltool/diagnostics/tcr.py,sha256=MhhGMPXfkEh-IEOPNYcS2G-SgFMGkfp-FRu0TRk2jZI,4196
-climate_ref_esmvaltool/diagnostics/tcre.py,sha256=KiByhNnf2aicO9ysEwPvwA-VTWmo_bSKn-Za8IH8DcE,5461
-climate_ref_esmvaltool/diagnostics/zec.py,sha256=UvtKbzdgdREmCFH5_OIftGSrClEytbiI2q_VK5cNOfU,3998
-climate_ref_esmvaltool/requirements/conda-lock.yml,sha256=XPQEC3mUJ7Yyr-UaFtbBaceA2pPP22f7JtOTmO1dBDY,596683
-climate_ref_esmvaltool/requirements/environment.yml,sha256=9yDKJyQpOgNx1hbjuncjrqCjTZJ4EhGXmP7fBCI1tyI,88
-climate_ref_esmvaltool-0.6.6.dist-info/METADATA,sha256=vHod-PQNao0QkHepPatnA2QhwFydzOIQxJLYd83lqQg,2414
-climate_ref_esmvaltool-0.6.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-climate_ref_esmvaltool-0.6.6.dist-info/entry_points.txt,sha256=zhPwPv0Fu67MgdOCF8GAilZUHa9wl4T4xlkQ3HX4Sno,69
-climate_ref_esmvaltool-0.6.6.dist-info/licenses/LICENCE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-climate_ref_esmvaltool-0.6.6.dist-info/licenses/NOTICE,sha256=4qTlax9aX2-mswYJuVrLqJ9jK1IkN5kSBqfVvYLF3Ws,128
-climate_ref_esmvaltool-0.6.6.dist-info/RECORD,,