Installation

We recommend using prebuilt bindings if they are available for your programming language. Bindings for Go, Java, JavaScript, Python, and others are available.

Package managers

Python

Using PyPi, run:

pip install h3

Using Conda, run:

conda config --add channels conda-forge
conda install h3-py

Java

Using Maven, add to your pom.xml:

<dependency>
    <groupId>com.uber</groupId>
    <artifactId>h3</artifactId>
    <version>3.7.1</version>
</dependency>

Using Gradle, add to your build script:

compile("com.uber:h3:3.7.1")

JavaScript

Using npm, run:

npm install h3-js

Using yarn, run:

yarn add h3-js

Homebrew

Using brew, run:

brew install h3

This installs the C library and filter applications.

Install from source

First, clone the repository or download the source and check out the latest release:

git clone https://github.com/uber/h3.git
cd h3
git checkout v$(<VERSION)

You will need to install build dependencies for your operating system.

mac OS

First make sure you have the developer tools installed and then run:

# Installing the bare build requirements
brew install cmake
# Installing useful tools for development
brew install clang-format lcov doxygen

alpine

# Installing the bare build requirements
apk add cmake make gcc libtool musl-dev

Debian/Ubuntu

# Installing the bare build requirements
sudo apt install cmake make gcc libtool
# Installing useful tools for development
sudo apt install clang-format cmake-curses-gui lcov doxygen

Windows

You will need to install CMake and Visual Studio, including the Visual C++ compiler.

# Installing the bare build requirements
sudo apt install cmake make gcc libtool
# Installing useful tools for development
sudo apt install clang-format cmake-curses-gui lcov doxygen

FreeBSD

# Installing the build requirements
sudo pkg install bash cmake gmake doxygen lcov

Next, you can build the library:

mkdir build
cd build
cmake ..
cmake --build .

Optionally, to run H3's test suite, run:

ctest

By default, the filter applications are built when you build H3. You can confirm they are working by running:

./bin/geoToH3 --lat 14 --lon -42 --resolution 2