0
Fork 0
mirror of https://github.com/uber/h3-py.git synced 2026-11-16 07:44:46 +00:00
Python bindings for H3, a hierarchical hexagonal geospatial indexing system https://uber.github.io/h3-py
  • Python 70.2%
  • Cython 27.3%
  • CMake 1.8%
  • Just 0.7%
Find a file
AJ Friend 480bf972db
add a twine check (#123)
* add a twine check

* let's actually try to do a release

* wheelhouse not dist
History 2020-05-26 23:03:07 -07:00
.github/workflows add a twine check (#123) 2020-05-26 23:03:07 -07:00
src add a twine check (#123) 2020-05-26 23:03:07 -07:00
tests Prepare for 3.6.1 alpha release (#119) 2020-05-25 18:13:38 -07:00
.flake8 The big Cython move (#99) 2020-05-10 11:47:45 -07:00
.gitignore The big Cython move (#99) 2020-05-10 11:47:45 -07:00
.gitmodules The big Cython move (#99) 2020-05-10 11:47:45 -07:00
CHANGELOG.md The big Cython move (#99) 2020-05-10 11:47:45 -07:00
CMakeLists.txt Wheels for Mac/Linux (#115) 2020-05-22 11:48:19 -07:00
dev_notes.md Use pyproject.toml (#111) 2020-05-17 10:39:55 -07:00
LICENSE first commit 2018-07-30 12:24:17 -07:00
makefile Use setup.py for optional requirements instead of requirements-dev.txt (#117) 2020-05-25 10:51:16 -07:00
pyproject.toml Windows wheels (#116) 2020-05-24 11:04:55 -07:00
readme.md Use setup.py for optional requirements instead of requirements-dev.txt (#117) 2020-05-25 10:51:16 -07:00
setup.py Use setup.py for optional requirements instead of requirements-dev.txt (#117) 2020-05-25 10:51:16 -07:00

H3 Logo

h3-py

PyPI version version version

CI-linux CI-macos CI-windows codecov

Python bindings for the H3 Core Library.

For API reference, please see the H3 Documentation.

NOTE: This version (v.3.6.1) corresponds to the new Cython bindings, which will replace the old bindings (v3.4.3). This version is not yet published to PyPI.

Install from PyPI

TODO: instructions for installing from pre-built wheels

Install from GitHub

You need to have cc, make, cmake, and git in your $PATH when installing this package.

Then run:

pip install git+https://github.com/uber/h3-py.git

Try the library with:

>>> import h3
>>> h3.geo_to_h3(0, 0, 0)
'8075fffffffffff'

NumPy support

h3 has no runtime dependencies on other libraries, so a standard pip install will install no additional libraries.

The optional h3.api.numpy_int API requires numpy. To have numpy installed (if it isn't already) along with h3, run:

pip install git+https://github.com/uber/h3-py.git[numpy]

or

pip install git+https://github.com/uber/h3-py.git[all]

Browse a collection of example notebooks, and if you have examples or visualizations of your own, please feel free to contribute!

We also have a simple walkthrough of the API. For more information, please see the H3 Documentation.