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.

5. Output Files

SUEWS produces comprehensive output data documenting the simulation results, including energy balance, water balance, meteorological variables, and model diagnostics.

The output format is configured in the YAML configuration file. See YAML Configuration Format for configuration details.

Output Formats

• 5.1. Text Format Output
• 5.2. Parquet Format Output

Variable Reference

• 5.3. Output Variable Reference

Legacy Documentation

• 5.4. Legacy Diagnostics
• 5.5. Legacy Text Column Reference

5.6. Restart Checkpoint

5.6.1. {site}_SUEWS_checkpoint.json

Object-oriented SUEWS runs save {site}_SUEWS_checkpoint.json as the preferred restart artefact. It contains typed runtime state from the backend, keyed by grid ID.

The checkpoint is intentionally only the typed runtime state. To continue a run, load the same YAML configuration, attach the next forcing period, and run from SUEWSSimulation.from_checkpoint(...).

Legacy df_state_SSss.csv and state parquet files remain documented for backwards compatibility and developer inspection, but they are not the preferred restart artefact for new object-oriented workflows.

5.7. Temporal Information

Note

Temporal information in output files (iy, id, it, imin) are in local standard time (consistent with Meteorological Forcing Data) and indicate the ending timestamp of each period.

For example, for hourly data, 2021-09-12 13:00 indicates a record for the period between 2021-09-12 12:00 (inclusive) and 2021-09-12 13:00 (exclusive).

Exception for DailyState: When resampled to daily frequency, DailyState uses day-start labelling for readability. See DailyState - SSss_DailyState.txt for details.