API reference

Generated with Sphinx autodoc from the installed, typed sources. This is a curated reference: the modules a model builder or tutorial reader touches. Internal helpers, the optional icon_sc.bridges toolchain, and test-support modules are deliberately not listed here — see the source tree for those.

Most classes and functions re-exported at package level (e.g. icon_sc.core.SequentialUpdateSplitting) are documented under their defining module below.

icon_sc.core — the model-agnostic framework

• icon_sc.core — top level
• icon_sc.core.state — state layer
• icon_sc.core.contracts — property contracts
• icon_sc.core.components — component taxonomy
• icon_sc.core.coupling — the coupling algebra
• icon_sc.core.plan — execution plans
• icon_sc.core.functional — the functional (JAX) lowering
• icon_sc.core.io — monitors and output

icon_sc.icon — ICON hosted on icon_sc.core

• icon_sc.icon.names — the ICON variable registry
• icon_sc.icon.thermo — thermodynamic relations
• icon_sc.icon.grid — grid, geometry, metrics
• icon_sc.icon.components — ICON process components
• icon_sc.icon.presets — validated composition presets