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. Read The Doc is available for additional information.
XArray Viewer is a Pan3D application focused on geospatial rendering use cases. This is a graphical user interface leveraging the Pan3D infrastructure to help geospatial scientists explore data.
For an introduction to this project, check out our blog post.
To install requirements for the Pan3D VTK mesh builder class only:
pip install pan3d
To install requirements for the graphical user interface (viewers + explorers):
pip install "pan3d[viewer]"
Optional: to install requirements for Pangeo and ESGF catalogs, respectively:
pip install "pan3d[pangeo]"
pip install "pan3d[esgf]"
Recommended: To install all requirements, including optional packages:
pip install "pan3d[all]"
xr-viewer is the main entrypoint for launching XArray Viewer locally. Below are some example usages.
To launch XArray Viewer without a target dataset to browse XArray examples:
xr-viewer
To launch XArray Viewer with a local path to a target dataset:
xr-viewer --xarray-file ./examples/example_dataset.nc
To launch XArray Viewer with a remote URL to a target dataset:
xr-viewer --xarray-url https://host.org/link/to/dataset.zarr
To launch XArray Viewer with a compatible configuration file (see examples):
xr-viewer --import-state ./examples/example_config_xarray.json
To launch the Catalog browser will allow you to query the Pangeo and ESGF Dataset Catalogs (see Catalogs Tutorial) depending on the available dependencies:
xr-catalog
You may have to install the required dependencies:
pip install "pan3d[pangeo]"
pip install "pan3d[esgf]"
The
xr-viewerentrypoint will automatically launch your default browser to openlocalhost:8080.To launch without opening your browser, add the
--serverargument to your command.
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.
FAQs
Utility package for processing and visualizing 3D datasets
We found that pan3d demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.
Security News
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.