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
Isaac Brodsky ff13deb211
Merge pull request #93 from nastasi-oq/wheel-win64-vs19
Changes to build wheel for Windows 10 64bit
History 2020-02-06 08:26:30 -08:00
h3 remove null values in k_ring_distances and hex_range_distance (#44) 2019-04-18 21:54:25 -07:00
tests remove null values in k_ring_distances and hex_range_distance (#44) 2019-04-18 21:54:25 -07:00
.gitignore Remove unused imports & delete empty cell 2018-08-16 16:28:35 -07:00
.install.sh replaced 'cmake ... -G <visual studio version>' with more generic 'cmake ... -A x64' for 'h3' windows compilation 2020-02-03 11:19:07 +01:00
.test_parity.sh Use the version number in the parity test 2018-11-14 15:19:54 -08:00
.test_parity_cleanup.sh first commit 2018-07-30 12:24:17 -07:00
.travis.yml Windows build (#37) 2019-03-26 01:09:01 -07:00
appveyor.yml Windows build (#37) 2019-03-26 01:09:01 -07:00
binding_version.py Upgrade to V3.4.3 (#46) 2019-04-19 17:16:42 -07:00
CHANGELOG.md Upgrade to V3.4.3 (#46) 2019-04-19 17:16:42 -07:00
fabfile.py first commit 2018-07-30 12:24:17 -07:00
h3_version.py upgrade version to 3.4.2 (#31) 2019-03-04 20:23:12 -08:00
LICENSE first commit 2018-07-30 12:24:17 -07:00
MANIFEST.in update 2018-08-14 21:08:43 -07:00
README.rst README change to mention Git and Cmake version 2019-10-21 15:15:08 -07:00
requirements-dev.txt Upgrade pytest and pytest-cov 2019-10-22 17:50:59 -07:00
requirements.txt first commit 2018-07-30 12:24:17 -07:00
setup.py changes to build wheel for Windows 10 64bit 2020-01-20 09:34:52 +01:00

H3-Python
=========

|Build Status| |Build Status Appveyor| |H3 Version| |License|

This library provides Python bindings for the `H3 Core
Library <https://github.com/uber/h3>`__. For API reference, please see
the `H3 Documentation <https://uber.github.io/h3/>`__.

Installing
==========

You need to have ``cc``, ``make``, ``cmake`` (version 3.1 or above),
and ``git`` in your ``$PATH`` when installing this package:

.. code:: sh

    which cc
    /usr/bin/cc
    which make
    /usr/bin/make
    which cmake
    /usr/bin/cmake
    which git
    /usr/bin/git

.. code:: sh

    pip install h3

Installing on Windows
---------------------

On Windows you will also need to have ``bash`` (for example from Git)
installed.

Development
===========

.. code:: sh

    git clone https://github.com/uber/h3-py.git && cd h3-py
    virtualenv env 
    source env/bin/activate
    pip install -r requirements-dev.txt
    fab bootstrap



Gallery
===============

We love contributions. To contribute notebooks or cool visualizations,
please go to `Notebooks <https://github.com/uber/h3-py-notebooks>`__.
You can see using Jupyter's nbviewer:

https://nbviewer.jupyter.org/github/uber/h3-py-notebooks/tree/master/



Here is also a simple `walkthrough <https://nbviewer.jupyter.org/github/uber/h3-py-notebooks/blob/master/Usage.ipynb>`__ of the API. For more information, please see the `H3
Documentation <https://uber.github.io/h3/>`__.





    


.. |Build Status| image:: https://travis-ci.org/uber/h3-py.svg?branch=master
   :target: https://travis-ci.org/uber/h3-py
.. |Build Status Appveyor| image:: https://ci.appveyor.com/api/projects/status/eaa11gfwmr0gtr5y/branch/master?svg=true
   :target: https://ci.appveyor.com/project/Uber/h3-py/branch/master
.. |H3 Version| image:: https://img.shields.io/badge/h3-v3.4.2-blue.svg
   :target: https://github.com/uber/h3/releases/tag/v3.4.2
.. |License| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
   :target: LICENSE