icon4py-common

Description

Utilities shared by several ICON4Py components.

Installation instructions

Check the README.md at the root of the model folder for installation instructions.

Contents

IO

module containing IO funcitonality for ICON4Py.

The IO module requires the installation of the io optional dependencies defined in pyproject.toml of the icon4py-common package and can be installed with the following command:

uv pip install .[io]

or even better by running:

uv sync --extra io  # or `uv sync --extra all` which includes everything

at the top-level folder of the repository, which installs all ICON4Py packages including the IO dependencies.

Distributed run

The package decomposition contains infrastructure for parallel implementation of icon4py/model. icon4py uses GHEX for halo exchanges. In order to run in parallel optional dependencies mpi4py and ghex need to be installed, which can be done through

uv sync --extra distributed  # or `uv sync --extra all` which includes everything

from the top-level folder of the repository.

Grid

Contains basic infrastructure regarding the (unstructured) grid used in icon4py. There are two implementations of the general grid a small simple grid with periodic boundaries in simple.py used for testing and the ICON grid icon.py both implement the same protocl. The ICON grid can be initialized from an ICON grid file via the grid_manager.py (THIS is still EXPERIMENTAL!!) or from serialized data. The grid_manager.py needs netcdf as an optional dependency, which can be installed with

uv sync --extra io  # or `uv sync --extra all` which includes everything

from the top-level folder of the repository.

interpolation

Contains interpolation stencils and port of interpolation fields in ICON.

math

math utilities.

states

contains type for the ICON prognostic state used by several packages.

test_utils

Utilities used in tests made available here for usage in other packages