icon-grid-generator 0.1.0__tar.gz

icon_grid_generator-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,60 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+          cache: pip
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package metadata
+        run: python -m twine check dist/*
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

icon_grid_generator-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,44 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install package and test tools
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[test]"
+          python -m pip install build twine
+
+      - name: Ruff
+        run: python -m ruff check src tests
+
+      - name: Tests
+        run: python -m pytest tests -q
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package metadata
+        run: python -m twine check dist/*

icon_grid_generator-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+.ruff_cache/
+.pytest_cache/
+__pycache__/
+*.py[cod]
+
+build/
+dist/
+*.egg-info/
+
+.venv/
+.DS_Store

icon_grid_generator-0.1.0/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.1.0 - 2026-07-04
+
+Initial public release.
+
+- Generate global spherical ICON RxxByy grids.
+- Generate planar doubly periodic torus grids.
+- Extract limited-area grids from generated global parent grids.
+- Export ICON-style NetCDF grid files with optional `netCDF4` support.
+- Provide the public grid-spec API: `GlobalGridSpec`, `LimitedAreaGridSpec`,
+  `TorusGridSpec`, and `generate_grid()`.

icon_grid_generator-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Oliver Fuhrer, MeteoSwiss
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

icon_grid_generator-0.1.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: icon-grid-generator
+Version: 0.1.0
+Summary: Pure Python generation of ICON-style triangular grids
+Project-URL: Homepage, https://github.com/ofuhrer/icon-grid-generator
+Project-URL: Repository, https://github.com/ofuhrer/icon-grid-generator
+Project-URL: Issues, https://github.com/ofuhrer/icon-grid-generator/issues
+Author: Oliver Fuhrer, MeteoSwiss
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: ICON,geodesic,grid,netcdf,torus
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.10
+Requires-Dist: numpy
+Provides-Extra: netcdf
+Requires-Dist: netcdf4; extra == 'netcdf'
+Provides-Extra: test
+Requires-Dist: netcdf4; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: ruff; extra == 'test'
+Requires-Dist: xarray; extra == 'test'
+Provides-Extra: xarray
+Requires-Dist: xarray; extra == 'xarray'
+Description-Content-Type: text/markdown
+
+# ICON Grid Generator
+
+Pure Python generation of ICON-style triangular grids.
+
+The package provides spherical RxxByy grids, planar doubly periodic torus grids,
+limited-area grids extracted from generated global grids, and optional NetCDF
+export. It has no dependency on model runtimes or stencil frameworks.
+
+## Installation
+
+From a local checkout:
+
+```bash
+python -m pip install -e .
+```
+
+Install optional NetCDF and xarray support with:
+
+```bash
+python -m pip install -e ".[netcdf,xarray]"
+```
+
+## Usage
+
+Generate a global spherical grid:
+
+```python
+from grid_generator import GlobalGridSpec, generate_grid
+
+grid = generate_grid(GlobalGridSpec(root=2, bisections=3))
+print(grid.dims)
+```
+
+Generate a planar torus grid:
+
+```python
+from grid_generator import TorusGridSpec, generate_grid
+
+grid = generate_grid(TorusGridSpec(nx=32, ny=16, edge_length=1_000.0))
+print(grid.metadata["grid_geometry"])
+```
+
+Extract a limited-area grid from a generated global parent:
+
+```python
+from grid_generator import LimitedAreaGridSpec, generate_grid
+
+spec = LimitedAreaGridSpec(
+    "R02B03",
+    lon_min=-20.0,
+    lon_max=20.0,
+    lat_min=35.0,
+    lat_max=60.0,
+    boundary_depth=2,
+)
+grid = generate_grid(spec, options={"max_cells": None})
+```
+
+For global grids, the compact RxxByy string remains available as shorthand:
+
+```python
+grid = generate_grid("R02B03")
+```
+
+Write an ICON-style NetCDF file:
+
+```python
+grid.to_netcdf("grid.nc")
+```
+
+NetCDF export requires the `netcdf` optional extra.
+
+## Release History
+
+See [CHANGELOG.md](CHANGELOG.md).

icon_grid_generator-0.1.0/README.md

@@ -0,0 +1,75 @@
+# ICON Grid Generator
+
+Pure Python generation of ICON-style triangular grids.
+
+The package provides spherical RxxByy grids, planar doubly periodic torus grids,
+limited-area grids extracted from generated global grids, and optional NetCDF
+export. It has no dependency on model runtimes or stencil frameworks.
+
+## Installation
+
+From a local checkout:
+
+```bash
+python -m pip install -e .
+```
+
+Install optional NetCDF and xarray support with:
+
+```bash
+python -m pip install -e ".[netcdf,xarray]"
+```
+
+## Usage
+
+Generate a global spherical grid:
+
+```python
+from grid_generator import GlobalGridSpec, generate_grid
+
+grid = generate_grid(GlobalGridSpec(root=2, bisections=3))
+print(grid.dims)
+```
+
+Generate a planar torus grid:
+
+```python
+from grid_generator import TorusGridSpec, generate_grid
+
+grid = generate_grid(TorusGridSpec(nx=32, ny=16, edge_length=1_000.0))
+print(grid.metadata["grid_geometry"])
+```
+
+Extract a limited-area grid from a generated global parent:
+
+```python
+from grid_generator import LimitedAreaGridSpec, generate_grid
+
+spec = LimitedAreaGridSpec(
+    "R02B03",
+    lon_min=-20.0,
+    lon_max=20.0,
+    lat_min=35.0,
+    lat_max=60.0,
+    boundary_depth=2,
+)
+grid = generate_grid(spec, options={"max_cells": None})
+```
+
+For global grids, the compact RxxByy string remains available as shorthand:
+
+```python
+grid = generate_grid("R02B03")
+```
+
+Write an ICON-style NetCDF file:
+
+```python
+grid.to_netcdf("grid.nc")
+```
+
+NetCDF export requires the `netcdf` optional extra.
+
+## Release History
+
+See [CHANGELOG.md](CHANGELOG.md).

icon_grid_generator-0.1.0/pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "icon-grid-generator"
+version = "0.1.0"
+description = "Pure Python generation of ICON-style triangular grids"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "BSD-3-Clause"
+authors = [
+    { name = "Oliver Fuhrer, MeteoSwiss" },
+]
+keywords = ["ICON", "grid", "geodesic", "torus", "netcdf"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Atmospheric Science",
+    "Topic :: Scientific/Engineering :: Mathematics",
+]
+dependencies = [
+    "numpy",
+]
+
+[project.urls]
+Homepage = "https://github.com/ofuhrer/icon-grid-generator"
+Repository = "https://github.com/ofuhrer/icon-grid-generator"
+Issues = "https://github.com/ofuhrer/icon-grid-generator/issues"
+
+[project.optional-dependencies]
+netcdf = ["netCDF4"]
+xarray = ["xarray"]
+test = ["pytest", "ruff", "netCDF4", "xarray"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/grid_generator"]
+
+[tool.ruff]
+line-length = 88
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

icon_grid_generator-0.1.0/src/grid_generator/__init__.py

@@ -0,0 +1,19 @@
+"""Pure Python ICON RxxByy geodesic grid generation."""
+
+from .grid_generator import (
+    IconGrid,
+    IconGridOptions,
+    GlobalGridSpec,
+    LimitedAreaGridSpec,
+    TorusGridSpec,
+    generate_grid,
+)
+
+__all__ = [
+    "IconGrid",
+    "IconGridOptions",
+    "GlobalGridSpec",
+    "LimitedAreaGridSpec",
+    "TorusGridSpec",
+    "generate_grid",
+]

icon_grid_generator-0.1.0/src/grid_generator/_geometry.py

@@ -0,0 +1,50 @@
+"""Spherical icosahedral geometry construction."""
+
+from __future__ import annotations
+
+from typing import Any
+
+import numpy as np
+
+from ._types import GeometryData
+
+
+class SphericalIcosahedralGeometry:
+    """Build global triangular RxxByy geometry on a sphere."""
+
+    def build(self, spec: Any, options: Any) -> GeometryData:
+        from . import grid_generator as gg
+
+        base_vertices, faces = gg._icosahedron()
+        vertices = base_vertices
+        cells = np.asarray(
+            [gg._orient_cell(tuple(face), vertices) for face in faces],
+            dtype=np.int32,
+        )
+        if spec.root > 1:
+            vertices, cells = gg._refine_triangles(vertices, cells, spec.root)
+        for _ in range(spec.bisections):
+            vertices, cells = gg._refine_triangles(vertices, cells, 2)
+
+        vertices = gg._rotate_points(
+            vertices,
+            options.rotation_axis,
+            options.rotation_angle_degrees,
+        )
+        vertices = vertices * options.radius
+        gg._check_expected_counts(spec, vertices, cells)
+
+        vertex_lon, vertex_lat = gg._lon_lat(vertices)
+        cell_center_xyz = gg._cell_centers(vertices, cells, options.radius)
+        lon, lat = gg._lon_lat(cell_center_xyz)
+        return GeometryData(
+            vertices=vertices,
+            cells=cells,
+            lon=lon,
+            lat=lat,
+            vertex_lon=vertex_lon,
+            vertex_lat=vertex_lat,
+            cell_center_xyz=cell_center_xyz,
+            cell_vertex_lon=vertex_lon[cells],
+            cell_vertex_lat=vertex_lat[cells],
+        )

icon_grid_generator-0.1.0/src/grid_generator/_io.py

@@ -0,0 +1,21 @@
+"""ICON NetCDF writing boundary."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any
+
+
+class IconNetcdfWriter:
+    """Write complete ICON grid objects to NetCDF."""
+
+    def write(
+        self,
+        grid: Any,
+        path: str | Path,
+        *,
+        sphere_radius: float | None = None,
+    ) -> Path:
+        from . import grid_generator as gg
+
+        return gg._write_icon_grid(grid, path, sphere_radius=sphere_radius)