Fix DR #87

changelog/72.fix.md

@@ -0,0 +1 @@
+Updated the description of `ci_tavg-u-hxy-u` and `sci_tavg-u-hxy-u` to clarify what to do when regridding native grids (see [DR #87](https://github.com/CMIP-Data-Request/Harmonised-Public-Consultation/issues/87))

scripts/87-dr-fixes.py

@@ -0,0 +1,41 @@
+"""
+Fixes from DR #87
+"""
+
+from __future__ import annotations
+
+import json
+from pathlib import Path
+
+
+def main():
+    """
+    Apply the fixes
+    """
+    REPO_ROOT = Path(__file__).parents[1]
+
+    for branded_variable, new_description in (
+        (
+            "ci_tavg-u-hxy-u",
+            "Fraction of time that convection occurs in the grid cell. If native cell data is regridded, the area-weighted mean of the contributing cells should be reported.",
+        ),
+        (
+            "sci_tavg-u-hxy-u",
+            "Fraction of time that convection occurs in the grid cell. If native cell data is regridded, the area-weighted mean of the contributing cells should be reported.",
+        ),
+    ):
+        with open(
+            REPO_ROOT / "src-data" / "variable" / f"{branded_variable}.json"
+        ) as fh:
+            working = json.load(fh)
+
+        working["description"] = new_description
+
+        with open(
+            REPO_ROOT / "src-data" / "variable" / f"{branded_variable}.json", "w"
+        ) as fh:
+            json.dump(working, fh, indent=4)
+
+
+if __name__ == "__main__":
+    main()

src-data/variable/ci_tavg-u-hxy-u.json

@@ -2,7 +2,7 @@
     "id": "ci_tavg-u-hxy-u",
     "validation-key": "ci_tavg-u-hxy-u",
     "ui-label": "Fraction of Time Convection Occurs in Cell",
-    "description": "Fraction of time that convection occurs in the grid cell .",
+    "description": "Fraction of time that convection occurs in the grid cell. If native cell data is regridded, the area-weighted mean of the contributing cells should be reported.",
     "area-label": "u",
     "cell-measures": "area: areacella",
     "cell-methods": "area: time: mean",

src-data/variable/sci_tavg-u-hxy-u.json

@@ -2,7 +2,7 @@
     "id": "sci_tavg-u-hxy-u",
     "validation-key": "sci_tavg-u-hxy-u",
     "ui-label": "Fraction of Time Shallow Convection Occurs",
-    "description": "Fraction of time that shallow convection occurs in the grid cell.",
+    "description": "Fraction of time that convection occurs in the grid cell. If native cell data is regridded, the area-weighted mean of the contributing cells should be reported.",
     "area-label": "u",
     "cell-measures": "area: areacella",
     "cell-methods": "area: time: mean",