xarray-plotly 0.0.1__py3-none-any.whl

xarray_plotly-0.0.1.dist-info/METADATA

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: xarray_plotly
+Version: 0.0.1
+Summary: Interactive Plotly Express plotting accessor for xarray
+Author: Felix
+License: MIT
+Project-URL: Homepage, https://github.com/FBumann/xarray_plotly
+Project-URL: Documentation, https://fbumann.github.io/xarray_plotly
+Project-URL: Repository, https://github.com/FBumann/xarray_plotly
+Keywords: xarray,plotly,visualization,interactive,plotting
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xarray>=2023.1.0
+Requires-Dist: plotly>=5.0.0
+Requires-Dist: pandas>=1.5.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: pre-commit>=3.0; extra == "dev"
+Requires-Dist: nbstripout>=0.6; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5; extra == "docs"
+Requires-Dist: mkdocs-material>=9.0; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
+Requires-Dist: mkdocs-jupyter>=0.24; extra == "docs"
+Requires-Dist: mkdocs-plotly-plugin>=0.1; extra == "docs"
+Dynamic: license-file
+
+# xarray_plotly
+
+**Interactive Plotly Express plotting accessor 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/)
+
+xarray_plotly provides a `plotly` accessor for xarray DataArray objects that enables interactive plotting using Plotly Express with automatic dimension-to-slot assignment.
+
+## Installation
+
+```bash
+pip install xarray_plotly
+```
+
+Or with uv:
+
+```bash
+uv add xarray_plotly
+```
+
+## Quick Start
+
+```python
+import xarray as xr
+import numpy as np
+from xarray_plotly import xpx
+
+# Create sample data
+da = xr.DataArray(
+    np.random.randn(100, 3, 2).cumsum(axis=0),
+    dims=["time", "city", "scenario"],
+    coords={
+        "time": np.arange(100),
+        "city": ["NYC", "LA", "Chicago"],
+        "scenario": ["baseline", "warming"],
+    },
+    name="temperature",
+)
+
+# Create an interactive line plot
+# Dimensions auto-assign: time→x, city→color, scenario→facet_col
+fig = xpx(da).line()
+fig.show()
+
+# Easy customization
+fig.update_layout(title="Temperature Projections", template="plotly_dark")
+```
+
+## Usage Styles
+
+xarray_plotly supports two equivalent usage styles:
+
+```python
+# Function style (recommended) - full IDE code completion
+from xarray_plotly import xpx
+fig = xpx(da).line()
+
+# Accessor style - works but no IDE completion
+import xarray_plotly
+fig = da.plotly.line()
+```
+
+The `xpx()` function is recommended as it provides full IDE code completion and type hints.
+
+**Why no IDE completion for the accessor?** xarray accessors are registered dynamically at runtime using `register_dataarray_accessor()`. Python's static type checkers and IDEs cannot see these dynamically added attributes, so `da.plotly` appears as an unknown attribute. This limitation could only be solved by xarray itself (e.g., through a type checker plugin), if at all. The `xpx()` function provides a workaround with an explicit return type that IDEs can follow.
+
+## Features
+
+- **Interactive plots**: Zoom, pan, hover for values, toggle traces
+- **Automatic dimension assignment**: Dimensions fill plot slots by position
+- **Easy customization**: Returns Plotly `Figure` objects
+- **Multiple plot types**: `line()`, `bar()`, `area()`, `scatter()`, `box()`, `imshow()`
+- **Faceting and animation**: Built-in support for subplot grids and animations
+
+## Dimension Assignment
+
+Dimensions are automatically assigned to plot "slots" based on their order:
+
+```python
+# dims: (time, city, scenario)
+# auto-assigns: time→x, city→color, scenario→facet_col
+xpx(da).line()
+
+# Override with explicit assignments
+xpx(da).line(x="time", color="scenario", facet_col="city")
+
+# Skip a slot with None
+xpx(da).line(color=None)  # time→x, city→facet_col
+```
+
+## Available Methods
+
+| Method | Description | Slot Order |
+|--------|-------------|------------|
+| `line()` | Line plot | x → color → line_dash → symbol → facet_col → facet_row → animation_frame |
+| `bar()` | Bar chart | x → color → pattern_shape → facet_col → facet_row → animation_frame |
+| `area()` | Stacked area | x → color → pattern_shape → facet_col → facet_row → animation_frame |
+| `scatter()` | Scatter plot | x → color → symbol → facet_col → facet_row → animation_frame |
+| `box()` | Box plot | x → color → facet_col → facet_row → animation_frame |
+| `imshow()` | Heatmap | y → x → facet_col → animation_frame |
+
+## Configuration
+
+Customize label extraction and slot assignment behavior:
+
+```python
+from xarray_plotly import config, xpx
+
+# View current options
+config.get_options()
+
+# Set globally (temporary)
+with config.set_options(label_include_units=False):
+    fig = xpx(da).line()  # Labels won't include units
+```
+
+**Available options:**
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `label_use_long_name` | `True` | Use `long_name` attr for labels |
+| `label_use_standard_name` | `True` | Fall back to `standard_name` |
+| `label_include_units` | `True` | Append units to labels |
+| `label_unit_format` | `"[{units}]"` | Format string for units |
+| `slot_orders` | (defaults) | Slot orders per plot type |
+
+## Documentation
+
+Full documentation with examples: [https://fbumann.github.io/xarray_plotly](https://fbumann.github.io/xarray_plotly)
+
+## License
+
+MIT

xarray_plotly-0.0.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+xarray_plotly/__init__.py,sha256=P2Wfp0Iic2YecJlfDHtsZ6Rm0clpvkNyliei02lMjS4,1735
+xarray_plotly/accessor.py,sha256=oYeA2WYsBe3iTXItqkEOk9aIZ0c7vQB1gjWkQcObU9M,10356
+xarray_plotly/common.py,sha256=8kTa7wcwGqUIVpiEu0DpduxYnrYxamTNhFygT78xgC8,7077
+xarray_plotly/config.py,sha256=JRd6JTQEIqe0bDs_jEUyVcdSMNmZBvNjwPlytywfn4I,6015
+xarray_plotly/plotting.py,sha256=A8J3TIOtUhTGpyp8wk680wo3I8MVe0z_ZWnI67rkkbw,12393
+xarray_plotly/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xarray_plotly-0.0.1.dist-info/licenses/LICENSE,sha256=AvVEfNqbhIm9jHvt0acJNjW1JUKa2a70Zb5rJdEXCJI,1064
+xarray_plotly-0.0.1.dist-info/METADATA,sha256=4qO64nUG0W2FTyQ8E6Ta5Iv6nIJIkWE0Egnqk29IxOs,6077
+xarray_plotly-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+xarray_plotly-0.0.1.dist-info/top_level.txt,sha256=GtMkvuZvLAYTjYXtwoNUa0ag42CJARZJK1CZemYD7pg,14
+xarray_plotly-0.0.1.dist-info/RECORD,,

xarray_plotly-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

xarray_plotly-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 FBumann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

xarray_plotly-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+xarray_plotly