Skip to main content

Utility package for processing and visualizing 3D datasets

Project description

Pan3D

Kitware Logo

Documentation Status Binder Build Status PyPI Version License

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.

Installation

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]"

Quick Start

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-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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pan3d-0.10.3.tar.gz (67.1 kB view details)

Uploaded Source

Built Distribution

pan3d-0.10.3-py3-none-any.whl (77.2 kB view details)

Uploaded Python 3

File details

Details for the file pan3d-0.10.3.tar.gz.

File metadata

  • Download URL: pan3d-0.10.3.tar.gz
  • Upload date:
  • Size: 67.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pan3d-0.10.3.tar.gz
Algorithm Hash digest
SHA256 dc59c664f7f54701d5bbbe59dcccaff127c6610cb4bbfac057c87535557576cc
MD5 c0fcb1311169ec11f6d5d419a8a299bd
BLAKE2b-256 36a9a3608e9bc47a9be3b18270ce873cef594b71439409340eebdab7fe04ffd2

See more details on using hashes here.

Provenance

The following attestation bundles were made for pan3d-0.10.3.tar.gz:

Publisher: test_and_release.yml on Kitware/pan3d

Attestations:

File details

Details for the file pan3d-0.10.3-py3-none-any.whl.

File metadata

  • Download URL: pan3d-0.10.3-py3-none-any.whl
  • Upload date:
  • Size: 77.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pan3d-0.10.3-py3-none-any.whl
Algorithm Hash digest
SHA256 25ead4ad5db809162303d7f88ecfe9447faa428cc66efffa15f4439021aa99fc
MD5 ada8b44efcb8acb8c2382a50b324edab
BLAKE2b-256 563339825c3b471b0276790f792b7731eb9d85db9268651b661249a85e9323c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for pan3d-0.10.3-py3-none-any.whl:

Publisher: test_and_release.yml on Kitware/pan3d

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page