Merge pull request #188 from ACCESS-NRI/om3-pm-zeros

Allow for differences in sign of zeros when checking OM3 restart repro

Author: dougiesquire

src/model_config_tests/models/accessom3.py

@@ -131,6 +131,40 @@ def extract_full_checksums(self, output_directory: Path = None) -> dict[str, Any
             schema_version=SCHEMA_VERSION_1_0_0,
         )["output"]
 
+    def check_checksums_over_restarts(
+        self, long_run_checksum, short_run_checksum_0, short_run_checksum_1
+    ) -> bool:
+        """Compare a checksums from a long run (e.g. 2 days) against
+        checksums from 2 short runs (e.g. 1 day)"""
+        short_run_checksums = short_run_checksum_0["output"]
+        for field, checksums in short_run_checksum_1["output"].items():
+            if field not in short_run_checksums:
+                short_run_checksums[field] = checksums
+            else:
+                short_run_checksums[field].extend(checksums)
+
+        matching_checksums = True
+        for field, checksums in long_run_checksum["output"].items():
+            for checksum in checksums:
+                if field not in short_run_checksums:
+                    print(
+                        f"Checksum field for {field} found in long run but not in short runs"
+                    )
+                    matching_checksums = False
+                else:
+                    if checksum not in short_run_checksums[field]:
+                        # Allow for checksums to differ by 8 in the first hex digit to allow
+                        # for differences in the sign of zero between restart arrays
+                        # See https://github.com/ACCESS-NRI/access-om3-configs/issues/823
+                        first_digit = int(checksum[0], 16)
+                        pmzeros_digit = (first_digit + 8) % 16
+                        pmzeros_checksum = f"{pmzeros_digit:X}" + checksum[1:]
+                        if pmzeros_checksum not in short_run_checksums[field]:
+                            print(f"Unequal checksum: {field}: {checksum}")
+                            matching_checksums = False
+
+        return matching_checksums
+
     @staticmethod
     def _collect_restart_tiles(restart: Path) -> list[Path]:
         """

tests/__init__.py

@@ -0,0 +1,79 @@
+import pytest
+
+from model_config_tests.models import index as model_index
+
+
+@pytest.mark.parametrize("model_name", ["access-om2", "access-om3"])
+def test_check_checksums_over_restarts(model_name, capsys):
+    model = model_index[model_name]
+
+    checksum_1 = {
+        "schema_version": "1.0.0",
+        "output": {
+            "field1": ["12345678"],
+        },
+    }
+
+    checksum_2 = {
+        "schema_version": "1.0.0",
+        "output": {
+            "field1": ["87654321"],
+        },
+    }
+
+    matching_checksums = model.check_checksums_over_restarts(
+        model,
+        checksum_1,
+        checksum_1,
+        checksum_1,
+    )
+
+    assert matching_checksums is True
+
+    matching_checksums = model.check_checksums_over_restarts(
+        model,
+        checksum_2,
+        checksum_1,
+        checksum_1,
+    )
+    captured = capsys.readouterr()
+
+    assert matching_checksums is False
+    assert captured.out == "Unequal checksum: field1: 87654321\n"
+
+
+def test_check_checksums_over_restarts_om3_pmzeros():
+    # Test that OM3 checksums differing by 8 in the first hex digit are considered equal
+    model = model_index["access-om3"]
+
+    checksum_1 = {
+        "schema_version": "1.0.0",
+        "output": {
+            "field1": ["C92469973FB18B96"],
+        },
+    }
+
+    checksum_2 = {
+        "schema_version": "1.0.0",
+        "output": {
+            "field1": ["492469973FB18B96"],
+        },
+    }
+
+    matching_checksums = model.check_checksums_over_restarts(
+        model,
+        checksum_1,
+        checksum_2,
+        checksum_2,
+    )
+
+    assert matching_checksums is True
+
+    matching_checksums = model.check_checksums_over_restarts(
+        model,
+        checksum_2,
+        checksum_1,
+        checksum_1,
+    )
+
+    assert matching_checksums is True