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