E2E Tests for Plotting

ice_station_zebra/config/evaluate/callbacks/plotting.yaml

@@ -20,5 +20,5 @@ plotting:
     diff_strategy: "precompute"     # "precompute" | "two-pass" | "per-frame"
     vmin: 0.0
     vmax: 1.0
-    colourbar_location: "vertical"
-    colourbar_strategy: "separate"  # shared | separate (prediction gets its own colourbar)
+    colourbar_location: "horizontal"
+    colourbar_strategy: "shared"  # shared | separate (prediction gets its own colourbar)

ice_station_zebra/types/simple_datatypes.py

@@ -43,15 +43,13 @@ class DataloaderArgs(TypedDict):
 
 
 class DiffColourmapSpec(NamedTuple):
-    """Colour scale specification for visualising a difference panel.
+    """Specify the colour scale used for a difference panel.
 
     Attributes:
-        norm: Normalisation object for mapping data values to colours.
-              Typically TwoSlopeNorm for signed differences (centred at 0).
-              None for non-signed modes (absolute, smape).
-        vmin: Lower bound for colour scale (used if norm is None).
-        vmax: Upper bound for colour scale (used if norm is None).
-        cmap: Name of the matplotlib colourmap to use.
+        norm: Normalisation for mapping values to colours (e.g. TwoSlopeNorm for signed diffs).
+        vmin: Lower bound if no norm is provided.
+        vmax: Upper bound if no norm is provided.
+        cmap: Matplotlib colormap name.
 
     """
 
@@ -63,19 +61,52 @@ class DiffColourmapSpec(NamedTuple):
 
 @dataclass(frozen=True)
 class PlotSpec:
-    """Specification for a plotting strategy."""
+    """Configure how sea-ice plots are rendered.
+
+    Attributes:
+        variable: Variable name shown in plots / used for routing.
+        title_groundtruth: Title above the ground-truth panel.
+        title_prediction: Title above the prediction panel.
+        title_difference: Title above the difference panel.
+        n_contour_levels: Number of contour levels per panel.
+        colourmap: Colormap used for GT/prediction panels.
+        include_difference: Whether to draw a difference panel.
+        diff_mode: Difference definition (e.g. "signed", "absolute", "smape").
+        diff_strategy: Strategy for animations (precompute, two-pass, per-frame).
+        selected_timestep: Slice index when a single timestep is needed.
+        vmin: Lower bound for GT/prediction colour scale (None = infer).
+        vmax: Upper bound for GT/prediction colour scale (None = infer).
+        colourbar_location: "vertical" or "horizontal".
+        colourbar_strategy: "shared" or "separate" colourbars.
+        outside_warn: Threshold for “values outside display range” warnings.
+        severe_outside: Severe threshold for clipping warnings.
+        include_shared_range_mismatch_check: If True, add magnitude mismatch nudges.
+
+    """
 
     variable: str
     title_groundtruth: str = "Ground Truth"
     title_prediction: str = "Prediction"
     title_difference: str = "Difference"
-    n_contour_levels: int = 100
+
+    n_contour_levels: int = 51
     colourmap: str = "viridis"
+
+    # Difference pane
     include_difference: bool = True
     diff_mode: DiffMode = "signed"
     diff_strategy: DiffStrategy = "precompute"
     selected_timestep: int = 0
+
+    # Colourscale ranges: defaults to [0,1]
     vmin: float | None = 0.0
     vmax: float | None = 1.0
-    colourbar_location: Literal["vertical", "horizontal"] = "vertical"
+
+    # Colourbar layout
+    colourbar_location: Literal["vertical", "horizontal"] = "horizontal"
     colourbar_strategy: Literal["shared", "separate"] = "shared"
+
+    # Range Check/warnings in badge
+    outside_warn: float = 0.05
+    severe_outside: float = 0.20
+    include_shared_range_mismatch_check: bool = True

ice_station_zebra/visualisations/__init__.py

@@ -1,13 +1,16 @@
-from .plotting_core import PlotSpec
+from ice_station_zebra.types import PlotSpec
+
 from .plotting_maps import (
     DEFAULT_SIC_SPEC,
     plot_maps,
     video_maps,
 )
+from .range_check import compute_range_check_report
 
 __all__ = [
     "DEFAULT_SIC_SPEC",
     "PlotSpec",
+    "compute_range_check_report",
     "plot_maps",
     "video_maps",
 ]

ice_station_zebra/visualisations/convert.py

@@ -37,22 +37,35 @@ def _image_from_array(a: np.ndarray) -> ImageFile:
 def _save_animation(
     anim: animation.FuncAnimation,
     *,
-    fps: int,
+    fps: int | None = None,
     video_format: Literal["mp4", "gif"] = "gif",
+    _fps: int | None = None,
+    _video_format: Literal["mp4", "gif"] | None = None,
 ) -> io.BytesIO:
     """Save an animation to a temporary file and return BytesIO (with cleanup)."""
+    # Accept both standard and underscored names for test compatibility
+    fps_value: int = int(fps if fps is not None else (_fps if _fps is not None else 2))
+    if _video_format is not None:
+        video_format = _video_format  # prefer underscored override if provided
     suffix = ".gif" if video_format.lower() == "gif" else ".mp4"
     with tempfile.NamedTemporaryFile(suffix=suffix, delete=True) as tmp:
         try:
             # Save video to tempfile
             writer: animation.AbstractMovieWriter = (
-                animation.PillowWriter(fps=fps)
+                animation.PillowWriter(fps=fps_value)
                 if suffix == ".gif"
                 else animation.FFMpegWriter(
-                    fps=fps,
+                    fps=fps_value,
                     codec="libx264",
                     bitrate=1800,
-                    extra_args=["-pix_fmt", "yuv420p"],
+                    # Ensure dimensions are compatible with yuv420p (even width/height)
+                    # by applying a scale filter that truncates to the nearest even integers.
+                    extra_args=[
+                        "-pix_fmt",
+                        "yuv420p",
+                        "-vf",
+                        "scale=trunc(iw/2)*2:trunc(ih/2)*2",
+                    ],
                 )
             )
             anim.save(tmp.name, writer=writer, dpi=DEFAULT_DPI)