Skip to content

xarray-contrib/xoak

Repository files navigation

xoak

Tests Coverage Documentation Status Binder

Xoak is an Xarray extension that allows point-wise selection of irregular, n-dimensional data encoded in coordinates with an arbitrary number of dimensions.

It provides a built-in index adapter for Scipy's cKDTree, as well as adapters for index structures implemented in these 3rd-party libraries (optional dependencies):

  • Scikit-Learn: BallTree and KDTree, which support various distance metrics.
  • pys2index: S2PointIndex for efficient indexing of lat/lon point data, based on s2geometry.

Xoak also provides a mechanism for easily adding and registering custom index adapters.

Install

Xoak can be installed using conda (or mamba):

$ conda install xoak -c conda-forge

or pip:

$ python -m pip install xoak

Xoak's optional dependencies can be installed using conda:

$ conda install scikit-learn pys2index -c conda-forge

Documentation

Documentation is hosted on ReadTheDocs: https://xoak.readthedocs.io/

License

MIT License, see LICENSE file.