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). Opening issues is limited to existing contributors, so if GitHub says you cannot open one, post the report in the SUEWS Community instead: a maintainer will turn it into an issue and can add you as a contributor.

3. Please cite SUEWS with proper information from our Zenodo page.

4.5. YAML Configuration Reference

This documentation follows the hierarchical structure of SUEWS YAML configuration files.

Note

Navigate through configuration sections using the tabs below. Click on dropdowns to expand and see detailed parameters.

Parameters

• name

• schema_version

• description

• strict_initial_state_bounds

Model Configuration

Model Configuration

Model Control

Model Control

Parameters

• tstep

• start_time

• end_time

Forcing Control

Forcing Control

• file

• timestamp_reference

Output Control

Output Control

• format

• freq

• groups

• dir

• timestamp_reference

Physics Methods

Physics Methods

Parameters

net_radiation kdown_split_method emissions storage_heat ohm_inc_qf roughness_length_momentum

roughness_length_heat stability soil_moisture_deficit water_use laimethod

roughness_sublayer frontal_area_index roughness_sublayer_level surface_conductance snow_use

STEBBS Physics Methods

STEBBS Physics Methods

• enabled

• parameters

• capacitance

• setpoint

• same_albedo_wall

• same_albedo_roof

• same_emissivity_wall

• same_emissivity_roof

Site Configuration

Site Configuration

Parameters

• name

• gridiv

Site Properties

Site Properties

Parameters

lat lng alt timezone surfacearea z z0m_in

zdm_in pipecapacity runofftowater narp_trans_site n_buildings h_std lambda_c

LUMPS Parameters

LUMPS Parameters

• raincover

• rainmaxres

• drainrt

• veg_type

SPARTACUS

SPARTACUS

16 parameters

• air_ext_lw

• air_ext_sw

• air_ssa_lw

• air_ssa_sw

• ground_albedo_dir_mult_fact

• n_stream_lw_urban

• n_stream_sw_urban

• n_stream_lw_forest

• n_stream_sw_forest

• n_vegetation_region_urban

• n_vegetation_region_forest

• use_sw_direct_albedo

• veg_contact_fraction_const

• veg_fsd_const

• veg_ssa_lw

• veg_ssa_sw

STEBBS

STEBBS

46 parameters

• convection_coefficient_wall_internal

• convection_coefficient_roof_internal

• convection_coefficient_internal_mass

• convection_coefficient_ground_floor_internal

• convection_coefficient_window_internal

• convection_coefficient_wall_external

• convection_coefficient_roof_external

• convection_coefficient_window_external

• depth_ground

• thermal_conductivity_ground

• threshold_metabolism

• ratio_latent_sensible

• daylight_control

• threshold_lighting_illuminance

• efficiency_heating_system_air

• max_power_cooling_system_air

• efficiency_cooling_system_air

• rate_ventilation

• temperature_air_outdoor_initial

• temperature_air_indoor_initial

• temperature_air_annual_mean

• temperature_air_month_mean_diffmax

• thickness_hot_water_tank_wall

• temperature_mains_water

• surface_area_hot_water_tank

• setpoint_temperature_heating_water

• emissivity_hot_water_tank_wall

• thickness_hot_water_vessel_wall

• volume_hot_water

• surface_area_hot_water

• rate_flow_hot_water

• specific_heat_capacity_hot_water

• specific_heat_capacity_hot_water_tank_wall

• specific_heat_capacity_hot_water_vessel_wall

• density_hot_water

• density_hot_water_tank_wall

• density_hot_water_vessel_wall

• conductivity_hot_water_tank_wall

• convection_coefficient_hot_water_tank_wall_internal

• convection_coefficient_hot_water_tank_wall_external

• conductivity_hot_water_vessel_wall

• convection_coefficient_hot_water_tank_vessel_internal

• convection_coefficient_hot_water_tank_vessel_external

• emissivity_hot_water_vessel_wall

• efficiency_heating_system_water

• power_density_lighting

• Ten Minute Profile

  • working_day

  • holiday

• Ten Minute Profile

  • working_day

  • holiday

Archetype Properties

Archetype Properties

58 parameters

• archetype_name

• archetype_building_count

• occupants

• archetype_height

• area_footprint

• area_wall_external

• ratio_internal_mass_volume

• area_internal_mass

• ratio_window_to_wall

• thickness_wall

• conductivity_wall

• density_wall

• specific_heat_capacity_wall

• thickness_wall_outer

• conductivity_wall_outer

• density_wall_outer

• specific_heat_capacity_wall_outer

• fraction_heat_capacity_wall_external

• emissivity_wall_external

• emissivity_wall_internal

• transmissivity_wall_external

• absorptivity_wall_external

• reflectivity_wall_external

• thickness_roof

• conductivity_roof

• density_roof

• specific_heat_capacity_roof

• thickness_roof_outer

• conductivity_roof_outer

• density_roof_outer

• specific_heat_capacity_roof_outer

• fraction_heat_capacity_roof_external

• emissivity_roof_external

• emissivity_roof_internal

• transmissivity_roof_external

• absorptivity_roof_external

• reflectivity_roof_external

• thickness_ground_floor

• conductivity_ground_floor

• density_ground_floor

• specific_heat_capacity_ground_floor

• thickness_window

• conductivity_window

• density_window

• specific_heat_capacity_window

• emissivity_window_external

• emissivity_window_internal

• transmissivity_window_external

• absorptivity_window_external

• reflectivity_window_external

• density_internal_mass

• specific_heat_capacity_internal_mass

• emissivity_internal_mass

• max_power_heating_system_air

• volume_hot_water_tank

• max_power_heating_system_water

• setpoint_temperature_heating_air

• setpoint_temperature_cooling_air

• Heating Setpoint Profile

  • working_day

  • holiday

• Cooling Setpoint Profile

  • working_day

  • holiday

• Ten Minute Profile

  • working_day

  • holiday

Conductance

Conductance

11 parameters

• g_max

• g_k

• g_q_base

• g_q_shape

• g_t

• g_sm

• kmax

• s1

• s2

• tl

• th

Irrigation

Irrigation

9 parameters

• h_maintain

• faut

• ie_start

• ie_end

• internalwateruse_h

• daywatper

• daywat

• wuprofa_24hr

• wuprofm_24hr

Anthropogenic Emissions

Anthropogenic Emissions

• startdls

• enddls

• Anthropogenic Heat

  13 parameters

  • qf0_beu

  • qf_a

  • qf_b

  • qf_c

  • baset_cooling

  • baset_heating

  • ah_min

  • ah_slope_cooling

  • ah_slope_heating

  • ahprof_24hr

  • popdensdaytime

  • popdensnighttime

  • popprof_24hr

• CO2 Emissions

  14 parameters

  • emission_co2_point_source

  • emission_factor_co2_fuel

  • emission_factor_energy_vehicle

  • emission_factor_co2_vehicle

  • fraction_fossil_fuel_heating

  • fraction_fossil_fuel_non_heating

  • emission_co2_metabolism_max

  • emission_heat_metabolism_max

  • emission_co2_metabolism_min

  • emission_heat_metabolism_min

  • traffic_rate

  • type_traffic_rate

  • profile_traffic_24hr

  • profile_human_activity_24hr

Snow

Snow

19 parameters

• water_holding_capacity_max

• water_holding_capacity_min

• narp_emissivity_snow

• temperature_rain_snow_threshold

• precipitation_threshold_albedo_reset

• snow_albedo_max

• snow_albedo_min

• snow_density_min

• snow_density_max

• snow_depth_limit_building

• snow_depth_limit_paved

• snow_profile_24hr

• tau_cold_snow

• tau_melting_snow

• tau_refreezing_snow

• temperature_melt_factor

• radiation_melt_factor

• ohm_threshold_summer_winter

• ohm_threshold_wet_dry

• Seasonal/Wetness OHM Coefficients

Soil Observation Configuration

Soil Observation Configuration

• depth

• smcap

• soil_not_rocks

• bulk_density

Land Cover

Land Cover

• Paved Surfaces

  13 parameters

  • sfr

  • emis

  • ohm_threshold_summer_winter

  • ohm_threshold_wet_dry

  • soil_depth

  • soil_store_capacity

  • state_limit

  • wet_threshold

  • saturated_hydraulic_conductivity

  • soil_density

  • snowpack_limit

  • irrigation_fraction

  • alb

• Buildings

  15 parameters

  • sfr

  • emis

  • ohm_threshold_summer_winter

  • ohm_threshold_wet_dry

  • soil_depth

  • soil_store_capacity

  • state_limit

  • wet_threshold

  • saturated_hydraulic_conductivity

  • soil_density

  • snowpack_limit

  • irrigation_fraction

  • alb

  • faibldg

  • bldgh

• Evergreen Trees

  27 parameters

  • sfr

  • emis

  • ohm_threshold_summer_winter

  • ohm_threshold_wet_dry

  • soil_depth

  • soil_store_capacity

  • state_limit

  • wet_threshold

  • saturated_hydraulic_conductivity

  • soil_density

  • snowpack_limit

  • irrigation_fraction

  • alb_min

  • alb_max

  • beta_bio_co2

  • beta_enh_bioco2

  • alpha_bio_co2

  • alpha_enh_bioco2

  • resp_a

  • resp_b

  • theta_bio_co2

  • max_conductance

  • min_res_bioco2

  • ie_a

  • ie_m

  • fai_evergreen_tree

  • height_evergreen_tree

• Deciduous Trees

  31 parameters

  • sfr

  • emis

  • ohm_threshold_summer_winter

  • ohm_threshold_wet_dry

  • soil_depth

  • soil_store_capacity

  • state_limit

  • wet_threshold

  • saturated_hydraulic_conductivity

  • soil_density

  • snowpack_limit

  • irrigation_fraction

  • alb_min

  • alb_max

  • beta_bio_co2

  • beta_enh_bioco2

  • alpha_bio_co2

  • alpha_enh_bioco2

  • resp_a

  • resp_b

  • theta_bio_co2

  • max_conductance

  • min_res_bioco2

  • ie_a

  • ie_m

  • fai_deciduous_tree

  • height_deciduous_tree

  • porosity_min_deciduous

  • porosity_max_deciduous

  • capacity_max_deciduous

  • capacity_min_deciduous

• Grass

  25 parameters

  • sfr

  • emis

  • ohm_threshold_summer_winter

  • ohm_threshold_wet_dry

  • soil_depth

  • soil_store_capacity

  • state_limit

  • wet_threshold

  • saturated_hydraulic_conductivity

  • soil_density

  • snowpack_limit

  • irrigation_fraction

  • alb_min

  • alb_max

  • beta_bio_co2

  • beta_enh_bioco2

  • alpha_bio_co2

  • alpha_enh_bioco2

  • resp_a

  • resp_b

  • theta_bio_co2

  • max_conductance

  • min_res_bioco2

  • ie_a

  • ie_m

• Bare Soil

  13 parameters

  • sfr

  • emis

  • ohm_threshold_summer_winter

  • ohm_threshold_wet_dry

  • soil_depth

  • soil_store_capacity

  • state_limit

  • wet_threshold

  • saturated_hydraulic_conductivity

  • soil_density

  • snowpack_limit

  • irrigation_fraction

  • alb

• Water Surfaces

  14 parameters

  • sfr

  • emis

  • ohm_threshold_summer_winter

  • ohm_threshold_wet_dry

  • soil_depth

  • soil_store_capacity

  • state_limit

  • wet_threshold

  • saturated_hydraulic_conductivity

  • soil_density

  • snowpack_limit

  • irrigation_fraction

  • alb

  • flowchange

SPARTACUS Vertical Layers

SPARTACUS Vertical Layers

• nlayer

• height

• veg_frac

• veg_scale

• veg_ext

• building_frac

• building_scale

• Roof Layer

  • alb

  • emis

  • state_limit

  • soil_store_capacity

  • wet_threshold

  • roof_albedo_dir_mult_fact

  • wall_specular_frac

• Wall Layer

  • alb

  • emis

  • state_limit

  • soil_store_capacity

  • wet_threshold

  • roof_albedo_dir_mult_fact

  • wall_specular_frac

Initial States

Initial States

Parameters

• snowalb

Paved Surface Initial State

Paved Surface Initial State

10 parameters

• state

• soilstore

• snowfrac

• snowpack

• icefrac

• snowwater

• snowdens

• temperature

• tsfc

• tin

Buildings Surface Initial State

Buildings Surface Initial State

10 parameters

• state

• soilstore

• snowfrac

• snowpack

• icefrac

• snowwater

• snowdens

• temperature

• tsfc

• tin

Evergreen Tree Initial State

Evergreen Tree Initial State

15 parameters

• state

• soilstore

• snowfrac

• snowpack

• icefrac

• snowwater

• snowdens

• temperature

• tsfc

• tin

• alb_id

• lai_id

• gdd_id

• sdd_id

• wu

Deciduous Tree Initial State

Deciduous Tree Initial State

17 parameters

• state

• soilstore

• snowfrac

• snowpack

• icefrac

• snowwater

• snowdens

• temperature

• tsfc

• tin

• alb_id

• lai_id

• gdd_id

• sdd_id

• wu

• porosity_id

• decidcap_id

Grass Initial State

Grass Initial State

15 parameters

• state

• soilstore

• snowfrac

• snowpack

• icefrac

• snowwater

• snowdens

• temperature

• tsfc

• tin

• alb_id

• lai_id

• gdd_id

• sdd_id

• wu

Bare Soil Surface Initial State

Bare Soil Surface Initial State

10 parameters

• state

• soilstore

• snowfrac

• snowpack

• icefrac

• snowwater

• snowdens

• temperature

• tsfc

• tin

Water Surface Initial State

Water Surface Initial State

10 parameters

• state

• soilstore

• snowfrac

• snowpack

• icefrac

• snowwater

• snowdens

• temperature

• tsfc

• tin

Roofs Initial State

Roofs Initial State

10 parameters

• state

• soilstore

• snowfrac

• snowpack

• icefrac

• snowwater

• snowdens

• temperature

• tsfc

• tin

Walls Initial State

Walls Initial State

10 parameters

• state

• soilstore

• snowfrac

• snowpack

• icefrac

• snowwater

• snowdens

• temperature

• tsfc

• tin