Flow allocation (WSIMOD): catalogue

Rule-based allocation of water between stores on capacity-limited arcs. How the pieces fit together: Flow allocation (WSIMOD). Every application is set up the same way; see Using noodl.

Import from noodl.apps.wsimod. The full reference, with every parameter, is in the API reference.

Set-up

Build the model and its starting state and inputs.

Name	What it does	How to call it
build_model	(model, state, drivers) for a WSIMOD topology (a mapping, or a JSON file path).	build_model(topology, *, storage_max=None, kind='link', layer_name='wsimod', mode='hard', tau=None, preference=None, initial_storage=None)
initial_drivers	Zero requests (build_model's driver template), then values by arc name: initial_drivers(model, values={"wsimod.requests": {"baseflow": 0.3}}).	initial_drivers(model, *, values=None)
initial_state	Empty stores, "<layer>.s" = 0 for every allocation layer, then values.	initial_state(model, *, values=None)