Note
Please report issues with the manual on the GitHub page.
supy.run_supy¶
-
supy.
run_supy
(df_forcing: pandas.core.frame.DataFrame, df_state_init: pandas.core.frame.DataFrame, save_state=False) → Tuple[pandas.core.frame.DataFrame, pandas.core.frame.DataFrame][source]¶ Perform supy simulaiton.
Parameters: - df_forcing (pandas.DataFrame) – forcing data.
- df_state_init (pandas.DataFrame) – initial model states.
- save_state (bool, optional) – flag for saving model states at each timestep, which can be useful in diagnosing model runtime performance or performing a restart run. (the default is False, which intructs supy not to save runtime model states).
Returns: df_output, df_state_final –
- df_output: output results
- df_state_final: final model states
Return type: Tuple[pandas.DataFrame, pandas.DataFrame]
Examples
>>> df_output, df_state_final = supy.run_supy(df_forcing, df_state_init)