Getting Started
Installation
Run Browzarr online or offline via npm or Julia.
Browzarr can be used in three ways, depending on how much setup you want and whether you need to work offline.
Online — no install
The quickest way to get started: open browzarr.io in a modern browser. Nothing to install, nothing to configure.
The online version runs entirely in your browser. Datasets are fetched directly from their (remote) store to your machine — they are not proxied through any server.
npm (offline)
Install once, run anytime — no internet required after install:
npm install -g browzarr
Then launch:
browzarr
On a custom port:
browzarr --port 8080
# or via environment variable (macOS/Linux)
PORT=8080 browzarr
# Windows PowerShell
$env:PORT=8080; browzarr
# Windows CMD
set "PORT=8080" && browzarr
By default, Browzarr starts on port 3000. If that port is already in use, it will automatically try the next available one.
Julia — Browzarr.jl (offline)
Installation
using Pkg; Pkg.add("Browzarr")
Usage
Launch with a local file, a remote store, or no arguments to get started:
using Browzarr
# default (any available port)
browzarr()
# custom port
browzarr(; port=3000)
# local NetCDF file
browzarr(; store="/absolute/path/to/file.nc")
# local Zarr directory
browzarr(; store="/absolute/path/to/zarr_file.zarr")
# remote Zarr store
browzarr(; store="https://s3.bucket.de:67/misc/out.zarr")
Requirements
- A modern browser (see Browser support)
- WebGPU (optional) — needed for the analytics features; everything else works without it
- For local datasets, use the npm or Julia versions, which can serve files from your disk
Next steps
Head over to the landing page tour for a walkthrough of the interface.