climate-ref-ilamb 0.5.5__tar.gz → 0.6.1__tar.gz

{climate_ref_ilamb-0.5.5 → climate_ref_ilamb-0.6.1}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: climate-ref-ilamb
-Version: 0.5.5
+Version: 0.6.1
 Summary: ILAMB diagnostic provider for the Rapid Evaluation Framework
-Author-email: Nathan Collier <nathaniel.collier@gmail.com>
-License: Apache-2.0
+Author-email: Nathan Collier <nathaniel.collier@gmail.com>, Jared Lewis <jared.lewis@climate-resource.com>
+License-Expression: Apache-2.0
 License-File: LICENCE
 License-File: NOTICE
 Classifier: Development Status :: 3 - Alpha
@@ -19,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.11
 Requires-Dist: climate-ref-core
-Requires-Dist: ilamb3>=2025.4.28
+Requires-Dist: ilamb3>=2025.5.20
 Description-Content-Type: text/markdown
 
 # climate-ref-ilamb

climate_ref_ilamb-0.6.1/pyproject.toml

@@ -0,0 +1,32 @@
+[project]
+name = "climate-ref-ilamb"
+version = "0.6.1"
+description = "ILAMB diagnostic provider for the Rapid Evaluation Framework"
+readme = "README.md"
+authors = [
+  { name = "Nathan Collier", email = "nathaniel.collier@gmail.com" },
+  { name = "Jared Lewis", email = "jared.lewis@climate-resource.com" },
+]
+requires-python = ">=3.11"
+license = "Apache-2.0"
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Operating System :: OS Independent",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Scientific/Engineering",
+  "License :: OSI Approved :: Apache Software License",
+]
+dependencies = ["climate-ref-core", "ilamb3>=2025.5.20"]
+
+[dependency-groups]
+dev = ["types-pyyaml>=6.0.12"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

{climate_ref_ilamb-0.5.5 → climate_ref_ilamb-0.6.1}/src/climate_ref_ilamb/configure/ilamb.yaml

@@ -2,6 +2,7 @@ registry: ilamb
 
 gpp-WECANN:
   sources:
+    # TODO: Update to use the obs4REF equiv
     gpp: ilamb/gpp/WECANN/gpp.nc
   relationships:
     pr: ilamb/pr/GPCPv2.3/pr.nc
@@ -15,6 +16,7 @@ gpp-FLUXNET2015:
 
 mrro-LORA:
   sources:
+    # TODO: Update to use the obs4REF equiv
     mrro: ilamb/mrro/LORA/LORA.nc
   variable_cmap: Blues
 
@@ -23,14 +25,15 @@ mrsos-WangMao:
     mrsol: ilamb/mrsol/WangMao/mrsol_olc.nc
   alternate_vars:
   - mrsos
-  depth: 0.0
   transform:
+  - select_depth:
+      value: 0
   - soil_moisture_to_vol_fraction
   variable_cmap: Blues
 
 cSoil-HWSD2:
   sources:
-    cSoil: ilamb/cSoil/HWSD2/hwsd2_cSoil.nc
+    cSoil: ilamb/cSoil/HWSD2/cSoil_fx_HWSD2_19600101-20220101.nc
   variable_cmap: viridis
 
 lai-AVH15C1:
@@ -42,4 +45,15 @@ nbp-Hoffman:
   analyses:
   - nbp
   sources:
+    # TODO: Update to use the obs4REF equiv
     nbp: ilamb/nbp/HOFFMAN/nbp_1850-2010.nc
+
+snc-ESACCI:
+  sources:
+    snc: ilamb/snc/Snow-cci/snc_mon_Snow-cci_BE_gn_198201-201906.nc
+
+burntFractionAll-GFED:
+  sources:
+    burntArea: ilamb/burntFractionAll/GFED/burntArea.nc
+  alternate_vars:
+  - burntFractionAll

climate_ref_ilamb-0.6.1/src/climate_ref_ilamb/configure/iomb.yaml

@@ -0,0 +1,49 @@
+registry: iomb
+
+thetao-WOA2023-surface:
+  sources:
+    # TODO: Update to use the obs4REF equiv
+    thetao: ilamb/WOA/thetao_mon_WOA_A5B4_gn_200501-201412.nc
+  variable_cmap: Reds
+  transform:
+  - select_depth:
+      value: 0
+  alternate_vars:
+  - tos
+
+so-WOA2023-surface:
+  sources:
+    # TODO: Update to use the obs4REF equiv
+    so: ilamb/WOA/so_mon_WOA_A5B4_gn_200501-201412.nc
+  transform:
+  - select_depth:
+      value: 0
+  variable_cmap: YlGn
+  alternate_vars:
+  - sos
+
+amoc-RAPID:
+  analyses:
+  - timeseries
+  related_vars:
+  - msftmz
+  transform:
+  - msftmz_to_rapid
+  sources:
+    # TODO: Update to use the obs4REF equiv
+    amoc: ilamb/RAPID/amoc_mon_RAPID_BE_NA_200404-202302.nc
+
+ohc-NOAA:
+  sources:
+    ohc: ilamb/NOAA/ohc_yr_OHC_BE_gm_200506-202406.nc
+  related_vars:
+  - thetao
+  - volcello
+  transform:
+  - select_depth:
+      min: 0
+      max: 2000
+  - ocean_heat_content:
+      reference_year: 2005
+  analyses:
+  - accumulate

{climate_ref_ilamb-0.5.5 → climate_ref_ilamb-0.6.1}/src/climate_ref_ilamb/dataset_registry/ilamb.txt

@@ -1,4 +1,4 @@
-ilamb/cSoil/HWSD2/hwsd2_cSoil.nc sha1:9a6377e4c5ff457c08c194d2c376c46e003a4f84
+ilamb/cSoil/HWSD2/cSoil_fx_HWSD2_19600101-20220101.nc sha1:7138b0b53aa600878adf95e6aef65f4322a8e287
 ilamb/gpp/FLUXNET2015/gpp.nc sha1:16fd177e007caef2565687e2cd32884e20ef16e5
 ilamb/gpp/WECANN/gpp.nc sha1:6e864a6ae201195cdf995a3a81720188af441e13
 ilamb/lai/AVH15C1/lai.nc sha1:ccace4f84912d63acbb9ee09ee7b743412207a0d
@@ -9,3 +9,5 @@ ilamb/regions/Koppen_coarse.nc sha1:e464030db49f0295a6a22a81ca602b0f3c499b72
 ilamb/pr/GPCPv2.3/pr.nc sha1:e1b942863ec76a75aa972b6d75e2e08646741259
 ilamb/tas/CRU4.02/tas.nc sha1:2674da18a1a93483b50b1626e7a7ab741bf53d09
 ilamb/nbp/HOFFMAN/nbp_1850-2010.nc sha1:8350af00614d6afc6b70ad314aa499a9ece80ec2
+ilamb/snc/Snow-cci/snc_mon_Snow-cci_BE_gn_198201-201906.nc sha1:c0bfecd2f8b886e9301428d28bb6ff0507601be2
+ilamb/burntFractionAll/GFED/burntArea.nc sha1:cf9d73c6a8bfc594737c9ba6ca4df613df4a28ab

{climate_ref_ilamb-0.5.5 → climate_ref_ilamb-0.6.1}/src/climate_ref_ilamb/dataset_registry/iomb.txt

@@ -1,3 +1,4 @@
 ilamb/WOA/so_mon_WOA_A5B4_gn_200501-201412.nc sha1:831c42c3b2ba443c255150289a2c725d7f3e5838
 ilamb/WOA/thetao_mon_WOA_A5B4_gn_200501-201412.nc sha1:86d9056208291d76233e65b26c658c1fa54c3ea6
 ilamb/RAPID/amoc_mon_RAPID_BE_NA_200404-202302.nc sha1:3efe773e5c2a3c832977791ff7fd9cb9f473fe65
+ilamb/NOAA/ohc_yr_OHC_BE_gm_200506-202406.nc sha1:a918799d8e24e4f0015b9047a74d470ae9f0445c

{climate_ref_ilamb-0.5.5 → climate_ref_ilamb-0.6.1}/src/climate_ref_ilamb/standard.py

@@ -8,6 +8,7 @@ import pandas as pd
 import pooch
 from ilamb3 import run
 
+from climate_ref_core.constraints import AddSupplementaryDataset
 from climate_ref_core.dataset_registry import dataset_registry_manager
 from climate_ref_core.datasets import FacetFilter, SourceDatasetType
 from climate_ref_core.diagnostics import (
@@ -104,14 +105,14 @@ def _build_cmec_bundle(df: pd.DataFrame) -> dict[str, Any]:
     # This assumes that the member_id and grid_label are always the last two parts of the source string
     # and don't contain '-'
     extracted_source = model_df.source.str.extract(r"([\w-]+)-([\w\d]+)-([\w\d]+)")
-    model_df["source_id"] = extracted_source[0]
-    model_df["member_id"] = extracted_source[1]
-    model_df["grid_label"] = extracted_source[2]
+    model_df.loc[:, "source_id"] = extracted_source[0]
+    model_df.loc[:, "member_id"] = extracted_source[1]
+    model_df.loc[:, "grid_label"] = extracted_source[2]
 
     # Strip out units from the name
     # These are available in the attributes
     extracted_source = model_df.name.str.extract(r"(.*)\s\[.*\]")
-    model_df["name"] = extracted_source[0]
+    model_df.loc[:, "name"] = extracted_source[0]
 
     model_df = model_df.rename(
         columns={
@@ -120,6 +121,10 @@ def _build_cmec_bundle(df: pd.DataFrame) -> dict[str, Any]:
         }
     )
 
+    # Convert the value column to numeric, coercing errors to NaN
+    model_df.loc[:, "value"] = pd.to_numeric(model_df["value"], errors="coerce")
+    model_df = model_df.astype({"value": "float64"})
+
     dimensions = ["experiment_id", "source_id", "member_id", "grid_label", "region", "metric", "statistic"]
     attributes = ["type", "units"]
 
@@ -165,15 +170,6 @@ def _set_ilamb3_options(registry: pooch.Pooch, registry_file: str) -> None:
         ilamb3.conf.set(regions=["global", "tropical"])
 
 
-def _measure_facets(registry_file: str) -> list[str]:
-    """
-    Set options for ILAMB based on which registry file is being used.
-    """
-    if registry_file == "ilamb":
-        return ["areacella", "sftlf"]
-    return []
-
-
 def _load_csv_and_merge(output_directory: Path) -> pd.DataFrame:
     """
     Load individual csv scalar data and merge into a dataframe.
@@ -219,12 +215,23 @@ class ILAMBStandard(Diagnostic):
                                 self.variable_id,
                                 *ilamb_kwargs.get("relationships", {}).keys(),
                                 *ilamb_kwargs.get("alternate_vars", []),
-                                *_measure_facets(registry_file),
+                                *ilamb_kwargs.get("related_vars", []),
                             )
                         }
                     ),
-                    FacetFilter(facets={"frequency": ("mon", "fx")}),
+                    FacetFilter(facets={"frequency": ("mon",)}),
                     FacetFilter(facets={"experiment_id": ("historical", "land-hist")}),
+                    # Exclude unneeded snc tables
+                    FacetFilter(facets={"table_id": ("ImonAnt", "ImonGre")}, keep=False),
+                ),
+                constraints=(
+                    AddSupplementaryDataset.from_defaults("areacella", SourceDatasetType.CMIP6),
+                    AddSupplementaryDataset.from_defaults("sftlf", SourceDatasetType.CMIP6),
+                )
+                if registry_file == "ilamb"
+                else (
+                    AddSupplementaryDataset.from_defaults("areacello", SourceDatasetType.CMIP6),
+                    AddSupplementaryDataset.from_defaults("sftof", SourceDatasetType.CMIP6),
                 ),
                 group_by=("experiment_id",),
             ),

{climate_ref_ilamb-0.5.5 → climate_ref_ilamb-0.6.1}/tests/integration/test_diagnostics.py

@@ -4,8 +4,7 @@ from climate_ref_ilamb import provider as ilamb_provider
 from climate_ref_core.diagnostics import Diagnostic
 
 skipped_diagnostics = [
-    "csoil-hwsd2",  # Incorrect time spans
-    "nbp-hoffman",  # Incorrect time spans
+    "ohc-noaa",  # Missing sample data
 ]
 
 diagnostics = [

{climate_ref_ilamb-0.5.5 → climate_ref_ilamb-0.6.1}/tests/unit/test_standard_metrics.py

@@ -1,9 +1,12 @@
 import ilamb3
+import pandas as pd
 import pytest
 from climate_ref_ilamb.standard import ILAMBStandard, _set_ilamb3_options
+from climate_ref_pmp import provider as ilamb_provider
 
+from climate_ref.solver import solve_executions
 from climate_ref_core.dataset_registry import dataset_registry_manager
-from climate_ref_core.datasets import DatasetCollection
+from climate_ref_core.datasets import DatasetCollection, SourceDatasetType
 
 
 def test_standard_site(cmip6_data_catalog, definition_factory):
@@ -94,3 +97,49 @@ def test_standard_fail():
 def test_options():
     _set_ilamb3_options(dataset_registry_manager["ilamb"], "ilamb")
     assert set(["global", "tropical"]).issubset(ilamb3.conf["regions"])
+
+
+def test_expected_executions():
+    diagnostic = ILAMBStandard(
+        registry_file="ilamb",
+        metric_name="cSoil-HWSD2",
+        sources={"cSoil": "ilamb/cSoil/HWSD2/cSoil_fx_HWSD2_19600101-20220101.nc"},
+    )
+
+    # No Obs4MIPs datasets are used yet
+    data_catalog = {
+        SourceDatasetType.CMIP6: pd.DataFrame(
+            [
+                ["cSoil", "ACCESS-ESM1-5", "historical", "r1i1p1f1", "mon", "gn", "Amon", "v20191115"],
+                ["cSoil", "ACCESS-ESM1-5", "ssp119", "r1i1p1f1", "mon", "gn", "Amon", "v20191115"],
+                ["cSoil", "ACCESS-ESM1-5", "historical", "r2i1p1f1", "mon", "gn", "Amon", "v20191115"],
+                ["ts", "ACCESS-ESM1-5", "historical", "r1i1p1f1", "mon", "gn", "Amon", "v20191115"],
+                ["areacella", "ACCESS-ESM1-5", "fx", "r1i1p1f1", "mon", "gn", "Amon", "v20191115"],
+            ],
+            columns=(
+                "variable_id",
+                "source_id",
+                "experiment_id",
+                "member_id",
+                "frequency",
+                "grid_label",
+                "table_id",
+                "version",
+            ),
+        ),
+    }
+    executions = list(solve_executions(data_catalog, diagnostic, provider=ilamb_provider))
+    assert len(executions) == 1
+
+    # ts
+    assert executions[0].datasets[SourceDatasetType.CMIP6].selector == (("experiment_id", "historical"),)
+    assert executions[0].datasets[SourceDatasetType.CMIP6].datasets["variable_id"].tolist() == [
+        "cSoil",
+        "cSoil",
+        "areacella",
+    ]
+    assert executions[0].datasets[SourceDatasetType.CMIP6].datasets["member_id"].tolist() == [
+        "r1i1p1f1",
+        "r2i1p1f1",
+        "r1i1p1f1",
+    ]

climate_ref_ilamb-0.5.5/pyproject.toml

@@ -1,36 +0,0 @@
-[project]
-name = "climate-ref-ilamb"
-version = "0.5.5"
-description = "ILAMB diagnostic provider for the Rapid Evaluation Framework"
-readme = "README.md"
-authors = [{ name = "Nathan Collier", email = "nathaniel.collier@gmail.com" }]
-requires-python = ">=3.11"
-classifiers = [
-    "Development Status :: 3 - Alpha",
-    "Operating System :: OS Independent",
-    "Intended Audience :: Developers",
-    "Intended Audience :: Science/Research",
-    "Programming Language :: Python",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.13",
-    "Topic :: Scientific/Engineering",
-    "License :: OSI Approved :: Apache Software License",
-]
-dependencies = [
-    "climate-ref-core",
-    "ilamb3>=2025.4.28",
-]
-
-[project.license]
-text = "Apache-2.0"
-
-[dependency-groups]
-dev = [
-  "types-pyyaml>=6.0.12",
-]
-
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"

climate_ref_ilamb-0.5.5/src/climate_ref_ilamb/configure/iomb.yaml

@@ -1,27 +0,0 @@
-registry: iomb
-
-thetao-WOA2023-surface:
-  sources:
-    thetao: ilamb/WOA/thetao_mon_WOA_A5B4_gn_200501-201412.nc
-  variable_cmap: Reds
-  depth: 0.0
-  alternate_vars:
-  - tos
-
-so-WOA2023-surface:
-  sources:
-    so: ilamb/WOA/so_mon_WOA_A5B4_gn_200501-201412.nc
-  variable_cmap: YlGn
-  depth: 0.0
-  alternate_vars:
-  - sos
-
-amoc-RAPID:
-  analyses:
-  - timeseries
-  alternate_vars:
-  - msftmz
-  transform:
-  - msftmz_to_rapid
-  sources:
-    amoc: ilamb/RAPID/amoc_mon_RAPID_BE_NA_200404-202302.nc