API reference

siim

siim — Sliding Ice Incision Model.

siim.analytical

Analytical steady-state machinery for the coupled glacial-fluvial profile.

siim.analytical.core

Math kernel for the analytical steady-state machinery.

siim.analytical.profiles

Steady-state glacial-fluvial profile classes (steepness-index form).

siim.analytical.regime

Nondimensional regime map for the coupled glacial-fluvial steady state.

siim.analytical.steady_state

Physical-parameter front end for the analytical steady state.

siim.constants

Shared physical constants and per-sliding-law parameter dispatch.

siim.forcing

Time-series builders for time-varying model forcing.

siim._core.params

Frozen per-run parameter record for the law_code skeleton kernels.

siim._core.skeleton

Mode-A/B step skeletons (law_code switch) for the siim numerical core.

siim._core.solvers

Shared scalar Newton solvers and ice-thickness closures for the siim numerical core.

siim._core.eroders

Per-law 2D erosion loops (SFR + D-inf) for the siim numerical core.

siim._core.carve

Sub-grid glacier-width carving (mode B only).

siim._core.diffusion

Explicit H diffusion for the siim 2D model (CFL-substepped 5-point FD).

siim._core.hillslope

In-house hillslope diffusion (ADI), the standalone replacement for fastscapelib-fortran's fs.diffusion (stock LinearDiffusion).

siim._core.flexure

In-house spectral flexure, the standalone replacement for fastscapelib-fortran's fs.flexure (fastscape Flexure / siim GlacialFlexure).

siim._core.routing

Flow routing & accumulation primitives for the siim numerical core.

siim._core.step

Framework-free composition-chain step functions for the siim 2D model.

siim._core.driver

The in-house time loop for the standalone siim 2D model.

siim._core.outputs

Pack the in-house driver's step buffers into the exact ds_out contract.

siim.siim1d

siim.siim2d

siim.fastscape

siim.fastscape — siim's glacial processes as composable fastscape citizens.

siim.fastscape.processes

xsimlab process classes for siim2d.

siim.fastscape.forcing

Generic fastscape forcing processes.

siim.plotting

siim plotting package — siim_plotter assembled from per-area mixins.

siim.plotting.maps

map / view_map / animate_map — a straight 2D raster of a stored model field (bedrock, ice, ...).

siim.plotting.profiles

profile / view_profile / animate_profile — the extracted-channel profile vs the analytical steady state, plus view_xsection (raster cross-section) and the analytical overlay helper.

siim.plotting.landscape

landscape / animate_landscape — the deluxe atlas-style cartographic render: supersampled + Gaussian-smoothed terrain, sub-grid across-channel-width ice (footprint fill — the display dual of the width carve), priority-flooded lakes, hillshade, contours, and an optional cross-section + hypsometry panel.

siim.plotting.basins

Public basin plots, with computation delegated to _basin_data.

siim.plotting.diagnostics

Steady-state measurements and their public plotting wrapper.

siim.escarpment

Escarpment-specialized siim2d (thin convenience wrapper).