Skip to main content

ICON Grid Generator

Tests Docs PyPI Python License

Pure Python generation of deterministic ICON-style triangular grids.

Global ICON grid resolutions

The package provides spherical R<n>B<k> grids, planar triangular grids, limited-area extraction, geometry diagnostics and transforms, xarray conversion, and ICON-compatible NetCDF export. Large global grids use export-first generation with bounded derived-field memory and resumable disk checkpoints.

Installation

The base package requires Python 3.10 or newer and NumPy:

python -m pip install icon-grid-generator

Install acceleration and common output integrations for high-resolution work:

python -m pip install "icon-grid-generator[accelerate,netcdf,xarray]"

Numba acceleration is optional for in-memory grids and required for the high-resolution export-first path.

Quick Start

Generate an in-memory grid and write the complete NetCDF schema:

from grid_generator import generate_grid

grid = generate_grid("R2B4")
print(grid.name, grid.dims)
grid.to_netcdf("icon_grid_R02B04.nc")

Generate a large global grid directly to NetCDF:

from grid_generator import generate_grid_to_netcdf

generate_grid_to_netcdf(
    "R2B12",
    "icon_grid_R02B12.nc",
    options={"max_cells": None, "accelerator": "numba"},
    work_dir="icon-grid-R2B12-work",
    fields="reduced",
)

The default full profile contains 85 fields. reduced contains the 46-field union required by the standard ICON and icon4py global-grid readers. Dedicated icon and icon4py profiles and exact custom field lists are also available. Place large outputs and checkpoint directories on disk-backed storage. Each checkpoint manifest atomically selects a complete array snapshot, so an interrupted overwrite leaves the preceding completed checkpoint resumable.

Performance

Measurements used an exclusive dual-socket AMD EPYC 7713 node with 128 physical cores and about 446 GiB of available memory. Times cover independent generation and uncompressed NetCDF export; shared-filesystem I/O varies with storage load.

R2B12 output Generation NetCDF export Total Peak RSS Checkpoints NetCDF
Full 43.51 min 91.24 min 134.74 min 328.18 GiB 162.46 GiB 1,047.50 GiB
Reduced 42.03 min 42.05 min 84.08 min 328.18 GiB 162.46 GiB 485.00 GiB

See Performance and Scaling for R2B8–R2B12 measurements, component timings, validation details, and all field-profile storage sizes.

Documentation

Citation metadata is provided in CITATION.cff. The package is distributed under the BSD 3-Clause License.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

icon_grid_generator-0.6.1.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

icon_grid_generator-0.6.1-py3-none-any.whl (89.8 kB view details)

Uploaded Python 3

File details

Details for the file icon_grid_generator-0.6.1.tar.gz.

File metadata

  • Download URL: icon_grid_generator-0.6.1.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for icon_grid_generator-0.6.1.tar.gz
Algorithm Hash digest
SHA256 5424b757c24fe776557083af26434bb7880a5d1cb06f5c1603e2c0b3943419c1
MD5 4d88e0fdfcd18da77989042f52bbe89f
BLAKE2b-256 6b0d0e70de1d8892c5c19ee0153b74165ec6a8741e07f0a197fe86700d4e209d

See more details on using hashes here.

Provenance

The following attestation bundles were made for icon_grid_generator-0.6.1.tar.gz:

Publisher: release.yml on ofuhrer/icon-grid-generator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file icon_grid_generator-0.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for icon_grid_generator-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a347eb8e319a2cff04e234b870c9a2ff22a4544abe187b0e34c52caca4248b68
MD5 b8fec5919f33198fa37c0abeda730844
BLAKE2b-256 9f59d7cfdcb0126be70e4acf1a93751d5d57548a87f1c0f6f96b9380a6249ba6

See more details on using hashes here.

Provenance

The following attestation bundles were made for icon_grid_generator-0.6.1-py3-none-any.whl:

Publisher: release.yml on ofuhrer/icon-grid-generator

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.9.0

2 files

0.8.1

2 files

0.8.0

2 files

0.7.0

2 files

0.6.2

2 files

This release

0.6.1 This release

2 files

0.6.0

2 files

0.5.0

2 files

0.4.1

2 files

0.4.0

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page