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

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

@@ -14,10 +14,10 @@ jobs:
         python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v7
 
       - name: Set up Python ${{ matrix.python-version }}
         run: uv python install ${{ matrix.python-version }}
@@ -35,7 +35,7 @@ jobs:
         run: uv run pytest --cov=xarray_plotly --cov-report=xml
 
       - name: Upload coverage
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         if: matrix.python-version == '3.12'
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

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

@@ -14,10 +14,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v7
 
       - name: Install dependencies
         run: uv sync --extra docs

{xarray_plotly-0.0.3 → xarray_plotly-0.0.5}/.github/workflows/release.yml

@@ -13,10 +13,10 @@ jobs:
       contents: write  # for creating GitHub release
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v7
 
       - name: Build package
         run: uv build

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xarray_plotly
-Version: 0.0.3
+Version: 0.0.5
 Summary: Interactive Plotly Express plotting accessor for xarray
 Author: Felix
 License: MIT
@@ -25,16 +25,16 @@ Requires-Dist: xarray>=2023.1.0
 Requires-Dist: plotly>=5.0.0
 Requires-Dist: pandas>=1.5.0
 Provides-Extra: dev
-Requires-Dist: pytest==8.3.5; extra == "dev"
-Requires-Dist: pytest-cov==6.0.0; extra == "dev"
-Requires-Dist: mypy==1.14.1; extra == "dev"
-Requires-Dist: ruff==0.9.2; extra == "dev"
-Requires-Dist: pre-commit==4.0.1; extra == "dev"
-Requires-Dist: nbstripout==0.8.1; extra == "dev"
+Requires-Dist: pytest==9.0.2; extra == "dev"
+Requires-Dist: pytest-cov==7.0.0; extra == "dev"
+Requires-Dist: mypy==1.19.1; extra == "dev"
+Requires-Dist: ruff==0.14.11; extra == "dev"
+Requires-Dist: pre-commit==4.5.1; extra == "dev"
+Requires-Dist: nbstripout==0.8.2; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: mkdocs==1.6.1; extra == "docs"
-Requires-Dist: mkdocs-material==9.5.49; extra == "docs"
-Requires-Dist: mkdocstrings[python]==0.27.0; extra == "docs"
+Requires-Dist: mkdocs-material==9.7.1; extra == "docs"
+Requires-Dist: mkdocstrings[python]==1.0.0; extra == "docs"
 Requires-Dist: mkdocs-jupyter==0.25.1; extra == "docs"
 Requires-Dist: mkdocs-plotly-plugin==0.1.3; extra == "docs"
 Requires-Dist: jupyter==1.1.1; extra == "docs"
@@ -44,8 +44,8 @@ Dynamic: license-file
 
 **Interactive Plotly Express plotting for xarray**
 
-[![PyPI version](https://badge.fury.io/py/xarray_plotly.svg)](https://badge.fury.io/py/xarray_plotly)
-[![Python](https://img.shields.io/pypi/pyversions/xarray_plotly.svg)](https://pypi.org/project/xarray_plotly/)
+[![PyPI version](https://badge.fury.io/py/xarray-plotly.svg)](https://badge.fury.io/py/xarray-plotly)
+[![Python](https://img.shields.io/pypi/pyversions/xarray-plotly.svg)](https://pypi.org/project/xarray-plotly/)
 [![CI](https://github.com/FBumann/xarray_plotly/actions/workflows/ci.yml/badge.svg)](https://github.com/FBumann/xarray_plotly/actions)
 [![Docs](https://img.shields.io/badge/docs-fbumann.github.io-blue)](https://fbumann.github.io/xarray_plotly/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

{xarray_plotly-0.0.3 → xarray_plotly-0.0.5}/README.md

@@ -2,8 +2,8 @@
 
 **Interactive Plotly Express plotting for xarray**
 
-[![PyPI version](https://badge.fury.io/py/xarray_plotly.svg)](https://badge.fury.io/py/xarray_plotly)
-[![Python](https://img.shields.io/pypi/pyversions/xarray_plotly.svg)](https://pypi.org/project/xarray_plotly/)
+[![PyPI version](https://badge.fury.io/py/xarray-plotly.svg)](https://badge.fury.io/py/xarray-plotly)
+[![Python](https://img.shields.io/pypi/pyversions/xarray-plotly.svg)](https://pypi.org/project/xarray-plotly/)
 [![CI](https://github.com/FBumann/xarray_plotly/actions/workflows/ci.yml/badge.svg)](https://github.com/FBumann/xarray_plotly/actions)
 [![Docs](https://img.shields.io/badge/docs-fbumann.github.io-blue)](https://fbumann.github.io/xarray_plotly/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

xarray_plotly-0.0.5/docs/examples/datasets.ipynb

@@ -0,0 +1,261 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Dataset Plotting\n",
+    "\n",
+    "Plot multiple variables from an xarray Dataset with automatic or custom slot assignment."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "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": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Create a Dataset with multiple variables\n",
+    "time = np.arange(50)\n",
+    "cities = [\"NYC\", \"LA\", \"Chicago\"]\n",
+    "\n",
+    "ds = xr.Dataset(\n",
+    "    {\n",
+    "        \"temperature\": ([\"time\", \"city\"], 20 + 5 * np.random.randn(50, 3).cumsum(axis=0) / 10),\n",
+    "        \"humidity\": ([\"time\", \"city\"], 50 + 10 * np.random.randn(50, 3).cumsum(axis=0) / 10),\n",
+    "        \"pressure\": ([\"time\", \"city\"], 1013 + np.random.randn(50, 3).cumsum(axis=0)),\n",
+    "    },\n",
+    "    coords={\"time\": time, \"city\": cities},\n",
+    ")\n",
+    "ds"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Plot All Variables\n",
+    "\n",
+    "When you call a plot method on a Dataset without specifying `var`, all variables are combined into a single DataArray with a new `\"variable\"` dimension:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# All variables: time -> x, variable -> color, city -> line_dash\n",
+    "xpx(ds).line()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Control Where \"variable\" Goes\n",
+    "\n",
+    "The `\"variable\"` dimension can be assigned to any slot:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Variables as facet columns\n",
+    "xpx(ds).line(facet_col=\"variable\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Variables as rows, cities as columns\n",
+    "xpx(ds).line(facet_row=\"variable\", facet_col=\"city\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configure Default \"variable\" Position\n",
+    "\n",
+    "By default, `\"variable\"` is placed as the **second** dimension so it maps to `color`. This keeps your first dimension (e.g., time) on the x-axis.\n",
+    "\n",
+    "You can change this globally with `config.set_options()`:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Default: position=1 (second) -> variable goes to color\n",
+    "# Note: to_array() puts \"variable\" first, but xpx() reorders it to position 1\n",
+    "print(\"Raw to_array() dims:\", ds.to_array().dims)  # (variable, time, city)\n",
+    "print(\"After xpx reorder:   (time, variable, city)\")  # time->x, variable->color\n",
+    "xpx(ds).line(title=\"Default: variable as color (position=1)\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Position 0: variable goes first (x-axis) - usually not what you want!\n",
+    "with config.set_options(dataset_variable_position=0):\n",
+    "    fig = xpx(ds).line(title=\"position=0: variable on x-axis (probably not desired)\")\n",
+    "fig"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Position -1: variable goes last -> city gets color, variable gets line_dash\n",
+    "with config.set_options(dataset_variable_position=-1):\n",
+    "    fig = xpx(ds).line(title=\"position=-1: variable as line_dash\")\n",
+    "fig"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Plot a Single Variable\n",
+    "\n",
+    "Use `var=\"name\"` to plot just one variable:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "xpx(ds).line(var=\"temperature\", title=\"Temperature Only\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Different Plot Types"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Bar chart - latest values by city\n",
+    "xpx(ds.isel(time=-1)).bar(x=\"city\", color=\"variable\", barmode=\"group\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Box plot - distribution by variable\n",
+    "xpx(ds).box(x=\"variable\", color=\"city\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Area chart\n",
+    "xpx(ds).area(var=\"humidity\", title=\"Humidity Over Time\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Scatter\n",
+    "xpx(ds).scatter(var=\"temperature\", title=\"Temperature Scatter\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Pie chart - snapshot at one time\n",
+    "xpx(ds.isel(time=-1)).pie(var=\"temperature\", names=\"city\", title=\"Temperature Distribution\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Combining Slot Assignments\n",
+    "\n",
+    "Mix explicit assignments with auto-assignment:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Explicit: variable -> facet_col, let city auto-assign to color\n",
+    "xpx(ds).line(facet_col=\"variable\", color=\"city\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Skip color slot with None\n",
+    "xpx(ds).line(var=\"temperature\", color=None)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "name": "python",
+   "version": "3.12.0"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

xarray_plotly-0.0.5/docs/examples/dimensions.ipynb

@@ -0,0 +1,232 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Dimensions, Facets & Animation\n",
+    "\n",
+    "How to control which dimensions map to which visual properties."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import plotly.express as px\n",
+    "import xarray as xr\n",
+    "\n",
+    "from xarray_plotly import config, xpx\n",
+    "\n",
+    "config.notebook()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Sample data: 2D\n",
+    "df = px.data.stocks().set_index(\"date\")\n",
+    "df.index = df.index.astype(\"datetime64[ns]\")\n",
+    "\n",
+    "stocks = xr.DataArray(\n",
+    "    df.values,\n",
+    "    dims=[\"date\", \"company\"],\n",
+    "    coords={\"date\": df.index, \"company\": df.columns.tolist()},\n",
+    "    name=\"price\",\n",
+    ")\n",
+    "\n",
+    "# Sample data: 3D\n",
+    "df_gap = px.data.gapminder()\n",
+    "countries = [\"United States\", \"China\", \"Germany\", \"Brazil\"]\n",
+    "metrics = [\"lifeExp\", \"gdpPercap\"]\n",
+    "\n",
+    "arrays = []\n",
+    "for metric in metrics:\n",
+    "    df_pivot = df_gap[df_gap[\"country\"].isin(countries)].pivot(\n",
+    "        index=\"year\", columns=\"country\", values=metric\n",
+    "    )\n",
+    "    arrays.append(df_pivot.values)\n",
+    "\n",
+    "data_3d = xr.DataArray(\n",
+    "    arrays,\n",
+    "    dims=[\"metric\", \"year\", \"country\"],\n",
+    "    coords={\n",
+    "        \"metric\": metrics,\n",
+    "        \"year\": df_pivot.index.tolist(),\n",
+    "        \"country\": df_pivot.columns.tolist(),\n",
+    "    },\n",
+    "    name=\"value\",\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Default Dimension Assignment\n",
+    "\n",
+    "Dimensions are assigned to slots in order:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# date → x, company → color\n",
+    "xpx(stocks).line()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Explicit Assignment\n",
+    "\n",
+    "Override the defaults by specifying which dimension goes where:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Swap: company → x, date → color\n",
+    "xpx(stocks.isel(date=[0, 50, 100])).bar(x=\"company\", color=\"date\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Skipping Slots with None\n",
+    "\n",
+    "Use `None` to skip a slot, so dimensions shift to the next available slot:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Skip color → company goes to line_dash instead\n",
+    "xpx(stocks.sel(company=[\"GOOG\", \"AAPL\", \"MSFT\"])).line(color=None)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Available Slots\n",
+    "\n",
+    "Different plot types have different slots:\n",
+    "\n",
+    "| Plot | Slots (in order) |\n",
+    "|------|------------------|\n",
+    "| line | x, color, line_dash, facet_col, facet_row, animation_frame |\n",
+    "| scatter | x, color, symbol, facet_col, facet_row, animation_frame |\n",
+    "| bar | x, color, facet_col, facet_row, animation_frame |\n",
+    "| imshow | x, y, facet_col, facet_row, animation_frame |"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# line_dash for third dimension\n",
+    "xpx(stocks.sel(company=[\"GOOG\", \"AAPL\"])).line(line_dash=\"company\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# symbol for scatter\n",
+    "xpx(stocks.sel(company=[\"GOOG\", \"AAPL\"])).scatter(symbol=\"company\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Faceting\n",
+    "\n",
+    "Create a grid of subplots with `facet_col` and `facet_row`:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# One subplot per metric\n",
+    "xpx(data_3d).line(facet_col=\"metric\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Grid: metric x country\n",
+    "xpx(data_3d).line(x=\"year\", facet_col=\"metric\", facet_row=\"country\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Animation\n",
+    "\n",
+    "Animate over a dimension with `animation_frame`:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Animate through years\n",
+    "xpx(data_3d.sel(metric=\"lifeExp\")).bar(x=\"country\", animation_frame=\"year\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Animate heatmap\n",
+    "xpx(data_3d).imshow(animation_frame=\"metric\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "name": "python",
+   "version": "3.12.0"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}