Add a fix for differing index coord long names in NorESM2-MM and EC-Earth3-Veg-LR (#2667)

Author: bouweandela

esmvalcore/cmor/_fixes/cmip6/ec_earth3_veg_lr.py

@@ -1,5 +1,29 @@
 """Fixes for EC-Earth3-Veg-LR model."""
 
-from ..common import OceanFixGrid
+from collections.abc import Sequence
+
+import iris.cube
+
+from esmvalcore.cmor._fixes.common import OceanFixGrid
+from esmvalcore.cmor._fixes.fix import Fix
+
+
+class AllVars(Fix):
+    """Fixes for all variables."""
+
+    def fix_metadata(
+        self,
+        cubes: Sequence[iris.cube.Cube],
+    ) -> Sequence[iris.cube.Cube]:
+        """Use the same long name for horizontal index coordinates."""
+        for cube in cubes:
+            # Use the same long name for index coordinates in all files to avoid
+            # problems when concatenating.
+            for var_name, dim_name in [("i", "first"), ("j", "second")]:
+                if coords := cube.coords(var_name=var_name, dim_coords=True):
+                    long_name = f"cell index along {dim_name} dimension"
+                    coords[0].long_name = long_name
+        return cubes
+
 
 Siconc = OceanFixGrid

esmvalcore/cmor/_fixes/cmip6/noresm2_mm.py

@@ -1,6 +1,11 @@
 """Fixes for NorESM2-MM model."""
 
-from ..common import ClFixHybridPressureCoord
+from esmvalcore.cmor._fixes.cmip6.ec_earth3_veg_lr import (
+    AllVars as BaseAllVars,
+)
+from esmvalcore.cmor._fixes.common import ClFixHybridPressureCoord
+
+AllVars = BaseAllVars
 
 Cl = ClFixHybridPressureCoord
 

tests/integration/cmor/_fixes/cmip6/test_ec_earth3_veg_lr.py

@@ -1,16 +1,53 @@
 """Test fixes for EC-Earth3-Veg-LR."""
 
-from esmvalcore.cmor._fixes.cmip6.ec_earth3_veg_lr import Siconc
+import iris.coords
+import iris.cube
+import pytest
+
+from esmvalcore.cmor._fixes.cmip6.ec_earth3_veg_lr import AllVars, Siconc
 from esmvalcore.cmor._fixes.common import OceanFixGrid
-from esmvalcore.cmor._fixes.fix import Fix, GenericFix
+from esmvalcore.cmor._fixes.fix import Fix
 
 
 def test_get_siconc_fix():
     """Test getting of fix."""
-    fix = Fix.get_fixes("CMIP6", "EC-Earth3-Veg-LR", "SImon", "siconc")
-    assert fix == [Siconc(None), GenericFix(None)]
+    assert Siconc(None) in Fix.get_fixes(
+        "CMIP6", "EC-Earth3-Veg-LR", "SImon", "siconc"
+    )
 
 
 def test_siconc_fix():
     """Test fix for ``siconc``."""
     assert Siconc is OceanFixGrid
+
+
+def test_get_allvars_fix():
+    """Test getting of fix."""
+    assert AllVars(None) in Fix.get_fixes(
+        "CMIP6", "EC-Earth3-Veg-LR", "Omon", "tos"
+    )
+
+
+@pytest.mark.parametrize("has_index_coord", [True, False])
+def test_grid_fix(has_index_coord):
+    """Test fix for differing grid index coordinate long names."""
+    cube = iris.cube.Cube([1, 2])
+    if has_index_coord:
+        i_coord = iris.coords.DimCoord(
+            [0.0, 1.0],
+            var_name="i",
+            long_name="first spatial index for variables stored on an unstructured grid",
+            units=1,
+        )
+        cube.add_dim_coord(i_coord, 0)
+
+    cubes = [cube]
+    for fix in Fix.get_fixes("CMIP6", "NorESM2-MM", "Omon", "tos"):
+        cubes = fix.fix_metadata(cubes)
+
+    assert len(cubes) == 1
+    if has_index_coord:
+        assert (
+            cubes[0].coord(var_name="i").long_name
+            == "cell index along first dimension"
+        )

tests/integration/cmor/_fixes/cmip6/test_noresm2_mm.py

@@ -1,15 +1,47 @@
 """Tests for the fixes of NorESM2-MM."""
 
-from esmvalcore.cmor._fixes.cmip6.noresm2_mm import Cl, Cli, Clw
+import iris.coords
+import iris.cube
+import pytest
+
+from esmvalcore.cmor._fixes.cmip6.noresm2_mm import AllVars, Cl, Cli, Clw
 from esmvalcore.cmor._fixes.common import ClFixHybridPressureCoord
-from esmvalcore.cmor._fixes.fix import GenericFix
 from esmvalcore.cmor.fix import Fix
 
 
+def test_get_allvars_fix():
+    """Test getting of fix."""
+    assert AllVars(None) in Fix.get_fixes("CMIP6", "NorESM2-MM", "Omon", "tos")
+
+
+@pytest.mark.parametrize("has_index_coord", [True, False])
+def test_grid_fix(has_index_coord):
+    """Test fix for differing grid index coordinate long names."""
+    cube = iris.cube.Cube([1, 2])
+    if has_index_coord:
+        i_coord = iris.coords.DimCoord(
+            [0.0, 1.0],
+            var_name="i",
+            long_name="first spatial index for variables stored on an unstructured grid",
+            units=1,
+        )
+        cube.add_dim_coord(i_coord, 0)
+
+    cubes = [cube]
+    for fix in Fix.get_fixes("CMIP6", "NorESM2-MM", "Omon", "tos"):
+        cubes = fix.fix_metadata(cubes)
+
+    assert len(cubes) == 1
+    if has_index_coord:
+        assert (
+            cubes[0].coord(var_name="i").long_name
+            == "cell index along first dimension"
+        )
+
+
 def test_get_cl_fix():
     """Test getting of fix."""
-    fix = Fix.get_fixes("CMIP6", "NorESM2-MM", "Amon", "cl")
-    assert fix == [Cl(None), GenericFix(None)]
+    assert Cl(None) in Fix.get_fixes("CMIP6", "NorESM2-MM", "Amon", "cl")
 
 
 def test_cl_fix():
@@ -19,8 +51,7 @@ def test_cl_fix():
 
 def test_get_cli_fix():
     """Test getting of fix."""
-    fix = Fix.get_fixes("CMIP6", "NorESM2-MM", "Amon", "cli")
-    assert fix == [Cli(None), GenericFix(None)]
+    assert Cli(None) in Fix.get_fixes("CMIP6", "NorESM2-MM", "Amon", "cli")
 
 
 def test_cli_fix():
@@ -30,8 +61,7 @@ def test_cli_fix():
 
 def test_get_clw_fix():
     """Test getting of fix."""
-    fix = Fix.get_fixes("CMIP6", "NorESM2-MM", "Amon", "clw")
-    assert fix == [Clw(None), GenericFix(None)]
+    assert Clw(None) in Fix.get_fixes("CMIP6", "NorESM2-MM", "Amon", "clw")
 
 
 def test_clw_fix():