Java bindings for H3, a hierarchical hexagonal geospatial indexing system
Add it to your pom.xml:
com.uber h3 3.7.0
Or, using Gradle:
Encode a location into a hexagon address:
H3Core h3 = H3Core.newInstance();
double lat = 37.775938728915946; double lng = -122.41795063018799; int res = 9;
String hexAddr = h3.geoToH3Address(lat, lng, res);
Decode a hexagon address into coordinates:
List geoCoords = h3.h3ToGeoBoundary(hexAddr);
H3-Java provides bindings to the H3 library, which is written in C. The built artifact supports the following:
| Operating System | Architectures | ---------------- | ------------- | Linux | x64, x86, ARM64, ARMv5, ARMv7, MIPS, MIPSEL, PPC64LE, s390x | Windows | x64, x86 | Darwin (Mac OSX) | x64 | FreeBSD | x64 | Android | ARM, ARM64
You may be able to build H3-Java locally if you need to use an operating system or architecture not listed above.
Building the library requires a JDK, Maven, CMake, and a C compiler. To install to your local Maven cache, run:
To build the library, run:
Additional information on how the build process works is available in the build process documentaiton.
# To install build dependencies sudo pkg install openjdk11 maven33 cmake # Ensure /usr/local/openjdk11/bin is on your path
To build Javadocs documentation:
Then open the file
To run benchmarks, either execute them from IntelliJ or run the following from shell: (Replace the class name as needed)
mvn exec:exec -Dexec.executable="java" -Dexec.args="-classpath %classpath com.uber.h3core.benchmarking.H3CoreBenchmark" -Dexec.classpathScope="test"
Pull requests and Github issues are welcome. Please see our contributing guide for more information.
Before we can merge your changes, you must agree to the Uber Contributor License Agreement.
H3-Java is licensed under the Apache 2.0 License.
DGGRID Copyright (c) 2015 Southern Oregon University