H3-Go

This library is a pure-Go implementation of the H3 Core Library. It needs no C toolchain and no cgo. For API reference, see the H3 Documentation.

This is v4 of this library, supporting H3 v4.

Check out v3 or checkout the git tag for the version you need.

Migrating from v3?

Check out v3 to v4 migration guide. There have been no breaking changes to the format of H3 indexes. Indexes generated by older versions can be parsed in v4, and vice-versa.

Usage

Installation

go get github.com/uber/h3-go/v4

Quickstart

import "github.com/uber/h3-go/v4"

func ExampleLatLngToCell() {
	latLng := h3.NewLatLng(37.775938728915946, -122.41795063018799)
	resolution := 9 // between 0 (biggest cell) and 15 (smallest cell)

	cell, err := h3.LatLngToCell(latLng, resolution)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(cell)
	// Output:
	// 8928308280fffff
}

C API

Notes

• LatLng returns Lat and Lng as degrees, instead of radians.
• H3 C API function prefixes of get have been dropped in support of Golang's Getter naming style.
• Convenience methods have been added to various types where that type was the main or only argument.

This is the beginning of the README. Read the rest at the original. Read the full README ↗