hydromodpy.core.toml_io.dynamic_examples_protocol

Protocol decoupling the TOML generator from physics/spatial.

The 15x15 layer matrix forbids core -> physics and core -> spatial. The TOML scaffolding generator emits documented examples for the dynamic [flow.param.*], [flow.bc.*] and [flow.sinks_sources.*] blocks that depend on classes living in those layers. The provider below is wired in at package bootstrap by hydromodpy._bootstrap.

Functions

get_dynamic_flow_examples_provider()	Return the installed provider or None when not yet wired.
set_dynamic_flow_examples_provider(provider)	Install the dynamic-flow examples provider used by the TOML generator.

Classes

DynamicFlowExamplesProvider(*args, **kwargs)

Render commented TOML example blocks for the dynamic flow sections.