API Documentation

Geographic indexers


A coordinate axis is a Variable that specifies one of the coordinates of a variable's values.

RTree([system, dtype, ndims])

R*Tree spatial index for geodetic scalar values.


Time axis.


geohash.area(*args, **kwargs)

Overloaded function.


Returns the bounding box encoded by the geohash.

geohash.bounding_boxes([box, precision])

Returns all geohash codes contained in the defined bounding box.

geohash.decode(*args, **kwargs)

Overloaded function.

geohash.encode(*args, **kwargs)

Overloaded function.


Returns the accuracy in longitude/latitude and degrees for the given precision.

geohash.grid_properties([box, precision])

Returns the property of the grid covering the given bounding box.


Geogrophic Index


Lock handling used to synchronize resources


Returns all neighbors hash clockwise from north around northwest.


Index storage support


Returns the start and end indexes of the different GeoHash boxes.


Binning2D(x, y[, wgs, dtype])

Group a number of more or less continuous values into a smaller number of "bins" located on a grid.

Histogram2D(x, y[, bin_counts, dtype])

Group a number of more or less continuous values into a smaller number of "bins" located on a grid.

Cartesian Grids

grid.Grid2D(*args[, increasing_axes])

2D Cartesian Grid.

grid.Grid3D(*args[, increasing_axes])

3D Cartesian Grid.

grid.Grid4D(*args[, increasing_axes])

4D Cartesian Grid.

Climate and Forecast

Axis identification from CF attribute values.


Units known to the axis defining the latitude.


Units known to the axis defining the longitude.


Units known to the axis defining the time.


Units management for axes.

Geodetic systems

geodetic.Box([min_corner, max_corner])

Defines a box made of two describing points in a spherical coordinates system in degrees.


World Geodetic Coordinates System.

geodetic.Point([lon, lat])

Handle a point in an equatorial spherical coordinate system in degrees.

geodetic.Polygon(outer[, inners])

The polygon contains an outer ring and zero or more inner rings.


World Geodetic System (WGS).

Cartesian interpolators

bicubic(mesh, x, y[, z, u, nx, ny, ...])

Bicubic gridded interpolator.

bivariate(grid2d, x, y[, interpolator, ...])

Interpolate the values provided on the defined bivariate function.

trivariate(grid3d, x, y, z[, interpolator, ...])

Interpolate the values provided on the defined trivariate function.

quadrivariate(grid4d, x, y, z, u[, ...])

Interpolate the values provided on the defined quadrivariate function.

Fill undefined values

fill.loess(mesh[, nx, ny, value_type, ...])

Filter values using a locally weighted regression function or LOESS.

fill.gauss_seidel(mesh[, first_guess, ...])

Replaces all undefined values (NaN) in a grid using the Gauss-Seidel method by relaxation.

Univariate statistics

DescriptiveStatistics(values[, weights, ...])

Univariate descriptive statistics.

StreamingHistogram(values[, weights, axis, ...])

Streaming histogram.


Construction of Cartesian interpolators from xarray.DataArray

backends.xarray.Grid2D(data_array[, ...])

Builds a Grid2D from the Xarray data provided.

backends.xarray.Grid3D(data_array[, ...])

Builds a Grid3D from the Xarray data provided.

backends.xarray.Grid4D(data_array[, ...])

Builds a Grid4D from the Xarray data provided.


Interpolation on a regular grid in arbitrary dimensions