Skip to main content

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

Download files

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

Source Distribution

icon4py_common-0.3.0.tar.gz (179.9 kB view details)

Uploaded Source

Built Distribution

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

icon4py_common-0.3.0-py3-none-any.whl (247.4 kB view details)

Uploaded Python 3

File details

Details for the file icon4py_common-0.3.0.tar.gz.

File metadata

  • Download URL: icon4py_common-0.3.0.tar.gz
  • Upload date:
  • Size: 179.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for icon4py_common-0.3.0.tar.gz
Algorithm Hash digest
SHA256 0135319185839b0a2373eba61d7c98f872f02cb9af4802a8ae0a3ff105daf62e
MD5 26c55a9fa5a3b9f6b3d28b4b34052baa
BLAKE2b-256 cf32580ca295908d4138600540f91d928eb52222538dfdb1afb3d3c6b14ad593

See more details on using hashes here.

Provenance

The following attestation bundles were made for icon4py_common-0.3.0.tar.gz:

Publisher: pypi-deploy.yml on C2SM/icon4py

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

File details

Details for the file icon4py_common-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: icon4py_common-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 247.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for icon4py_common-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d20cdaaf44c3dcf7a433c7ea818f8f1dc796d7e236f39085adda030f58487213
MD5 54cb6d6da139d84535af48755515989d
BLAKE2b-256 40066786c9ce6785a0609065c21a7f5631ceacc3d79c0462b4f8b389b765c81d

See more details on using hashes here.

Provenance

The following attestation bundles were made for icon4py_common-0.3.0-py3-none-any.whl:

Publisher: pypi-deploy.yml on C2SM/icon4py

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page