Ctrl+K

supy.load_forcing_grid

Tip

  1. Need help? Please let us know in the UMEP Community.

  2. Please report issues with the manual on the GitHub Issues.

  3. Please cite SUEWS with proper information from our Zenodo page.

6.1.3.1.2. 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.

6.1.3.1.2. Parameters#

path_runcontrolstr

Path to SUEWS RunControl.nml

gridint

Grid number

check_inputbool, optional

flag for checking validity of input: df_forcing and df_state_init. If set to True, any detected invalid input will stop SuPy simulation; a False 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 is False, which bypasses the validation).

6.1.3.1.2. Returns#

df_forcing: pandas.DataFrame

Forcing data. See df_forcing variables for details.

6.1.3.1.2. 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
Contents