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.

GeoTrame 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 DatasetBuilder class only:

pip install pan3d

To install requirements for the GeoTrame user interface:

pip install "pan3d[geotrame]"

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

geotrame is the main entrypoint for launching GeoTrame locally. Below are some example usages.

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

geotrame

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

geotrame --dataset=/path/to/dataset.zarr

To launch GeoTrame with a remote URL to a target dataset:

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

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

geotrame --config_path=/path/to/pan3d_state.json

To launch GeoTrame with the option to browse the Pangeo and ESGF Dataset Catalogs (see Catalogs Tutorial):

geotrame --catalogs pangeo esgf

Or you may specify only one catalog:

geotrame --catalogs pangeo

geotrame --catalogs esgf

The geotrame 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.9.2.tar.gz (40.4 kB view details)

Uploaded Source

Built Distribution

pan3d-0.9.2-py3-none-any.whl (47.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pan3d-0.9.2.tar.gz
Algorithm Hash digest
SHA256 b38e6c7e7f67d1aad8295df7fa3aafb9de5467d1db927f291361c30eea9e01a1
MD5 655d021241ed08a0cab7c394c5db7851
BLAKE2b-256 728db2477908dcaa5fd71120f915dfaea752089be8d3afbdaa0910390757df5c

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: pan3d-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 47.4 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.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 59e55506f4706d4c7e8249d649ab3e27ec46bd234b9a9b50c20d4dc5e5d06cd8
MD5 c9059e238e8db29dcaaf03391d8b68e7
BLAKE2b-256 56377887c06f61f49315c2b842313a02c44139fb5bee31c80dbbe05dd7326448

See more details on using hashes here.

Provenance

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