supy.init_supy¶

supy.init_supy(path_runcontrol: str) → pandas.core.frame.DataFrame[source]¶

Initialise supy by loading initial model states.

Parameters:	path_runcontrol (str) – Path to SUEWS RunControl.nml
Returns:	df_state_init – Initial model states. See df_state variables for details.
Return type:	pandas.DataFrame

Examples

>>> path_runcontrol = "~/SUEWS_sims/RunControl.nml" # a valid path to `RunControl.nml`
>>> df_state_init = supy.init_supy(path_runcontrol)