API reference

Top-level functions

decode(ds[, grid_info, name])

decode grid parameters and create a DGGS index

Grid parameter objects

DGGSInfo(level)	Base class for DGGS grid information objects
HealpixInfo(level[, indexing_scheme])	Grid information container for healpix grids.
H3Info(level)	Grid information container for h3 grids.

Dataset

Parameters

Dataset.dggs.grid_info	The grid info object containing the DGGS type and its parameters.
Dataset.dggs.params	The grid parameters after normalization.
Dataset.dggs.decode

Data inference

Dataset.dggs.cell_centers()	derive geographic cell center coordinates
Dataset.dggs.cell_boundaries()	derive cell boundary polygons

DataArray

Parameters

DataArray.dggs.grid_info	The grid info object containing the DGGS type and its parameters.
DataArray.dggs.params	The grid parameters after normalization.
DataArray.dggs.decode

Data inference

DataArray.dggs.cell_centers()	derive geographic cell center coordinates
DataArray.dggs.cell_boundaries()	derive cell boundary polygons

Plotting

DataArray.dggs.explore(*[, cmap, center, ...])

interactively explore the data using lonboard

Tutorial

tutorial.open_dataset(name, grid_name, *[, ...])

Open a dataset from the online repository (requires internet).