Note

Please report issues with the manual on the GitHub page.

API reference

Top-level Functions

init_supy(path_runcontrol)	Initialise supy by loading initial model states.
load_forcing_grid(path_runcontrol, grid)	Load forcing data for a specific grid included in the index of df_state_init.
run_supy(df_forcing, df_state_init[, save_state])	Perform supy simulaiton.
load_SampleData()	Load sample data for quickly starting a demo run.

Key Data Structures

• df_state variables
• df_forcing variables
• df_output variables