Quick Start

Once you have installed the Python and JS dependencies, the simplest way to use ParticleViz is to pass a trajectory dataset from the command line (a .nc NetCDF file or a Zarr store directory). You need to be patient the first time you run it because it will install all the Javascript dependencies. It will be much faster after that. This will generate the default web interface to display your data.

uv run python ParticleViz.py --input_file <path to dataset>

Test with the Global_Marine_Debris.nc example in ExampleData:

uv run python ParticleViz.py --input_file ExampleData/Global_Marine_Debris.nc

Or with a Zarr store:

uv run python ParticleViz.py --input_file /path/to/output.zarr

For custom maps, multiple experiments, and styling options, see Configuration or the runnable Examples for ConfigExamples/ scenarios.

To run without a local Python/Node install, see Docker on the Install page.