An open API service indexing awesome lists of open source software.

https://github.com/nmandery/h3ronpy

A data science toolkit for the H3 geospatial grid
https://github.com/nmandery/h3ronpy

arrow geopandas geospatial h3 pandas polars python

Last synced: 4 months ago
JSON representation

A data science toolkit for the H3 geospatial grid

Awesome Lists containing this project

README

          

h3ronpy
=======

A data science toolkit for the `H3 geospatial grid `_.

.. image:: https://img.shields.io/pypi/v/h3ronpy
:alt: PyPI
:target: https://pypi.python.org/pypi/h3ronpy/

.. image:: https://readthedocs.org/projects/h3ronpy/badge/?version=latest
:alt: ReadTheDocs
:target: https://h3ronpy.readthedocs.io/

.. image:: https://img.shields.io/conda/vn/conda-forge/h3ronpy.svg
:alt: conda-forge
:target: https://prefix.dev/channels/conda-forge/packages/h3ronpy

This library is not a substitute for the official `python h3 library `_ - instead it provides more
high-level functions on top of H3 and integrations into common dataframe libraries.

Documentation is available on ``_.

Looking for maintainers
-----------------------

My personal focus has shifted quite a bit since I started this project. Currently I am not working much with H3 any more,
so I have very little time to spend on this library, or even to keep up with standard maintenance tasks like upgrades
or answering pull requests and issues. To keep this project somewhat alive, additional maintainers would be very welcome.

Features
--------

* H3 algorithms provided using the performant `h3o `_ library.
* Build on `Apache Arrow `_ and the lightweight `arro3 `_ for efficient data handling. The arrow memory model is compatible with dataframe libraries like `pandas `_ and `polars `_.
* Extensions for the polars `Series`` and `Expr` APIs.
* Some dedicated functions to work with `geopandas `_ `GeoSeries`.
* Multi-threaded conversion of raster data to the H3 grid using `numpy arrays `_.
* Multi-threaded conversion of vector data, including `geopandas` `GeoDataFrames` and any object which supports the python `__geo_interface__` protocol (`shapely`, `geojson`, ...).

Limitations
-----------

Not all functionalities of the H3 grid are wrapped by this library, the current feature-set was implemented
when there was a need and the time for it. As a opensource library new features can be requested in the form of github issues
or contributed using pull requests.

License
-------

MIT