A Python library for making geographic flat-top hexagon grids like QGIS's create grid function
Project description
A tiny Python 3.10+ library for making geographic flat-top hexagonal grids like QGIS’s create grid function. That’s it. Not designed for making other kinds of grids or discrete global grid systems.
Here a hexagonal grid, or hex grid for short, is a finite subset of a hexagonal tiling. A hexagonal tiling is a covering of the plane with regular hexagons in which exactly three hexagons meet at each vertex. (For more details, see the Wikipedia article on hexagonal tilings.) The circumradius of a hex grid is the circumradius of any one of its hexagons, that is, the radius of a circle circumscribing any one of the hexagons. This library favors the word ‘grid’ over ‘tiling’, because ‘grid’ is used more often in geographic context, the main context of this library.
The two main features of this library are
Making a flat-top hexagonal grid of given circumradius that minimally covers a GeoDataFrame of features, where distance units come from the GeoDataFrame’s coordinate reference system (CRS), e.g. no units for no CRS, metres for the New Zealand Transverse Mercator (NZTM) CRS, and decimal degrees for the WGS84 CRS.
By default, hex grids made with a common CRS and circumradis share an origin and thus have equal hexagons (and hexagon IDs) where they overlap. In other words, the grids share a single (infinite) hexagonal tiling of the plane, which is useful when reconciling multiple grids across different geographic areas.
The main non-feature of this library is
Making any other kind of grid, e.g. ones with pointy-top hexagons, squares, triangles, kisrhombilles, Penrose tiles…
Here’s a typical example.
import geopandas as gpd
import geohexgrid as ghg
# Load New Zealand territorial authorities projected in EPSG 2193 (NZTM)
nz = gpd.read_file(DATA_DIR / "nz_tas.gpkg")
# Cover it minimally with hexagons of circumradius 10 kilometres
grid = ghg.make_grid_from_gdf(nz, R=10_000)
# Plot
base = nz.plot(color="black", figsize=(10, 10), aspect="equal")
grid.plot(ax=base, color="white", edgecolor="red", alpha=0.5)
But why hexagons?! Because hexagons are the bestagons. More seriously, no one grid type works best for all geographic applications. MRCagney, this library’s funder, often works with isochrones, which favor simple convex equal area grids with equidistant neighbor cells, that is, hex grids.
Installation
Install from PyPI, e.g. via uv add geohexgrid.
Examples
See the Marimo notebook at notebooks/examples.py.
Notes
This project uses semantic versioning for release numbering.
Its current development status is Alpha, which means interfaces and behavior may still change in ways that are more disruptive than users of mature libraries should expect.
Thanks to MRCagney for periodically funding this project.
Red Blog Games has a great write up of hexagonal grids for computer games.
Alex wanted to chose a shorter name for this package, such as ‘hexgrid’, ‘geohex’, or ‘hexcover’, but those were already taken or too close to taken on PyPI.
Changes
3.0.1, 2026-03-12
Added stronger validation for grid dimensions, radius, trim mode, and GeoDataFrame inputs.
Added a warning when using geographic CRSs, since grid sizes are then interpreted in angular units.
Fixed mp_apply().
Fixed packaging metadata in pyproject.toml.
3.0.0, 2025-06-24
Breaking change: changed signature of main.make_grid_from_gdf with trim_mode option.
Sped up with parallel processing the spatial operations of main.make_grid_from_gdf when using a trim mode.
2.1.2, 2025-06-16
Fixed a docstring typo.
Changed pre-commit hooks.
Replaced Jupyter with Marimo.
Updated dependencies.
2.1.1, 2025-03-07
Removed unused Loguru import in main.py. This was preventing users from installing Geohexgrid, because Loguru is only a development dependency.
2.1.0, 2024-09-26
Bugfixed make_grid_from_bounds in response to Issue 2.
Switched from Poetry to UV for project management.
Bumped Python version up to 3.10+.
2.0.0, 2023-11-14
Refactored for simpler architecture, gapless grids, and a ~15x speed up in the main function grid_from_gdf.
1.1.0, 2023-10-27
Added the clip option to the function grid_from_gdf.
Updated dependencies.
Re-ordered functions.
Changed the cell ID separotor to a comma.
1.0.0, 2022-08-15
First release.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file geohexgrid-3.0.1.tar.gz.
File metadata
- Download URL: geohexgrid-3.0.1.tar.gz
- Upload date:
- Size: 944.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
148a69cadbbda8821b9c5d65f88b616e7c3699eaf95464d5944f7cb8197e42ed
|
|
| MD5 |
38e074b238459c084559831583a8db3a
|
|
| BLAKE2b-256 |
36e635743fb06bf6ff547d0eacec5fc6cb6714c5f57bb71d1098c26436afb413
|
File details
Details for the file geohexgrid-3.0.1-py3-none-any.whl.
File metadata
- Download URL: geohexgrid-3.0.1-py3-none-any.whl
- Upload date:
- Size: 9.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
be5e0ca8cacc1e18a69330d9db6de7eebe4fef8e783d4ba106d0c77e368e1e70
|
|
| MD5 |
40df7328a5969f7f05cf1e3f8adaa0c8
|
|
| BLAKE2b-256 |
77d238f908bb1c4dbc27ec04b03c5e3a7c8448196f1d3b5d386e462756c0aec5
|