Upload essd_scripts/check_manuscript_consistency.py

essd_scripts/check_manuscript_consistency.py

@@ -0,0 +1,140 @@
+#!/usr/bin/env python3
+"""Check that ESSD manuscript numbers agree with regenerated audit outputs."""
+
+from __future__ import annotations
+
+import argparse
+import contextlib
+import io
+import json
+import re
+from pathlib import Path
+from typing import Any
+
+from audit_manuscript_numbers import build_report, print_latex_baseline
+
+
+ROOT = Path(__file__).resolve().parents[1]
+DEFAULT_TEX = ROOT / "essd" / "template.tex"
+
+
+def tex_int(value: int) -> str:
+    return f"{value:,}".replace(",", r"\,")
+
+
+def norm(text: str) -> str:
+    text = text.replace(r"\,", "")
+    text = text.replace("~", "")
+    text = text.replace(" ", "")
+    return re.sub(r"\s+", "", text)
+
+
+def require(label: str, manuscript: str, snippet: str, failures: list[dict[str, str]]) -> None:
+    if norm(snippet) not in manuscript:
+        failures.append({"label": label, "expected_snippet": snippet})
+
+
+def baseline_rows_latex(report: dict[str, Any]) -> str:
+    buf = io.StringIO()
+    with contextlib.redirect_stdout(buf):
+        print_latex_baseline(report)
+    return buf.getvalue()
+
+
+def build_checks(report: dict[str, Any]) -> list[tuple[str, str]]:
+    inv = report["waveform_inventory"]
+    ann = report["annotation_inventory"]
+    cov = report["label_coverage"]["overall"]
+    consensus = report["consensus_audit"]
+    manual_supported = consensus["label_vote_audit_2019_manual_covered"]
+
+    checks = [
+        ("daily HDF5 files", f"Daily HDF5 files & {inv['daily_hdf5_files']}"),
+        ("compressed waveform size", f"Compressed waveform size & {inv['compressed_waveform_size_gib_rounded']}\\,GiB"),
+        ("unique station keys", f"Unique network-station keys & {inv['unique_network_station_keys']}"),
+        ("indexed waveform segments", f"Indexed waveform segments & {tex_int(inv['indexed_waveform_segments'])}"),
+        ("all-channel component-days", f"All-channel component-days & {tex_int(inv['all_channel_component_days_rounded'])}"),
+        ("main-family waveform segments", f"HH/BH/EH/HN waveform segments & {tex_int(inv['main_family_segments'])}"),
+        ("main-family component-days", f"HH/BH/EH/HN component-days & {tex_int(inv['main_family_component_days_rounded'])}"),
+        (
+            "main-family station-day-family samples",
+            f"HH/BH/EH/HN station-day-family samples & {tex_int(inv['main_family_station_day_family_samples'])}",
+        ),
+        ("events", f"Events & {ann['summary']['event_count']}"),
+        ("P/S phase arrivals", f"P/S phase arrivals & {tex_int(ann['summary']['pick_count'])}"),
+        ("covered arrivals", f"Arrivals with released waveform coverage & {tex_int(cov['covered_labels'])}"),
+        (
+            "2019 period row",
+            (
+                f"2019 July 1--7 & {tex_int(ann['periods']['2019']['events'])} & "
+                f"{tex_int(ann['periods']['2019']['phase_arrivals'])} & "
+                f"{tex_int(ann['periods']['2019']['manual_labels'])}"
+            ),
+        ),
+        (
+            "2021 period row",
+            (
+                f"2021 November 8--14 & {tex_int(ann['periods']['2021']['events'])} & "
+                f"{tex_int(ann['periods']['2021']['phase_arrivals'])} & "
+                f"{tex_int(ann['periods']['2021']['manual_labels'])}"
+            ),
+        ),
+        ("automatic labels", tex_int(ann["status_counts"]["automatic"])),
+        ("source records", tex_int(ann["summary"]["record_count"])),
+        ("event-station associations", tex_int(ann["summary"]["station_event_count"])),
+        (
+            "consensus candidate count",
+            f"This conservative example contains {tex_int(consensus['candidate_count'])} consensus-supported candidate",
+        ),
+        ("consensus P count", tex_int(consensus["candidate_phase_counts"]["P"])),
+        ("consensus S count", tex_int(consensus["candidate_phase_counts"]["S"])),
+        ("consensus label-matched count", tex_int(consensus["candidate_with_catalog_label_within_1p5_s"])),
+        ("manual covered vote total", tex_int(manual_supported["total_labels"])),
+        ("manual covered supported count", tex_int(manual_supported["supported_labels"])),
+    ]
+    return checks
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument("--tex", type=Path, default=DEFAULT_TEX)
+    parser.add_argument("--format", choices=("text", "json"), default="text")
+    args = parser.parse_args()
+
+    report = build_report()
+    manuscript = norm(args.tex.read_text(encoding="utf-8"))
+    failures: list[dict[str, str]] = []
+
+    for label, snippet in build_checks(report):
+        require(label, manuscript, snippet, failures)
+
+    baseline_text = baseline_rows_latex(report)
+    for line in baseline_text.splitlines():
+        if "&" in line and re.search(r"\d", line):
+            require("baseline table row", manuscript, line, failures)
+
+    result = {
+        "tex": str(args.tex.relative_to(ROOT) if args.tex.is_relative_to(ROOT) else args.tex),
+        "status": "pass" if not failures else "fail",
+        "checked_core_items": len(build_checks(report)),
+        "checked_baseline_rows": sum(1 for line in baseline_text.splitlines() if "&" in line and re.search(r"\d", line)),
+        "failures": failures,
+    }
+
+    if args.format == "json":
+        print(json.dumps(result, indent=2, ensure_ascii=False))
+    else:
+        if failures:
+            print("[FAIL] Manuscript number consistency check")
+            for item in failures:
+                print(f"- {item['label']}: missing {item['expected_snippet']}")
+        else:
+            print("[OK] Manuscript numbers match regenerated ESSD audit outputs.")
+            print(f"Core items checked: {result['checked_core_items']}")
+            print(f"Baseline rows checked: {result['checked_baseline_rows']}")
+
+    raise SystemExit(1 if failures else 0)
+
+
+if __name__ == "__main__":
+    main()