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

climate_ref_esmvaltool/recipe.py

@@ -5,14 +5,13 @@ from pathlib import Path
 from typing import TYPE_CHECKING, Any
 
 import pooch
-from ruamel.yaml import YAML
+import yaml
 
 from climate_ref_esmvaltool.types import Recipe
 
 if TYPE_CHECKING:
     import pandas as pd
 
-yaml = YAML()
 
 FACETS = {
     "CMIP6": {
@@ -25,6 +24,13 @@ FACETS = {
         "mip": "table_id",
         "short_name": "variable_id",
     },
+    "obs4MIPs": {
+        "dataset": "source_id",
+        "frequency": "frequency",
+        "grid": "grid_label",
+        "institute": "institution_id",
+        "short_name": "variable_id",
+    },
 }
 
 
@@ -92,7 +98,10 @@ def as_facets(
     return facets
 
 
-def dataframe_to_recipe(files: pd.DataFrame) -> dict[str, Any]:
+def dataframe_to_recipe(
+    files: pd.DataFrame,
+    equalize_timerange: bool = False,
+) -> dict[str, Any]:
     """Convert the datasets dataframe to a recipe "variables" section.
 
     Parameters
@@ -112,11 +121,27 @@ def dataframe_to_recipe(files: pd.DataFrame) -> dict[str, Any]:
         if short_name not in variables:
             variables[short_name] = {"additional_datasets": []}
         variables[short_name]["additional_datasets"].append(facets)
+
+    if equalize_timerange:
+        # Select a timerange covered by all datasets.
+        start_times, end_times = [], []
+        for variable in variables.values():
+            for dataset in variable["additional_datasets"]:
+                if "timerange" in dataset:
+                    start, end = dataset["timerange"].split("/")
+                    start_times.append(start)
+                    end_times.append(end)
+        timerange = f"{max(start_times)}/{min(end_times)}"
+        for variable in variables.values():
+            for dataset in variable["additional_datasets"]:
+                if "timerange" in dataset:
+                    dataset["timerange"] = timerange
+
     return variables
 
 
-_ESMVALTOOL_COMMIT = "58fd0b8ece981bc97c4fbd213b11f2228d90db28"
-_ESMVALTOOL_VERSION = f"2.13.0.dev65+g{_ESMVALTOOL_COMMIT[:9]}"
+_ESMVALTOOL_COMMIT = "2c438d0e0cc8904790294c72450eb7f06552c52a"
+_ESMVALTOOL_VERSION = f"2.13.0.dev148+g{_ESMVALTOOL_COMMIT[:9]}"
 
 _RECIPES = pooch.create(
     path=pooch.os_cache("climate_ref_esmvaltool"),
@@ -144,7 +169,16 @@ def load_recipe(recipe: str) -> Recipe:
         The loaded recipe.
     """
     filename = _RECIPES.fetch(recipe)
-    return yaml.load(Path(filename).read_text(encoding="utf-8"))  # type: ignore[no-any-return]
+
+    def normalize(obj: Any) -> Any:
+        # Ensure objects in the recipe are not shared.
+        if isinstance(obj, dict):
+            return {k: normalize(v) for k, v in obj.items()}
+        if isinstance(obj, list):
+            return [normalize(item) for item in obj]
+        return obj
+
+    return normalize(yaml.safe_load(Path(filename).read_text(encoding="utf-8")))  # type: ignore[no-any-return]
 
 
 def prepare_climate_data(datasets: pd.DataFrame, climate_data_dir: Path) -> None:
@@ -167,6 +201,11 @@ def prepare_climate_data(datasets: pd.DataFrame, climate_data_dir: Path) -> None
         if not isinstance(row.path, str):  # pragma: no branch
             msg = f"Invalid path encountered in {row}"
             raise ValueError(msg)
-        tgt = climate_data_dir.joinpath(*row.instance_id.split(".")) / Path(row.path).name
+        if row.instance_id.startswith("obs4MIPs."):
+            version = row.instance_id.split(".")[-1]
+            subdirs: list[str] = ["obs4MIPs", row.source_id, version]  # type: ignore[list-item]
+        else:
+            subdirs = row.instance_id.split(".")
+        tgt = climate_data_dir.joinpath(*subdirs) / Path(row.path).name
         tgt.parent.mkdir(parents=True, exist_ok=True)
         tgt.symlink_to(row.path)

climate_ref_esmvaltool/recipes.txt

@@ -1,10 +1,16 @@
-examples/recipe_python.yml ab3f06d269bb2c1368f4dc39da9bcb232fb2adb1fa556ba769e6c16294ffb4a3
-recipe_calculate_gwl_exceedance_stats.yml 5aa266abc9a8029649b689a2b369a47623b0935d609354332ff4148994642d6b
-recipe_ecs.yml             0cc57034fcb64e32015b4ff949ece5df8cdb8c6f493618b50ceded119fb37918
-recipe_tcr.yml             35f9ef035a4e71aff5cac5dd26c49da2162fc00291bf3b0bd16b661b7b2f606b
-recipe_tcre.yml            48fc9e3baf541bbcef7491853ea3a774053771dca33352b41466425faeaa38af
-recipe_zec.yml             b0af7f789b7610ab3f29a6617124aa40c40866ead958204fc199eaf82863de51
-ref/recipe_enso_basicclimatology.yml 9ea7deb7ee668e39ac44618b96496d898bd82285c22dcee4fce4695e0c9fa82b
-ref/recipe_enso_characteristics.yml 34c2518b138068ac96d212910b979d54a8fcedee2c0089b5acd56a42c41dc3e4
-ref/recipe_ref_cre.yml     4f35d9639f1008be3b5382a5bd8933a855cb5368ccf5d04a1c70227172e2e82c
-ref/recipe_ref_sea_ice_area_basic.yml 7d01a8527880663ca28284772f83a8356d9972fb4f022a4000e50a56ce044b09
+examples/recipe_python.yml                  ab3f06d269bb2c1368f4dc39da9bcb232fb2adb1fa556ba769e6c16294ffb4a3
+recipe_calculate_gwl_exceedance_stats.yml   5aa266abc9a8029649b689a2b369a47623b0935d609354332ff4148994642d6b
+recipe_ecs.yml                              0cc57034fcb64e32015b4ff949ece5df8cdb8c6f493618b50ceded119fb37918
+recipe_seaice_sensitivity.yml               f7247c076e161c582d422947c8155f3ca98549e6f2e4c3b1c76414786d7e50c5
+recipe_tcr.yml                              35f9ef035a4e71aff5cac5dd26c49da2162fc00291bf3b0bd16b661b7b2f606b
+recipe_tcre.yml                             48fc9e3baf541bbcef7491853ea3a774053771dca33352b41466425faeaa38af
+recipe_zec.yml                              b0af7f789b7610ab3f29a6617124aa40c40866ead958204fc199eaf82863de51
+ref/recipe_enso_basicclimatology.yml        9ea7deb7ee668e39ac44618b96496d898bd82285c22dcee4fce4695e0c9fa82b
+ref/recipe_enso_characteristics.yml         34c2518b138068ac96d212910b979d54a8fcedee2c0089b5acd56a42c41dc3e4
+ref/recipe_ref_annual_cycle_region.yml      64ebc687789dad6c45a2361b45218cb5a0ad0e38c516840c65fc7e8bf7b5ace7
+ref/recipe_ref_cre.yml                      4375f262479c3b3e1b348b71080a6d758e195bda76516a591182045a3a29aa32
+ref/recipe_ref_fire.yml                     2ad82effaca4e742d8abe6a0aa07bb46e1e92ef0d2d240760f7623b0ba045926
+ref/recipe_ref_sea_ice_area_basic.yml       7d01a8527880663ca28284772f83a8356d9972fb4f022a4000e50a56ce044b09
+ref/recipe_ref_scatterplot.yml              b99d1736e16256d161847b025811d7088ad9f892d4887fb009fa99c4079135a0
+ref/recipe_ref_timeseries_region.yml        86f36e442021caba201601d8cf4624f8ce6715ce421670a467c792db2910db22
+ref/recipe_ref_trend_regions.yml            18fe246a51474bd12172ab1ba141efac999a247de7774822f77ae6ef144645fe