Skip to main content

ICON Grid Generator

Tests Docs PyPI Python License

Pure Python generation of ICON-style triangular grids.

Global ICON grid resolutions

ICON Grid Generator creates spherical ICON R<n>B<k> grids, planar triangular grids, limited-area extracts, and ICON-style NetCDF files without depending on ICON model runtimes or stencil frameworks.

Quick Start

from grid_generator import generate_grid

grid = generate_grid("R2B4")
print(grid.name)
print(grid.dims)
grid.to_netcdf("icon_grid_R02B04.nc")
R02B04
{'cell': 20480, 'vertex': 10242, 'edge': 30720}

Global grids are optimized by default. Pass optimize_global=False only when raw bisection geometry is required for diagnostics or comparisons.

What You Can Generate

  • Global spherical ICON grids from standard R<n>B<k> names.
  • Planar triangular torus, channel, parallelogram, stretched, and ragged grids.
  • Limited-area grids extracted from generated global parents.
  • Region-based cuts of existing spherical or planar grids.
  • ICON-style NetCDF files and complete in-memory xarray datasets.
  • Geometry, topology, metric, refinement, diagnostic, and visualization data.

Installation

Python 3.10 or newer is required. Install the common NetCDF and xarray support from PyPI with:

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

The base package depends only on NumPy and can instead be installed with python -m pip install icon-grid-generator.

Documentation

The complete documentation is published at ofuhrer.github.io/icon-grid-generator:

Development

See CONTRIBUTING.md for setup and contribution guidance. Run the complete local check with:

python -m pip install -e ".[test,docs,netcdf,xarray]"
make check

Citation

If you use ICON Grid Generator in published work, cite it using CITATION.cff.

License

ICON Grid Generator 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.4.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.4.1-py3-none-any.whl (65.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: icon_grid_generator-0.4.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.4.1.tar.gz
Algorithm Hash digest
SHA256 1f4a28c3f9ae42820ecbd2f1bb374cdc49e8896be71978d7088bb87cabe4a312
MD5 ff52007e435ba5ae698a2aa9612324b1
BLAKE2b-256 89d730d63c28688dbf224b1f9bb2808cacdeed94fb9b5b42b2e576fce7eb56c3

See more details on using hashes here.

Provenance

The following attestation bundles were made for icon_grid_generator-0.4.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.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for icon_grid_generator-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ed7f6e29b3c5753de1b2bf33de78417eeee50b9275a0206b9a94f36fc12f8783
MD5 e534fc6214c212726aba900b9f2ef69a
BLAKE2b-256 812f8055f52be32729d8fd7134fdea8843a1d74f2accb24589420f451e124d39

See more details on using hashes here.

Provenance

The following attestation bundles were made for icon_grid_generator-0.4.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

0.6.1

2 files

0.6.0

2 files

0.5.0

2 files

This release

0.4.1 This release

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