Note

Please report issues with this page on the GitHub page.

supy.load_forcing_grid

supy.load_forcing_grid(path_runcontrol: str, grid: int) → pandas.core.frame.DataFrame[source]

Load forcing data for a specific grid included in the index of df_state_init.

Parameters:
Returns:

df_forcing – Forcing data. See df_forcing 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) # get `df_state_init`
>>> grid = df_state_init.index[0] # first grid number included in `df_state_init`
>>> df_forcing = supy.load_forcing_grid(path_runcontrol, grid) # get df_forcing