xarray-plotly 0.0.7__tar.gz → 0.0.9__tar.gz

{xarray_plotly-0.0.7 → xarray_plotly-0.0.9}/.github/workflows/docs.yml

@@ -3,11 +3,6 @@ name: Docs
 on:
   pull_request:
     branches: [main]
-  release:
-    types: [published]
-
-permissions:
-  contents: write
 
 jobs:
   docs:
@@ -24,10 +19,3 @@ jobs:
 
       - name: Build docs
         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 }}
-          publish_dir: ./site

{xarray_plotly-0.0.7 → xarray_plotly-0.0.9}/.github/workflows/release.yml

@@ -29,3 +29,15 @@ jobs:
         with:
           generate_release_notes: true
           files: dist/*
+
+      - name: Install docs dependencies
+        run: uv sync --extra docs
+
+      - name: Build docs
+        run: uv run mkdocs build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site

{xarray_plotly-0.0.7 → xarray_plotly-0.0.9}/PKG-INFO

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

xarray_plotly-0.0.9/docs/examples/fast_bar.ipynb

@@ -0,0 +1,297 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "0",
+   "metadata": {},
+   "source": [
+    "# Fast Bar Charts\n",
+    "\n",
+    "The `fast_bar()` method creates bar-like visualizations using stacked areas. This renders much faster than actual bar charts for large datasets because it uses a single polygon per trace instead of individual rectangles."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import numpy as np\n",
+    "import xarray as xr\n",
+    "\n",
+    "from xarray_plotly import config, xpx\n",
+    "\n",
+    "config.notebook()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "2",
+   "metadata": {},
+   "source": [
+    "## Basic Example"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "3",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Quarterly revenue data by product and region\n",
+    "np.random.seed(42)\n",
+    "da = xr.DataArray(\n",
+    "    np.random.rand(4, 3, 2) * 100 + 50,\n",
+    "    dims=[\"quarter\", \"product\", \"region\"],\n",
+    "    coords={\n",
+    "        \"quarter\": [\"Q1\", \"Q2\", \"Q3\", \"Q4\"],\n",
+    "        \"product\": [\"Widgets\", \"Gadgets\", \"Gizmos\"],\n",
+    "        \"region\": [\"North\", \"South\"],\n",
+    "    },\n",
+    "    name=\"revenue\",\n",
+    ")\n",
+    "\n",
+    "xpx(da).fast_bar()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "4",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Comparison with regular bar()\n",
+    "xpx(da).bar()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "5",
+   "metadata": {},
+   "source": [
+    "## With Faceting"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "xpx(da).fast_bar(facet_col=\"region\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "7",
+   "metadata": {},
+   "source": [
+    "## With Animation"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "8",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Multi-year data for animation\n",
+    "np.random.seed(123)\n",
+    "da_anim = xr.DataArray(\n",
+    "    np.random.rand(4, 3, 5) * 100 + 20,\n",
+    "    dims=[\"quarter\", \"product\", \"year\"],\n",
+    "    coords={\n",
+    "        \"quarter\": [\"Q1\", \"Q2\", \"Q3\", \"Q4\"],\n",
+    "        \"product\": [\"Widgets\", \"Gadgets\", \"Gizmos\"],\n",
+    "        \"year\": [2020, 2021, 2022, 2023, 2024],\n",
+    "    },\n",
+    "    name=\"revenue\",\n",
+    ")\n",
+    "\n",
+    "xpx(da_anim).fast_bar(animation_frame=\"year\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "9",
+   "metadata": {},
+   "source": [
+    "## Faceting + Animation"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "10",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# 4D data: quarter x product x region x year\n",
+    "np.random.seed(456)\n",
+    "da_4d = xr.DataArray(\n",
+    "    np.random.rand(4, 3, 2, 4) * 80 + 30,\n",
+    "    dims=[\"quarter\", \"product\", \"region\", \"year\"],\n",
+    "    coords={\n",
+    "        \"quarter\": [\"Q1\", \"Q2\", \"Q3\", \"Q4\"],\n",
+    "        \"product\": [\"Widgets\", \"Gadgets\", \"Gizmos\"],\n",
+    "        \"region\": [\"North\", \"South\"],\n",
+    "        \"year\": [2021, 2022, 2023, 2024],\n",
+    "    },\n",
+    "    name=\"revenue\",\n",
+    ")\n",
+    "\n",
+    "xpx(da_4d).fast_bar(facet_col=\"region\", animation_frame=\"year\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "11",
+   "metadata": {},
+   "source": [
+    "## Positive and Negative Values\n",
+    "\n",
+    "`fast_bar()` classifies each trace by its values:\n",
+    "- **Purely positive** → stacks upward\n",
+    "- **Purely negative** → stacks downward\n",
+    "- **Mixed signs** → warning + dashed line (use `bar()` instead)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "12",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Profit (positive) and Loss (negative) - stacks correctly\n",
+    "np.random.seed(789)\n",
+    "da_split = xr.DataArray(\n",
+    "    np.column_stack(\n",
+    "        [\n",
+    "            np.random.rand(6) * 80 + 20,  # Revenue: positive\n",
+    "            -np.random.rand(6) * 50 - 10,  # Costs: negative\n",
+    "        ]\n",
+    "    ),\n",
+    "    dims=[\"month\", \"category\"],\n",
+    "    coords={\n",
+    "        \"month\": [\"Jan\", \"Feb\", \"Mar\", \"Apr\", \"May\", \"Jun\"],\n",
+    "        \"category\": [\"Revenue\", \"Costs\"],\n",
+    "    },\n",
+    "    name=\"financials\",\n",
+    ")\n",
+    "\n",
+    "xpx(da_split).fast_bar()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "13",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# With animation - sign classification is consistent across frames\n",
+    "np.random.seed(321)\n",
+    "da_split_anim = xr.DataArray(\n",
+    "    np.stack(\n",
+    "        [\n",
+    "            np.column_stack([np.random.rand(6) * 80 + 20, -np.random.rand(6) * 50 - 10])\n",
+    "            for _ in range(4)\n",
+    "        ],\n",
+    "        axis=-1,\n",
+    "    ),\n",
+    "    dims=[\"month\", \"category\", \"year\"],\n",
+    "    coords={\n",
+    "        \"month\": [\"Jan\", \"Feb\", \"Mar\", \"Apr\", \"May\", \"Jun\"],\n",
+    "        \"category\": [\"Revenue\", \"Costs\"],\n",
+    "        \"year\": [2021, 2022, 2023, 2024],\n",
+    "    },\n",
+    "    name=\"financials\",\n",
+    ")\n",
+    "\n",
+    "xpx(da_split_anim).fast_bar(animation_frame=\"year\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "14",
+   "metadata": {},
+   "source": [
+    "## Mixed Sign Warning\n",
+    "\n",
+    "When a trace has both positive and negative values, `fast_bar()` shows a warning and displays it as a dashed line:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "15",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Both columns have mixed signs - triggers warning\n",
+    "da_mixed = xr.DataArray(\n",
+    "    np.array(\n",
+    "        [\n",
+    "            [50, -30],\n",
+    "            [-40, 60],\n",
+    "            [30, -50],\n",
+    "            [-20, 40],\n",
+    "        ]\n",
+    "    ),\n",
+    "    dims=[\"month\", \"category\"],\n",
+    "    coords={\n",
+    "        \"month\": [\"Jan\", \"Feb\", \"Mar\", \"Apr\"],\n",
+    "        \"category\": [\"A\", \"B\"],\n",
+    "    },\n",
+    ")\n",
+    "\n",
+    "# This will show a warning\n",
+    "xpx(da_mixed).fast_bar()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "16",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# For mixed data, use bar() instead\n",
+    "xpx(da_mixed).bar()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "17",
+   "metadata": {},
+   "source": [
+    "## When to Use\n",
+    "\n",
+    "| Method | Use when... |\n",
+    "|--------|-------------|\n",
+    "| `fast_bar()` | Large datasets, animations, performance matters, data is same-sign per trace |\n",
+    "| `bar()` | Need grouped bars, pattern fills, or have mixed +/- values per trace |\n",
+    "| `area()` | Want smooth continuous fills |"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "name": "python",
+   "version": "3.12.0"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}