Note
THIS PROJECT HAS BEEN MERGED INTO SUEWS AND ARCHIVED.
supy.load_forcing_grid
- supy.load_forcing_grid(path_runcontrol: str, grid: int, check_input=False, force_reload=True) DataFrame [source]
Load forcing data for a specific grid included in the index of df_state_init.
- Parameters:
path_runcontrol (str) – Path to SUEWS RunControl.nml
grid (int) – Grid number
check_input (bool, optional) – flag for checking validity of input:
df_forcing
anddf_state_init
. If set toTrue
, any detected invalid input will stop SuPy simulation; aFalse
flag will bypass such validation and may incur kernel error if any invalid input. Note: such checking procedure may take some time if the input is large. (the default isFalse
, which bypasses the validation).
- Returns:
df_forcing – Forcing data. See df_forcing variables for details.
- Return type:
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