Skip to main content

Python/NumPy compatible geographical index based on s2geometry

Project description


test status

Python / NumPy compatible geographical index based on s2geometry.

This project doesn't provide Python wrappers for the whole s2geometry library. Instead, it aims to provide some index wrappers with an API similar to scipy.spatial.cKDTree.

Build Dependencies


Using conda

pys2index can be installed using conda (or mamba):

$ conda install pys2index -c conda-forge

From source

First, clone this repository:

$ git clone
$ cd pys2index

You can install all the dependencies using conda (or mamba):

$ conda install python cxx-compiler numpy s2geometry pybind11 xtensor-python cmake scikit-build-core -c conda-forge

Build and install this library

$ python -m pip install . --no-build-isolation


In [1]: import numpy as np

In [2]: from pys2index import S2PointIndex

In [3]: latlon_points = np.array([[40.0, 15.0],
   ...:                           [-20.0, 53.0],
   ...:                           [81.0, 153.0]])

In [4]: index = S2PointIndex(latlon_points)

In [5]: query_points = np.array([[-10.0, 60.0],
   ...:                          [45.0, -20.0],
   ...:                          [75.0, 122.0]])

In [6]: distances, positions = index.query(query_points)

In [7]: distances
Out[7]: array([12.06534671, 26.07312392,  8.60671311])

In [8]: positions
Out[8]: array([1, 0, 2])

In [9]: index.get_cell_ids()
Out[9]: array([1386017682036854979, 2415595305706115691, 6525033740530229539],

Running the tests

Running the tests requires pytest (it is also available on conda-forge).

$ pytest .

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

pys2index-0.1.5.tar.gz (14.0 kB view hashes)

Uploaded Source

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