pocketken.H3 4.0.0

.NET 6.0 .NET Standard 2.0
dotnet add package pocketken.H3 --version 4.0.0
NuGet\Install-Package pocketken.H3 -Version 4.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="pocketken.H3" Version="4.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add pocketken.H3 --version 4.0.0
#r "nuget: pocketken.H3, 4.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install pocketken.H3 as a Cake Addin
#addin nuget:?package=pocketken.H3&version=4.0.0

// Install pocketken.H3 as a Cake Tool
#tool nuget:?package=pocketken.H3&version=4.0.0

<img align="right" src="https://uber.github.io/img/h3Logo-color.svg" alt="H3 Logo" width="200">

H3.net: A port of Uber's Hexagonal Hierarchical Geospatial Indexing System to C#

This is a port of Uber's H3 library to C# with most of the polygon functionality based on NetTopologySuite instead of in-library implementations. It supports netstandard2.0, netstandard2.1, net6.0 and is (mostly) based on release 4.0.0 of the C library.

H3 is a geospatial indexing system using a hexagonal grid that can be (approximately) subdivided into finer and finer hexagonal grids, combining the benefits of a hexagonal grid with S2's hierarchical subdivisions.

Installing

Available on nuget.org as pocketken.H3.

PM> Install-Package pocketken.H3 -Version 4.0.0

See CHANGES.md for a list of changes between releases.

Documentation

Upstream documentation is available at https://h3geo.org/. Basic getting-started documentation for this port of the library is available here. I have tried to make the library work and feel more "C# like" using classes, operators, extension methods, enumerables vs. arrays and so on, but some things may be implemented more or less as straight ports of the upstream library.

While the majority of the core H3 API should be here in one form or another, there's still the odd gap in terms of documentation and tests to validate behaviour vs. upstream. PRs to improve code, tests and documentation are definitely welcome and appreciated, although please keep in mind I am quite busy these days and may be a bit slow to respond. Sorry in advance!

Benchmarks

See these likely-out-of-date benchmarks, or you can run them yourself - e.g.:

dotnet run --configuration Release --project .\test\H3.Benchmarks\H3.Benchmarks.csproj --join --framework net6.0
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48 net481
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on pocketken.H3:

Package Downloads
Florence

Package Description

Florence.Notebooks

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.0 8,981 8/31/2022
3.7.2.1 11,032 12/16/2021
3.7.2 7,317 7/19/2021
3.7.1.3 498 4/22/2021
3.7.1.2 297 3/26/2021
3.7.1.1 263 3/24/2021