[spinup] SpinupConfig

TOML section: [spinup]

Pydantic model: SpinupConfig defined in hydromodpy.simulation.spinup_config.

Source on GitHub

Settings for the cyclic spin-up loop ([spinup]).

Show fields: User User + Dev All

Fields

max_cycles

int default = 10 user source

Maximum spin-up cycles before the loop stops without converging.

tol_head

float default = 0.01 user source

Head convergence tolerance [m]. The loop converges when the largest absolute head change between two cycles (L-inf over active cells) is below this.

tol_stage

float default = 0.01 user source

Lake-stage convergence tolerance [m]. The loop converges when the largest absolute stage change between two cycles, over every lake, is below this. Ignored when the model has no lake.

window_start

str | None default = None user source

Cycle window start (ISO datetime, e.g. ‘2019-01-01’). The representative forcing period each cycle repeats. None reuses [simulation.time].

window_end

str | None default = None user source

Cycle window end (ISO datetime). None reuses [simulation.time]. Set both window bounds to spin up on a shorter representative period than the production chronicle.

Starter TOML snippet

Click to expand a copy-pasteable [spinup] TOML skeleton

Copy this block into your project.toml and uncomment the lines you want to set. Sub-tables ([parent.subfield]) appear in the order Pydantic expects them.

[spinup]
# max_cycles = 10
# tol_head = 0.01
# tol_stage = 0.01
# window_start = ...  # default = None
# window_end = ...  # default = None

Entity-relationship diagram

Click to zoom and pan. Press Esc or click outside to close.