Merge pull request #204 from CU-ESIIL/codex/fix-prism-ppt-units-and-plot-rotation

Fix PRISM ppt units and cube viewer rotation target

Author: ttuff

docs/changelog.md

@@ -9,6 +9,7 @@
 - Added an `allow_synthetic` safety switch to gridMET/PRISM loaders with clearer empty-time/all-NaN error messages.
 - `load_prism_cube` now returns a DataArray when a single variable is requested, matching docs examples.
 - Fixed cube viewer rotation so drag/zoom updates the cube as well as axis labels.
+- Standardized PRISM precipitation units to millimeters and aligned cube viewer rotation variables with the wrapper element.
 
 ## Earlier work
 

docs/concepts/cubes.md

@@ -30,7 +30,7 @@ CubeDynamics focuses on **streaming cubes** instead of requiring large local dow
 
 ## Correctness & cube shapes
 
-- **PRISM/gridMET loaders** (`load_prism_cube`, `load_gridmet_cube`) return `xarray.Dataset` objects with dims `(time, y, x)` per variable. Pass exactly one AOI description: `lat`/`lon`, `bbox=[min_lon, min_lat, max_lon, max_lat]`, or `aoi_geojson` (GeoJSON Feature/FeatureCollection).
+- **PRISM/gridMET loaders** (`load_prism_cube`, `load_gridmet_cube`) return `xarray.Dataset` objects with dims `(time, y, x)` per variable, or a single-variable `xarray.DataArray` when `variable="ppt"` (or another single variable) is requested. Pass exactly one AOI description: `lat`/`lon`, `bbox=[min_lon, min_lat, max_lon, max_lat]`, or `aoi_geojson` (GeoJSON Feature/FeatureCollection).
 - **Sentinel-2 loaders**:
   - `load_sentinel2_cube` and `load_sentinel2_bands_cube` return multispectral stacks with dims `(time, y, x, band)`.
   - `load_sentinel2_ndvi_cube` returns raw NDVI reflectance with dims `(time, y, x)` and optionally the underlying bands when `return_raw=True`.

docs/datasets/prism.md

@@ -12,19 +12,19 @@ import cubedynamics as cd
 from cubedynamics import pipe, verbs as v
 
 cube = cd.load_prism_cube(
-    variables=["ppt"],
+    variable="ppt",
     start="2020-01-01",
     end="2020-02-01",
-    aoi={"min_lat": 39.8, "max_lat": 40.2, "min_lon": -105.4, "max_lon": -105.0},
+    bbox=[-105.4, 39.8, -105.0, 40.2],
 )
 
-pipe(cube["ppt"]) | v.mean(dim="time") | v.plot()
+pipe(cube) | v.mean(dim="time") | v.plot()
 ```
 
 ### Customizing the view
 
 ```python
-pipe(cube["ppt"]) | v.plot(camera={"eye": {"x": 2.2, "y": 1.6, "z": 1.3}})
+pipe(cube) | v.plot(camera={"eye": {"x": 2.2, "y": 1.6, "z": 1.3}})
 ```
 
 ### Preview plot
@@ -40,7 +40,7 @@ pipe(cube["ppt"]) | v.plot(camera={"eye": {"x": 2.2, "y": 1.6, "z": 1.3}})
 2. Capture the CubePlot viewer for export:
 
     ```python
-    viewer = (pipe(cube["ppt"]) | v.mean(dim="time") | v.plot()).unwrap()
+    viewer = (pipe(cube) | v.mean(dim="time") | v.plot()).unwrap()
     viewer.save("docs/assets/datasets/prism-preview.html")
     ```
 

src/cubedynamics/data/prism.py

@@ -18,6 +18,32 @@
 
 
 _POINT_BUFFER_DEGREES = 0.05
+_PRISM_VARIABLE_METADATA = {
+    "ppt": {
+        "units": "mm",
+        "long_name": "Total precipitation",
+    },
+}
+
+
+def _apply_prism_variable_metadata(
+    ds: xr.Dataset, variables: Sequence[str]
+) -> xr.Dataset:
+    for name in variables:
+        if name not in ds.data_vars:
+            continue
+        meta = _PRISM_VARIABLE_METADATA.get(name.lower())
+        if not meta:
+            continue
+        da = ds[name]
+        units = da.attrs.get("units")
+        if not units or str(units).strip().lower() == "synthetic":
+            da.attrs["units"] = meta["units"]
+        for key, value in meta.items():
+            if key == "units":
+                continue
+            da.attrs.setdefault(key, value)
+    return ds
 
 
 def load_prism_cube(
@@ -571,6 +597,8 @@ def _finalize_prism_cube(
         )
         source = "synthetic"
 
+    ds = _apply_prism_variable_metadata(ds, variables)
+
     provenance_error = backend_error if source != "prism_streaming" else None
     return set_cube_provenance(
         ds,

src/cubedynamics/plotting/cube_viewer.py

@@ -447,9 +447,6 @@ def _render_cube_html(
       height: 100%;
       perspective: 950px;
       transform-style: preserve-3d;
-      --rot-x: 0rad;
-      --rot-y: 0rad;
-      --zoom: 1;
     }}
 
     .cube-scene .cube-rotation {{
@@ -739,11 +736,6 @@ def _render_cube_html(
             cubeWrapper.style.setProperty("--rot-y", rotationY + "rad");
             cubeWrapper.style.setProperty("--zoom", zoom);
           }}
-          if (scene && scene !== cubeWrapper) {{
-            scene.style.setProperty("--rot-x", rotationX + "rad");
-            scene.style.setProperty("--rot-y", rotationY + "rad");
-            scene.style.setProperty("--zoom", zoom);
-          }}
           if (!cubeWrapper && rotationTarget) {{
             rotationTarget.style.setProperty("--rot-x", rotationX + "rad");
             rotationTarget.style.setProperty("--rot-y", rotationY + "rad");

tests/test_cube_viewer_rotation_target.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+import numpy as np
+import pandas as pd
+import xarray as xr
+
+from cubedynamics.plotting.cube_viewer import cube_from_dataarray
+
+
+def test_cube_viewer_rotation_target_uses_wrapper(tmp_path):
+    data = xr.DataArray(
+        np.arange(2 * 3 * 3, dtype=float).reshape(2, 3, 3),
+        dims=("time", "y", "x"),
+        coords={
+            "time": pd.date_range("2023-01-01", periods=2, freq="D"),
+            "y": np.arange(3),
+            "x": np.arange(3),
+        },
+        name="demo",
+    )
+
+    html = cube_from_dataarray(
+        data,
+        out_html=str(tmp_path / "viewer.html"),
+        return_html=True,
+        show_progress=False,
+        thin_time_factor=1,
+    )
+
+    assert "const rotationTarget = cubeWrapper || scene" in html
+    assert "const rotationTarget = scene || cubeWrapper" not in html
+    assert 'scene.style.setProperty("--rot-x"' not in html
+
+    scene_block = html.split(".cube-scene {", 1)[1].split("}", 1)[0]
+    assert "--rot-x" not in scene_block
+    assert "--rot-y" not in scene_block
+    assert "--zoom" not in scene_block

tests/test_prism_ppt_units.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+import numpy as np
+import pandas as pd
+import xarray as xr
+
+import cubedynamics.data.prism as prism
+
+
+def test_prism_ppt_units_are_mm(monkeypatch):
+    def fake_stream(variables, start, end, aoi, freq, show_progress=True):
+        coords = {
+            "time": pd.date_range("2000-01-01", periods=1, freq="D"),
+            "y": np.array([40.0]),
+            "x": np.array([-105.25]),
+        }
+        da = xr.DataArray(
+            np.ones((1, 1, 1)),
+            coords=coords,
+            dims=("time", "y", "x"),
+            name="ppt",
+            attrs={"units": "synthetic"},
+        )
+        return xr.Dataset({"ppt": da})
+
+    monkeypatch.setattr(prism, "_open_prism_streaming", fake_stream)
+
+    da = prism.load_prism_cube(
+        lat=40.0,
+        lon=-105.25,
+        start="2000-01-01",
+        end="2000-01-02",
+        variable="ppt",
+    )
+
+    assert isinstance(da, xr.DataArray)
+    assert da.name == "ppt"
+    assert da.attrs.get("units") == "mm"