Tip
Need help? Please let us know in the SUEWS Community.
Please report issues with the manual on GitHub Issues (or use Report Issue for This Page for page-specific feedback).
Please cite SUEWS with proper information from our Zenodo page.
4.3.37. Output Control#
Configuration block for model output files.
Renamed from OutputConfig and lifted out of the legacy
Union[str, OutputConfig] output_file field in gh#1372 follow-up,
so the model.control surface is uniform with the new forcing:
sub-object. The legacy string form (silently ignored since 2025.10.15)
is dropped.
Parameters:
- format#
Output file format. Options: ‘txt’ for traditional text files (one per year/grid/group), ‘parquet’ for single Parquet file containing all data
- Default:
txt(TXT)
- freq#
Output frequency in seconds. Must be a multiple of the model timestep (tstep). If not specified, defaults to 3600 (hourly)
- Default:
None (optional)
- groups#
List of output groups to save (only applies to txt format). Available groups: ‘SUEWS’, ‘DailyState’, ‘snow’, ‘ESTM’, ‘RSL’, ‘BL’, ‘debug’. If not specified, defaults to [‘SUEWS’, ‘DailyState’]
- Default:
None (optional)
- dir#
Output directory where result files will be saved. If not specified, defaults to the current working directory.
- Default:
None (optional)