xarray-plotly 0.0.5__tar.gz → 0.0.6__tar.gz

{xarray_plotly-0.0.5 → xarray_plotly-0.0.6}/.github/workflows/ci.yml

@@ -40,3 +40,35 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: false
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Install dependencies
+        run: uv sync --extra docs
+
+      - name: Build docs
+        run: uv run mkdocs build
+
+  ci-success:
+    name: CI Success
+    needs: [test, docs]
+    if: always()
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check all jobs passed
+        run: |
+          if [[ "${{ needs.test.result }}" != "success" ]]; then
+            echo "Test job failed or was cancelled"
+            exit 1
+          fi
+          if [[ "${{ needs.docs.result }}" != "success" ]]; then
+            echo "Docs job failed or was cancelled"
+            exit 1
+          fi
+          echo "All CI checks passed!"

{xarray_plotly-0.0.5 → xarray_plotly-0.0.6}/.github/workflows/docs.yml

@@ -1,7 +1,7 @@
 name: Docs
 
 on:
-  push:
+  pull_request:
     branches: [main]
   release:
     types: [published]
@@ -26,6 +26,7 @@ jobs:
         run: uv run mkdocs build
 
       - name: Deploy to GitHub Pages
+        if: github.event_name == 'release'
         uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

{xarray_plotly-0.0.5 → xarray_plotly-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xarray_plotly
-Version: 0.0.5
+Version: 0.0.6
 Summary: Interactive Plotly Express plotting accessor for xarray
 Author: Felix
 License: MIT

{xarray_plotly-0.0.5 → xarray_plotly-0.0.6}/tests/test_accessor.py

@@ -292,3 +292,52 @@ class TestDatasetPlotlyAccessor:
         """Test box plot with all variables."""
         fig = self.ds.plotly.box()
         assert isinstance(fig, go.Figure)
+
+
+class TestImshowBounds:
+    """Tests for imshow global bounds and robust mode."""
+
+    def test_imshow_global_bounds(self) -> None:
+        """Test that imshow uses global min/max by default."""
+        da = xr.DataArray(
+            np.array([[[1, 2], [3, 4]], [[5, 6], [7, 100]]]),
+            dims=["time", "y", "x"],
+        )
+        fig = da.plotly.imshow(animation_frame="time")
+        # Check coloraxis for zmin/zmax (plotly stores them there)
+        coloraxis = fig.layout.coloraxis
+        assert coloraxis.cmin == 1.0
+        assert coloraxis.cmax == 100.0
+
+    def test_imshow_robust_bounds(self) -> None:
+        """Test that robust=True uses percentile-based bounds."""
+        # Create data with outlier
+        data = np.random.rand(10, 20) * 100
+        data[0, 0] = 10000  # extreme outlier
+        da = xr.DataArray(data, dims=["y", "x"])
+
+        fig = da.plotly.imshow(robust=True)
+        # With robust=True, cmax should be much less than the outlier
+        coloraxis = fig.layout.coloraxis
+        assert coloraxis.cmax < 10000
+        assert coloraxis.cmax < 200  # Should be around 98th percentile (~98)
+
+    def test_imshow_user_zmin_zmax_override(self) -> None:
+        """Test that user-provided zmin/zmax overrides auto bounds."""
+        da = xr.DataArray(np.random.rand(10, 20) * 100, dims=["y", "x"])
+        fig = da.plotly.imshow(zmin=0, zmax=50)
+        coloraxis = fig.layout.coloraxis
+        assert coloraxis.cmin == 0
+        assert coloraxis.cmax == 50
+
+    def test_imshow_animation_consistent_bounds(self) -> None:
+        """Test that animation frames have consistent color bounds."""
+        da = xr.DataArray(
+            np.array([[[0, 10], [20, 30]], [[40, 50], [60, 70]]]),
+            dims=["time", "y", "x"],
+        )
+        fig = da.plotly.imshow(animation_frame="time")
+        # All frames should use global min (0) and max (70)
+        coloraxis = fig.layout.coloraxis
+        assert coloraxis.cmin == 0.0
+        assert coloraxis.cmax == 70.0

{xarray_plotly-0.0.5 → xarray_plotly-0.0.6}/xarray_plotly/accessor.py

@@ -250,6 +250,7 @@ class DataArrayPlotlyAccessor:
         y: SlotValue = auto,
         facet_col: SlotValue = auto,
         animation_frame: SlotValue = auto,
+        robust: bool = False,
         **px_kwargs: Any,
     ) -> go.Figure:
         """Create an interactive heatmap image.
@@ -261,7 +262,9 @@ class DataArrayPlotlyAccessor:
             y: Dimension for y-axis (rows). Default: first dimension.
             facet_col: Dimension for subplot columns. Default: third dimension.
             animation_frame: Dimension for animation. Default: fourth dimension.
+            robust: If True, use 2nd/98th percentiles for color bounds (handles outliers).
             **px_kwargs: Additional arguments passed to `plotly.express.imshow()`.
+                Use `zmin` and `zmax` to manually set color scale bounds.
 
         Returns:
             Interactive Plotly Figure.
@@ -272,6 +275,7 @@ class DataArrayPlotlyAccessor:
             y=y,
             facet_col=facet_col,
             animation_frame=animation_frame,
+            robust=robust,
             **px_kwargs,
         )
 

{xarray_plotly-0.0.5 → xarray_plotly-0.0.6}/xarray_plotly/plotting.py

@@ -6,6 +6,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any
 
+import numpy as np
 import plotly.express as px
 
 from xarray_plotly.common import (
@@ -398,6 +399,7 @@ def imshow(
     y: SlotValue = auto,
     facet_col: SlotValue = auto,
     animation_frame: SlotValue = auto,
+    robust: bool = False,
     **px_kwargs: Any,
 ) -> go.Figure:
     """
@@ -418,8 +420,12 @@ def imshow(
         Dimension for subplot columns. Default: third dimension.
     animation_frame
         Dimension for animation. Default: fourth dimension.
+    robust
+        If True, compute color bounds using 2nd and 98th percentiles
+        for robustness against outliers. Default: False.
     **px_kwargs
         Additional arguments passed to `plotly.express.imshow()`.
+        Use `zmin` and `zmax` to manually set color scale bounds.
 
     Returns
     -------
@@ -440,6 +446,20 @@ def imshow(
     ]
     plot_data = darray.transpose(*transpose_order) if transpose_order else darray
 
+    # Compute global color bounds if not provided
+    if "zmin" not in px_kwargs or "zmax" not in px_kwargs:
+        values = plot_data.values
+        if robust:
+            # Use percentiles for outlier robustness
+            zmin = float(np.nanpercentile(values, 2))
+            zmax = float(np.nanpercentile(values, 98))
+        else:
+            # Use global min/max across all data
+            zmin = float(np.nanmin(values))
+            zmax = float(np.nanmax(values))
+        px_kwargs.setdefault("zmin", zmin)
+        px_kwargs.setdefault("zmax", zmax)
+
     return px.imshow(
         plot_data,
         facet_col=slots.get("facet_col"),

{xarray_plotly-0.0.5 → xarray_plotly-0.0.6}/xarray_plotly.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xarray_plotly
-Version: 0.0.5
+Version: 0.0.6
 Summary: Interactive Plotly Express plotting accessor for xarray
 Author: Felix
 License: MIT