Merge pull request #34 from znicholls/update-horizontal-labels

Update to match latest version of horizontal labels

Author: znicholls

changelog/34.breaking.md

@@ -0,0 +1,3 @@
+Update horizontal label generation to be in line with Table F3 of [the specification document](https://docs.google.com/document/d/19jzecgymgiiEsTDzaaqeLP6pTvLT-NzCMaq-wu-QoOc/edit?pli=1&tab=t.0) as at September 24 2025.
+
+The horizontal label "hxys" is now just "hs", "hys" is now "hyb".

src/cmip_branded_variable_mapper/horizontal_label.py

@@ -5,7 +5,7 @@
 from __future__ import annotations
 
 
-def get_horizontal_label(  # noqa: PLR0911
+def get_horizontal_label(
     dimensions: tuple[str, ...],
     fallback: str = "hm",
 ) -> str:
@@ -14,7 +14,7 @@ def get_horizontal_label(  # noqa: PLR0911
 
     The logic this should follow is defined in Table F3 of
     [Taylor et al.](https://docs.google.com/document/d/19jzecgymgiiEsTDzaaqeLP6pTvLT-NzCMaq-wu-QoOc/edit?pli=1&tab=t.0).
-    This was last checked on June 14 2025.
+    This was last checked on September 24 2025.
     If updates have been made since,
     this code may be out of date with the underlying specification.
 
@@ -48,23 +48,16 @@ def get_horizontal_label(  # noqa: PLR0911
         return "hy"
 
     if "site" in dimensions:
-        return "hxys"
-        # # TODO: update to new logic
-        # return "hs"
+        return "hs"
 
     if latitude_present and basin_present:
-        return "hys"
-    # # TODO: update to new logic
-    # if (latitude_present and basin_present) or (
-    #     "gridlatitude" in dimensions and basin_present
-    # ):
-    # return "hyb"
+        return "hyb"
 
-    # # TODO: delete this when update to new logic (maybe, if it hasn't changed again)
-    if "gridlatitude" in dimensions and basin_present:
-        return "ht"
-
-    if "oline" in dimensions or "siline" in dimensions:
+    if (
+        "oline" in dimensions
+        or "siline" in dimensions
+        or ("gridlatitude" in dimensions and basin_present)
+    ):
         return "ht"
 
     return fallback