Tip

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

2. Please report issues with the manual on GitHub Issues (or use Report Issue for This Page for page-specific feedback).

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

6.2.1.2. supy.run_supy

supy.run_supy(df_forcing: DataFrame, df_state_init: DataFrame, save_state=False, chunk_day=3660, logging_level=20, check_input=False, serial_mode=False, debug_mode=False) → tuple[DataFrame, DataFrame]

Perform supy simulation.

Deprecated since version 2025.11.20: This function is deprecated and will be removed in a future release. Please migrate to SUEWSSimulation.run.

Parameters:

• df_forcing (pandas.DataFrame) – forcing data for all grids in df_state_init: model initial states.

• df_state_init (pandas.DataFrame) – initial model states; or a collection of model states with multiple timestamps, whose last temporal record will be used as the initial model states.

• save_state (bool, optional) – flag for saving model states at each time step, which can be useful in diagnosing model runtime performance or performing a restart run. (the default is False, which instructs supy not to save runtime model states).

• chunk_day (int, optional) – chunk size (chunk_day days) to split simulation periods so memory usage can be reduced. (the default is 3660, which implies ~10-year forcing chunks used in simulations).

• logging_level (logging level) – one of these values [50 (CRITICAL), 40 (ERROR), 30 (WARNING), 20 (INFO), 10 (DEBUG)]. A lower value informs SuPy for more verbose logging info.

• check_input (bool, optional) – flag for checking validity of input: df_forcing: forcing data and df_state_init: model initial states. 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).

• serial_mode (bool, optional) – If set to True, SuPy simulation will be conducted in serial mode; a False flag will try parallel simulation if possible (Windows not supported, i.e., always serial). (the default is False).

• debug_mode (bool, optional) – If set to True, SuPy simulation will be conducted in debug mode, which will write out additional information for debugging purposes.

Returns:

df_output, df_state_final –

• df_output: output results

• df_state_final: final model states

Return type:

Tuple[pandas.DataFrame, pandas.DataFrame]

See also

supy.suews_sim.SUEWSSimulation.run

Modern interface for running simulations (recommended)

Examples

>>> df_output, df_state_final = supy.run_supy(df_forcing, df_state_init)