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.2. Parquet Format Output#

Added in version 2025.10.15: See release notes for details.

Parquet is a modern columnar storage format that provides significant advantages for large-scale SUEWS simulations.

Note

Parquet output is only available when using YAML configuration files, not with the legacy namelist format.

5.2.1. Output Files#

When using parquet format, SUEWS produces two output files:

  • SSss_SUEWS_output.parquet - All simulation output in a single file, including all output groups and years. See Output Variable Reference for variable details.

  • SSss_SUEWS_state_final.parquet - Final model state for restart runs. See State Persistence for details.

5.2.2. Reading Parquet Files#

import pandas as pd

# Read output data
df_output = pd.read_parquet('London_KCL_SUEWS_output.parquet')

# Access specific group (e.g., SUEWS variables)
df_suews = df_output['SUEWS']

# Access specific variable
qh = df_output[('SUEWS', 'QH')]

# Filter by time
summer = df_output.loc['2012-06':'2012-08']

For other languages (R, MATLAB, Julia), see the Apache Parquet documentation.

5.2.3. Configuration#

To enable parquet output in your YAML configuration:

model:
  control:
    output_file:
      format: parquet
      freq: 3600

See YAML Configuration Format for complete configuration options.

5.2.4. Why Parquet?#

Parquet format offers several advantages over traditional text output:

  • 70-80% smaller file sizes compared to text format

  • 2-5x compression compared to uncompressed CSV/text

  • Faster reading in data analysis tools

  • All data in two files (output and state) rather than many separate files

  • Multi-year data stored together efficiently

Comparison with Text Format:

Feature

Text Format

Parquet Format

File size

Large

70-80% smaller

Read speed

Slow

Fast

Human readable

Yes

No

Multi-year

Separate files

Single file

Spreadsheet

Yes

Requires library