pan3d 0.4.0

Utility package for processing and visualizing 3D datasets

Pan3D

Pan3D aims to be an utility package for viewing and processing a wide variety of multidimensional datasets. Any dataset that can be interpreted with xarray can be explored and rendered with Pan3D.

For an introduction to this project, check out our blog post.

Installation

pip install pan3d[viewer]

Quick Start

pan3d-viewer is the main entrypoint for launching Pan3D locally. Below are some example usages.

To launch Pan3D without a target dataset to browse XArray examples:

pan3d-viewer

To launch Pan3D without a target dataset to browse Pangeo Forge examples:

pan3d-viewer --pangeo

To launch Pan3D with a local path to a target dataset:

pan3d-viewer --dataset=/path/to/dataset.zarr

To launch Pan3D with a link to a target dataset:

pan3d-viewer --dataset=https://host.org/link/to/dataset.zarr

To launch Pan3D with a compatible configuration file (see examples):

pan3d-viewer --config_path=/path/to/pan3d_state.json

The pan3d-viewer entrypoint will automatically launch your default browser to open localhost:8080.

To launch without opening your browser, add the --server argument to your command.

Tutorials

• How to use the Pan3D viewer
• Pan3D command line
• How to use Pan3D in a Jupyter notebook

Examples

Pan3D comes with a set of example configuration files and example Jupyter notebooks in the examples folder. You can checkout the repository to run these locally, or you can use the Pan3D Binder instance to run these examples.