https://github.com/nmandery/h3ron

Rust crates for the H3 geospatial indexing system
https://github.com/nmandery/h3ron

dataframe geospatial h3 ndarray rust

Last synced: 6 months ago
JSON representation

Rust crates for the H3 geospatial indexing system

• Host: GitHub
• URL: https://github.com/nmandery/h3ron
• Owner: nmandery
• License: mit
• Archived: true
• Created: 2021-01-04T10:50:47.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-12-16T19:29:27.000Z (almost 2 years ago)
• Last Synced: 2025-04-01T13:17:42.813Z (7 months ago)
• Topics: dataframe, geospatial, h3, ndarray, rust
• Language: Rust
• Homepage:
• Size: 19.4 MB
• Stars: 85
• Watchers: 4
• Forks: 12
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

          
# h3ron

![ci](https://github.com/nmandery/h3ron/workflows/CI/badge.svg) [![dependency status](https://deps.rs/repo/github/nmandery/h3ron/status.svg)](https://deps.rs/repo/github/nmandery/h3ron)

[Rust](https://rustlang.org) libraries for the [H3](https://h3geo.org) geospatial indexing system.

## Maintenance status

In january 2023 the [h3o library](https://github.com/HydroniumLabs/h3o) - a port of H3 to rust - has been released. This brings many benefits including type safety, compilation to WASM and performance improvements 

(example: [issue comparing raster to h3 conversion](https://github.com/nmandery/rasterh3/issues/1)).

As a result these libraries will most certainly only receive dependency upgrades in the future. Some parts

will maybe be ported to h3o, like the raster to H3 conversion [already was](https://github.com/nmandery/rasterh3).

## Crates

This repository consists of multiple crates:

### [h3ron](./h3ron) [![Latest Version](https://img.shields.io/crates/v/h3ron.svg)](https://crates.io/crates/h3ron) [![Documentation](https://docs.rs/h3ron/badge.svg)](https://docs.rs/h3ron)

High-level rust API for H3.

This crate builds on-top the official C library. The recently released [h3o project](https://github.com/HydroniumLabs/h3o) provides an implementation of H3 in pure rust.

[Documentation](https://docs.rs/h3ron) | [Changelog](h3ron/CHANGES.md)

### [h3ron-h3-sys](./h3ron-h3-sys) [![Latest Version](https://img.shields.io/crates/v/h3ron-h3-sys.svg)](https://crates.io/crates/h3ron-h3-sys) [![Documentation](https://docs.rs/h3ron-h3-sys/badge.svg)](https://docs.rs/h3ron-h3-sys)

bindgen-generated bindings for the statically linked libh3 C library.

[Documentation](https://docs.rs/h3ron-h3-sys) | [Changelog](h3ron-h3-sys/CHANGES.md)

### [h3ron-ndarray](h3ron-ndarray) [![Latest Version](https://img.shields.io/crates/v/h3ron-ndarray.svg)](https://crates.io/crates/h3ron-ndarray) [![Documentation](https://docs.rs/h3ron-ndarray/badge.svg)](https://docs.rs/h3ron-ndarray)

Integration with the [ndarray](https://github.com/rust-ndarray/ndarray) crate to generate H3 cells from raster data (using [gdal](https://github.com/georust/gdal), ...)

[Documentation](https://docs.rs/h3ron-ndarray) | [Changelog](h3ron-ndarray/CHANGES.md)

### [h3ron-graph](h3ron-graph) [![Latest Version](https://img.shields.io/crates/v/h3ron-graph.svg)](https://crates.io/crates/h3ron-graph) [![Documentation](https://docs.rs/h3ron-graph/badge.svg)](https://docs.rs/h3ron-graph)

Graph algorithms on edges of the H3 spatial indexing system.

[Documentation](https://docs.rs/h3ron-graph) | [Changelog](h3ron-graph/CHANGES.md)

### [h3ron-polars](h3ron-polars) [![Latest Version](https://img.shields.io/crates/v/h3ron-polars.svg)](https://crates.io/crates/h3ron-polars) [![Documentation](https://docs.rs/h3ron-polars/badge.svg)](https://docs.rs/h3ron-polars)

Integration of the [h3](https://h3geo.org) geospatial indexing system with [polars](https://docs.rs/polars) dataframes by providing extension traits

to `UInt64Chunked` and `DataFrame`.

## Python bindings

Python bindings for parts of the functionalities are available in the `h3ronpy` extension now located in an [own repository](https://github.com/nmandery/h3ronpy).

For an overview of some features complementary to libh3 please see the README of the python bindings.

## Why this name?

Well, coming up with a good name for a project while avoiding naming conflicts is hard. On the other hand are animal-based names always pretty easy to remember.

How to pronounce it? I got no idea - probably like the [heron bird family](https://en.wikipedia.org/wiki/Heron).

## License

[MIT](./LICENSE-MIT)

Some data in the `data` directory is derived from OpenStreetMap and as such is copyright by the OpenStreetMap contributors. For

the OSM license see [OSMs Copyright and License page](https://www.openstreetmap.org/copyright).