Skip to main content

steady_state_regression

steady_state_regression

Regression checks for Basin water-level steady state.

Functions

Name Description
allowed_non_steady_state_node_ids Return approved level-instability exceptions for a model scenario.
steady_state_results Return the final-24-hour steady-state result for every Basin.

allowed_non_steady_state_node_ids

steady_state_regression.allowed_non_steady_state_node_ids(authority, scenario)

Return approved level-instability exceptions for a model scenario.

steady_state_results

steady_state_regression.steady_state_results(
    level,
    storage=None,
    *,
    tolerance=0.01,
)

Return the final-24-hour steady-state result for every Basin.

A Basin that reaches zero storage at any point in the simulation is not in steady state, even when its final water level is constant.