pyBrowzarr
Overview
pyBrowzarr — the Python API for configuring and launching Browzarr plots from your code.
pyBrowzarr is a Python package that serves a pre-built Browzarr frontend from a local HTTP server and opens it in your browser (or notebook). It gives you a Pythonic, chainable API to configure a plot and launch it with a single call.
What you can do
- Tune shared and plot-type-specific options (colormaps, extents, transparency, and more).
- Export the result or script an animation with walkthrough keyframes.
- Run from a terminal, Jupyter/JupyterLab, VS Code, or Google Colab automatically.
Installation
pip install browzarr
The browzarr command-line launcher is also installed:
browzarr
A pre-built frontend comes bundled with the package. See Build & Update to rebuild it from source or update it.
First plot
from browzarr import Browzarr
Browzarr(dataset="path://some-zarr-store", variable="some_variable").volume().plot()
That's it — a configured Browzarr view opens in your default browser.
Documentation map
| Guide | Covers |
|---|---|
| Quickstart | Install, Browzarr basics, slicing, launching a plot |
| API Reference | Full reference for Browzarr, its methods, module functions, and plot-type options |
| Export & Animation | The export() method, export options, keyframes, and animation |
| Environments | Behavior in terminal, Jupyter, VS Code, and Colab |
| Build & Update | build_browzarr() and update_browzarr() |