networkh3 0.0.5

A package to return H3 hexagons based on an OSMnx network

networkh3

A package to return clipped H3 hexagons from the extent of an OSMnx network. Useful for anyone looking to use the H3 spatial indexing system in route analyses or spatial analyses, and for saving time sourcing H3 hexagons.

Examples

(L-R): London, Washington DC

Example workflows are available in the Github repository.

Install

Install the latest version from PyPI:

pip install networkh3

Import

from networkh3 import NETWORKH3

Usage

NETWORKH3 requires three parameters: the area of interest, the type of OSMNx network, and the resolution of the returned H3 hexagons:

from networkh3 import NETWORKH3

NETWORKH3.get_h3('Leeds, United Kingdom', 'drive', 9)

Optional style keywords can also be specified:

from networkh3 import NETWORKH3
import contextily as cx

NETWORKH3.get_h3('Leeds, United Kingdom', 'drive', 9, 
                network_kwargs={
                  'node_size': 1, 
                  'node_color': 'black',
                  'edge_color': 'red',
                  'edge_linewidth': 0.2}, 
                h3_kwargs={
                  'facecolor': 'white', 
                  'alpha': 0.6}, 
                basemap_kwargs={
                  'source': cx.providers.Stamen.TonerLite}
                  )

The network and clipped H3 hexagons can then be used in analysis:

# Calling the network
NETWORKH3.network

# Calling the clipped H3 hexagons
NETWORKH3.h3

Issues and support

See the Github repository to report an issue or contribute to this project.

Contact

• Website: callumscoby.com
• Twitter: @ScobyCallum
• Github: @callumscoby
• LinkedIn: @callumscoby

Acknowledgements

• ⌇ OSMnx

• 🗺 H3