H3 Ruby

Ruby bindings for Uber's H3 library.

Please consult the H3 documentation for a full explanation of terminology and concepts.

Getting Started

You need to install the C lib at https://github.com/uber/h3.

Install the build dependencies as instructed here: https://github.com/uber/h3#install-build-time-dependencies

Do not follow the Compilation Steps. Instead, use the following:

git clone git@github.com:uber/h3.git h3_build
cd h3_build
cmake . -DBUILD_SHARED_LIBS=true
make
sudo make install

The key difference is the BUILD_SHARED_LIBS option.

Installing

gem install h3

or

# Gemfile
gem "h3", "~> 3.2"

Documentation

https://www.rubydoc.info/github/StuartApp/h3_ruby

Usage

require "h3"
H3.geo_to_h3([53.959130, -1.079230], 8).to_s(16)
# => "8819429a9dfffff"

Running Specs

rake