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.5. supy.load_sample_data

supy.load_sample_data() → tuple[DataFrame, DataFrame]

Load sample data for quickly starting a demo run.

Deprecated since version 2025.11.20: This function is deprecated and will be removed in a future release. Please migrate to SUEWSSimulation helpers (e.g., SUEWSSimulation('sample_config.yml')).

Returns:

df_state_init, df_forcing –

• df_state_init: initial model states

• df_forcing: forcing data

Return type:

Tuple[pandas.DataFrame, pandas.DataFrame]

See also

supy.suews_sim.SUEWSSimulation

Modern object-oriented interface (recommended)

Examples

>>> df_state_init, df_forcing = supy.load_sample_data()