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.

4.3.29. Model Control

Parameters:

tstep

Time step in seconds for model calculations

Example:

300

forcing_file

Path(s) to meteorological forcing data file(s). This can be either: (1) A single file path as a string (e.g., ‘forcing.txt’), or (2) A list of file paths (e.g., [‘forcing_2020.txt’, ‘forcing_2021.txt’, ‘forcing_2022.txt’]). When multiple files are provided, they will be automatically concatenated in chronological order. The forcing data contains time-series meteorological measurements that drive SUEWS simulations. For detailed information about required variables, file format, and data preparation guidelines, see Meteorological Input File.

Example:

'forcing.txt'

output_file

Output file configuration. DEPRECATED: String values are ignored and will issue a warning. Please use an OutputConfig object specifying format (‘txt’ or ‘parquet’), frequency (seconds, must be multiple of tstep), and groups to save (for txt format only). Example: {‘format’: ‘parquet’, ‘freq’: 3600} or {‘format’: ‘txt’, ‘freq’: 1800, ‘groups’: [‘SUEWS’, ‘DailyState’, ‘ESTM’]}. For detailed information about output variables and file structure, see Output Files.

The output_file parameter group is defined by the Output Configuration structure.

start_time

Start time of model run. If None use forcing data bounds.

Default:

None (optional)

end_time

End time of model run. If None use forcing data bounds.

Default:

None (optional)

ref

The ref parameter group is defined by the Reference Info structure.