Note

Please report issues with this page on the GitHub page.

`df_state` variables¶

Note

Data structure of df_state is explained here.

aerodynamicresistancemethod¶

Dimensionality Remarks:
Description:	Internal use. Please DO NOT modify
Dimensionality:	0
	Scalar
SUEWS-related variables:
	None

ah_min¶

Dimensionality Remarks:
Description:	Minimum QF values.
Dimensionality:	(2,)
	2: {Weekday, Weekend}
SUEWS-related variables:
	`AHMin_WD`, `AHMin_WE`

ah_slope_cooling¶

Dimensionality Remarks:
Description:	Cooling slope of QF calculation.
Dimensionality:	(2,)
	2: {Weekday, Weekend}
SUEWS-related variables:
	`AHSlope_Cooling_WD`, `AHSlope_Cooling_WE`

ah_slope_heating¶

Dimensionality Remarks:
Description:	Heating slope of QF calculation.
Dimensionality:	(2,)
	2: {Weekday, Weekend}
SUEWS-related variables:
	`AHSlope_Heating_WD`, `AHSlope_Heating_WE`

ahprof_24hr¶

Dimensionality Remarks:
Description:	Hourly profile values used in energy use calculation.
Dimensionality:	(24, 2)
	24: hours of a day 2: {Weekday, Weekend}
SUEWS-related variables:
	`EnergyUseProfWD`, `EnergyUseProfWE`

alb¶

Dimensionality Remarks:
Description:	Effective surface albedo (middle of the day value) for summertime.
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`AlbedoMax`

albdectr_id¶

Dimensionality Remarks:
Description:	Albedo of deciduous surface `DecTr` on day 0 of run
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`albDecTr0`

albevetr_id¶

Dimensionality Remarks:
Description:	Albedo of evergreen surface `EveTr` on day 0 of run
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`albEveTr0`

albgrass_id¶

Dimensionality Remarks:
Description:	Albedo of grass surface `Grass` on day 0 of run
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`albGrass0`

albmax_dectr¶

Dimensionality Remarks:
Description:	Effective surface albedo (middle of the day value) for summertime.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`AlbedoMax`

albmax_evetr¶

Dimensionality Remarks:
Description:	Effective surface albedo (middle of the day value) for summertime.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`AlbedoMax`

albmax_grass¶

Dimensionality Remarks:
Description:	Effective surface albedo (middle of the day value) for summertime.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`AlbedoMax`

albmin_dectr¶

Dimensionality Remarks:
Description:	Effective surface albedo (middle of the day value) for wintertime (not including snow).
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`AlbedoMin`

albmin_evetr¶

Dimensionality Remarks:
Description:	Effective surface albedo (middle of the day value) for wintertime (not including snow).
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`AlbedoMin`

albmin_grass¶

Dimensionality Remarks:
Description:	Effective surface albedo (middle of the day value) for wintertime (not including snow).
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`AlbedoMin`

alpha_bioco2¶

Dimensionality Remarks:
Description:	The mean apparent ecosystem quantum. Represents the initial slope of the light-response curve.
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`alpha`

alpha_enh_bioco2¶

Dimensionality Remarks:
Description:	Part of the `alpha` coefficient related to the fraction of vegetation.
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`alpha_enh`

alt¶

Dimensionality Remarks:
Description:	Altitude of grids [m].
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`Alt`

baset¶

Dimensionality Remarks:
Description:	Base Temperature for initiating growing degree days (GDD) for leaf growth. [°C]
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`BaseT`

baset_cooling¶

Dimensionality Remarks:
Description:	Critical cooling temperature.
Dimensionality:	(2,)
	2: {Weekday, Weekend}
SUEWS-related variables:
	`TCritic_Cooling_WD`, `TCritic_Cooling_WE`

baset_hc¶

Dimensionality Remarks:
Description:	Base temperature for heating degree days [°C]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`BaseT_HC`

baset_heating¶

Dimensionality Remarks:
Description:	Critical heating temperature.
Dimensionality:	(2,)
	2: {Weekday, Weekend}
SUEWS-related variables:
	`TCritic_Heating_WD`, `TCritic_Heating_WE`

basete¶

Dimensionality Remarks:
Description:	Base temperature for initiating sensesance degree days (SDD) for leaf off. [°C]
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`BaseTe`

basetmethod¶

Dimensionality Remarks:
Description:	Determines method for base temperature used in HDD/CDD calculations.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`BaseTMethod`

beta_bioco2¶

Dimensionality Remarks:
Description:	The light-saturated gross photosynthesis of the canopy. [umol m^-2 s^-1 ]
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`beta`

beta_enh_bioco2¶

Dimensionality Remarks:
Description:	Part of the `beta` coefficient related to the fraction of vegetation.
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`beta_enh`

bldgh¶

Dimensionality Remarks:
Description:	Mean building height [m]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`H_Bldgs`

capmax_dec¶

Dimensionality Remarks:
Description:	Maximum water storage capacity for upper surfaces (i.e. canopy)
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`StorageMax`

capmin_dec¶

Dimensionality Remarks:
Description:	Minimum water storage capacity for upper surfaces (i.e. canopy).
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`StorageMin`

chanohm¶

Dimensionality Remarks:
Description:	Bulk transfer coefficient for this surface to use in AnOHM [-]
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`AnOHM_Ch`

co2pointsource¶

Dimensionality Remarks:
Description:	CO2 emission factor [kg km^-1]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`CO2PointSource`

cpanohm¶

Dimensionality Remarks:
Description:	Volumetric heat capacity for this surface to use in AnOHM [J m^-3]
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`AnOHM_Cp`

crwmax¶

Dimensionality Remarks:
Description:	Maximum water holding capacity of snow [mm]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`CRWMax`

crwmin¶

Dimensionality Remarks:
Description:	Minimum water holding capacity of snow [mm]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`CRWMin`

daywat¶

Dimensionality Remarks:
Description:	Irrigation flag: 1 for on and 0 for off.
Dimensionality:	(7,)
	7: {Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday}
SUEWS-related variables:
	`DayWat(1)`, `DayWat(2)`, `DayWat(3)`, `DayWat(4)`, `DayWat(5)`, `DayWat(6)`, `DayWat(7)`

daywatper¶

Dimensionality Remarks:
Description:	Fraction of properties using irrigation for each day of a week.
Dimensionality:	(7,)
	7: {Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday}
SUEWS-related variables:
	`DayWatPer(1)`, `DayWatPer(2)`, `DayWatPer(3)`, `DayWatPer(4)`, `DayWatPer(5)`, `DayWatPer(6)`, `DayWatPer(7)`

decidcap_id¶

Dimensionality Remarks:
Description:	Storage capacity of deciduous surface `DecTr` on day 0 of run.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`decidCap0`

dectreeh¶

Dimensionality Remarks:
Description:	Mean height of deciduous trees [m]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`H_DecTr`

diagnose¶

Dimensionality Remarks:
Description:	Internal use. Please DO NOT modify
Dimensionality:	0
	Scalar
SUEWS-related variables:
	None

diagqn¶

Dimensionality Remarks:
Description:	Internal use. Please DO NOT modify
Dimensionality:	0
	Scalar
SUEWS-related variables:
	None

diagqs¶

Dimensionality Remarks:
Description:	Internal use. Please DO NOT modify
Dimensionality:	0
	Scalar
SUEWS-related variables:
	None

drainrt¶

Dimensionality Remarks:
Description:	Drainage rate of bucket for LUMPS [mm h^-1]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`LUMPS_DrRate`

ef_umolco2perj¶

Dimensionality Remarks:
Description:	Emission factor for fuels used for building heating.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`EF_umolCO2perJ`

emis¶

Dimensionality Remarks:
Description:	Effective surface emissivity.
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`Emissivity`

emissionsmethod¶

Dimensionality Remarks:
Description:	Determines method for QF calculation.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`EmissionsMethod`

enddls¶

Dimensionality Remarks:
Description:	End of the day light savings [DOY]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`EndDLS`

enef_v_jkm¶

Dimensionality Remarks:
Description:	Emission factor for heat [J k\|m^-1\|].
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`EnEF_v_Jkm`

evapmethod¶

Dimensionality Remarks:
Description:	Internal use. Please DO NOT modify
Dimensionality:	0
	Scalar
SUEWS-related variables:
	None

evetreeh¶

Dimensionality Remarks:
Description:	Mean height of evergreen trees [m]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`H_EveTr`

faibldg¶

Dimensionality Remarks:
Description:	Frontal area index for buildings [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`FAI_Bldgs`

faidectree¶

Dimensionality Remarks:
Description:	Frontal area index for deciduous trees [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`FAI_DecTr`

faievetree¶

Dimensionality Remarks:
Description:	Frontal area index for evergreen trees [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`FAI_EveTr`

faut¶

Dimensionality Remarks:
Description:	Fraction of irrigated area that is irrigated using automated systems
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`Faut`

fcef_v_kgkm¶

Dimensionality Remarks:
Description:	CO2 emission factor for weekdays [kg km^-1];;CO2 emission factor for weekends [kg km^-1]
Dimensionality:	(2,)
	2: {Weekday, Weekend}
SUEWS-related variables:
	`FcEF_v_kgkmWD`, `FcEF_v_kgkmWE`

flowchange¶

Dimensionality Remarks:
Description:	Difference in input and output flows for water surface [mm h^-1]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`FlowChange`

frfossilfuel_heat¶

Dimensionality Remarks:
Description:	Fraction of fossil fuels used for building heating [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`FrFossilFuel_Heat`

frfossilfuel_nonheat¶

Dimensionality Remarks:
Description:	Fraction of fossil fuels used for building energy use [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`FrFossilFuel_NonHeat`

g1¶

Dimensionality Remarks:
Description:	Related to maximum surface conductance [mm s^-1]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`G1`

g2¶

Dimensionality Remarks:
Description:	Related to Kdown dependence [W m^-2]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`G2`

g3¶

Dimensionality Remarks:
Description:	Related to VPD dependence [units depend on `gsModel`]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`G3`

g4¶

Dimensionality Remarks:
Description:	Related to VPD dependence [units depend on `gsModel`]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`G4`

g5¶

Dimensionality Remarks:
Description:	Related to temperature dependence [°C]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`G5`

g6¶

Dimensionality Remarks:
Description:	Related to soil moisture dependence [mm^-1]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`G6`

gddfull¶

Dimensionality Remarks:
Description:	The growing degree days (GDD) needed for full capacity of the leaf area index (LAI) [°C].
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`GDDFull`

gsmodel¶

Dimensionality Remarks:
Description:	Formulation choice for conductance calculation.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`gsModel`

h_maintain¶

Dimensionality Remarks:
Description:	water depth to maintain used in automatic irrigation (e.g., ponding water due to flooding irrigation in rice crop-field) [mm].
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`H_maintain`

humactivity_24hr¶

Dimensionality Remarks:
Description:	Hourly profile values used in human activity calculation.
Dimensionality:	(24, 2)
	24: hours of a day 2: {Weekday, Weekend}
SUEWS-related variables:
	`ActivityProfWD`, `ActivityProfWE`

ie_a¶

Dimensionality Remarks:
Description:	Coefficient for automatic irrigation model.
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`Ie_a1`, `Ie_a2`, `Ie_a3`

ie_end¶

Dimensionality Remarks:
Description:	Day when irrigation ends [DOY]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`Ie_end`

ie_m¶

Dimensionality Remarks:
Description:	Coefficient for manual irrigation model.
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`Ie_m1`, `Ie_m2`, `Ie_m3`

ie_start¶

Dimensionality Remarks:
Description:	Day when irrigation starts [DOY]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`Ie_start`

internalwateruse_h¶

Dimensionality Remarks:
Description:	Internal water use [mm h^-1]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`InternalWaterUse`

irrfracbldgs¶

Dimensionality Remarks:
Description:	Fraction of `Bldgs` that is irrigated [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`IrrFr_Bldgs`

irrfracbsoil¶

Dimensionality Remarks:
Description:	Fraction of `BSoil` that is irrigated [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`IrrFr_BSoil`

irrfracdectr¶

Dimensionality Remarks:
Description:	Fraction of `DecTr` that is irrigated [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`IrrFr_DecTr`

irrfracevetr¶

Dimensionality Remarks:
Description:	Fraction of `EveTr` that is irrigated [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`IrrFr_EveTr`

irrfracgrass¶

Dimensionality Remarks:
Description:	Fraction of `Grass` that is irrigated [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`IrrFr_Grass`

irrfracpaved¶

Dimensionality Remarks:
Description:	Fraction of `Paved` that is irrigated [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`IrrFr_Paved`

irrfracwater¶

Dimensionality Remarks:
Description:	Fraction of `Water` that is irrigated [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`IrrFr_Water`

kkanohm¶

Dimensionality Remarks:
Description:	Thermal conductivity for this surface to use in AnOHM [W m K^-1]
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`AnOHM_Kk`

kmax¶

Dimensionality Remarks:
Description:	Maximum incoming shortwave radiation [W m^-2]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`Kmax`

lai_id¶

Dimensionality Remarks:
Description:	Initial LAI values.
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`LAIinitialDecTr`, `LAIinitialEveTr`, `LAIinitialGrass`

laicalcyes¶

Dimensionality Remarks:
Description:	Internal use. Please DO NOT modify
Dimensionality:	0
	Scalar
SUEWS-related variables:
	None

laimax¶

Dimensionality Remarks:
Description:	full leaf-on summertime value
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`LAIMax`

laimin¶

Dimensionality Remarks:
Description:	leaf-off wintertime value
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`LAIMin`

laipower¶

Dimensionality Remarks:
Description:	parameters required by LAI calculation.
Dimensionality:	(4, 3)
	4: {`LeafGrowthPower1`, `LeafGrowthPower2`, `LeafOffPower1`, `LeafOffPower2`} 3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`LeafGrowthPower1`, `LeafGrowthPower2`, `LeafOffPower1`, `LeafOffPower2`

laitype¶

Dimensionality Remarks:
Description:	LAI calculation choice.
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`LAIEq`

lat¶

Dimensionality Remarks:
Description:	Latitude [deg].
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`lat`

lng¶

Dimensionality Remarks:
Description:	longitude [deg]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`lng`

maxconductance¶

Dimensionality Remarks:
Description:	The maximum conductance of each vegetation or surface type. [mm s^-1]
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`MaxConductance`

maxfcmetab¶

Dimensionality Remarks:
Description:	Maximum (day) CO2 from human metabolism. [W m^-2]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`MaxFCMetab`

maxqfmetab¶

Dimensionality Remarks:
Description:	Maximum value for human heat emission. [W m^-2]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`MaxQFMetab`

min_res_bioco2¶

Dimensionality Remarks:
Description:	Minimum soil respiration rate (for cold-temperature limit) [umol m^-2 s^-1].
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`min_respi`

minfcmetab¶

Dimensionality Remarks:
Description:	Minimum (night) CO2 from human metabolism. [W m^-2]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`MinFCMetab`

minqfmetab¶

Dimensionality Remarks:
Description:	Minimum value for human heat emission. [W m^-2]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`MinQFMetab`

narp_emis_snow¶

Dimensionality Remarks:
Description:	Effective surface emissivity.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`Emissivity`

narp_trans_site¶

Dimensionality Remarks:
Description:	Atmospheric transmissivity for NARP [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`NARP_Trans`

netradiationmethod¶

Dimensionality Remarks:
Description:	Determines method for calculation of radiation fluxes.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`NetRadiationMethod`

ohm_coef¶

Dimensionality Remarks:
Description:	Coefficients for OHM calculation.
Dimensionality:	(8, 4, 3)
	8: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`, one extra land cover type (currently NOT used)} 4: {SummerWet, SummerDry, WinterWet, WinterDry} 3: {a1, a2, a3}
SUEWS-related variables:
	`a1`, `a2`, `a3`

ohm_threshsw¶

Dimensionality Remarks:
Description:	Temperature threshold determining whether summer/winter OHM coefficients are applied [°C]
Dimensionality:	(8,)
	8: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`, one extra land cover type (currently NOT used)}
SUEWS-related variables:
	`OHMThresh_SW`

ohm_threshwd¶

Dimensionality Remarks:
Description:	Soil moisture threshold determining whether wet/dry OHM coefficients are applied [-]
Dimensionality:	(8,)
	8: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`, one extra land cover type (currently NOT used)}
SUEWS-related variables:
	`OHMThresh_WD`

ohmincqf¶

Dimensionality Remarks:
Description:	Determines whether the storage heat flux calculation uses Q^* or ( Q^* +QF).
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`OHMIncQF`

pipecapacity¶

Dimensionality Remarks:
Description:	Storage capacity of pipes [mm]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`PipeCapacity`

popdensdaytime¶

Dimensionality Remarks:
Description:	Daytime population density (i.e. workers, tourists) [people ha^-1]
Dimensionality:	(2,)
	2: {Weekday, Weekend}
SUEWS-related variables:
	`PopDensDay`

popdensnighttime¶

Dimensionality Remarks:
Description:	Night-time population density (i.e. residents) [people ha^-1]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`PopDensNight`

popprof_24hr¶

Dimensionality Remarks:
Description:	Hourly profile values used in dynamic population estimation.
Dimensionality:	(24, 2)
	24: hours of a day 2: {Weekday, Weekend}
SUEWS-related variables:
	`PopProfWD`, `PopProfWE`

pormax_dec¶

Dimensionality Remarks:
Description:	full leaf-on summertime value Used only for `DecTr` (can affect roughness calculation)
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`PorosityMax`

pormin_dec¶

Dimensionality Remarks:
Description:	leaf-off wintertime value Used only for `DecTr` (can affect roughness calculation)
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`PorosityMin`

porosity_id¶

Dimensionality Remarks:
Description:	Porosity of deciduous vegetation on day 0 of run.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`porosity0`

preciplimit¶

Dimensionality Remarks:
Description:	Temperature limit when precipitation falls as snow [°C]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`PrecipLimSnow`

preciplimitalb¶

Dimensionality Remarks:
Description:	Limit for hourly precipitation when the ground is fully covered with snow [mm]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`PrecipLimAlb`

qf0_beu¶

Dimensionality Remarks:
Description:	Building energy use [W m^-2]
Dimensionality:	(2,)
	2: {Weekday, Weekend}
SUEWS-related variables:
	`QF0_BEU_WD`, `QF0_BEU_WE`

qf_a¶

Dimensionality Remarks:
Description:	Base value for QF calculation.
Dimensionality:	(2,)
	2: {Weekday, Weekend}
SUEWS-related variables:
	`QF_A_WD`, `QF_A_WE`

qf_b¶

Dimensionality Remarks:
Description:	Parameter related to heating degree days.
Dimensionality:	(2,)
	2: {Weekday, Weekend}
SUEWS-related variables:
	`QF_B_WD`, `QF_B_WE`

qf_c¶

Dimensionality Remarks:
Description:	Parameter related to heating degree days.
Dimensionality:	(2,)
	2: {Weekday, Weekend}
SUEWS-related variables:
	`QF_C_WD`, `QF_C_WE`

radmeltfact¶

Dimensionality Remarks:
Description:	Hourly radiation melt factor of snow [mm W^-1 h^-1]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`RadMeltFactor`

raincover¶

Dimensionality Remarks:
Description:	Limit when surface totally covered with water for LUMPS [mm]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`LUMPS_Cover`

rainmaxres¶

Dimensionality Remarks:
Description:	Maximum water bucket reservoir [mm] Used for LUMPS surface wetness control.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`LUMPS_MaxRes`

resp_a¶

Dimensionality Remarks:
Description:	Respiration coefficient a.
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`resp_a`

resp_b¶

Dimensionality Remarks:
Description:	Respiration coefficient b - related to air temperature dependency.
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`resp_b`

roughlenheatmethod¶

Dimensionality Remarks:
Description:	Determines method for calculating roughness length for heat.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`RoughLenHeatMethod`

roughlenmommethod¶

Dimensionality Remarks:
Description:	Determines how aerodynamic roughness length (z0m) and zero displacement height (zdm) are calculated.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`RoughLenMomMethod`

runofftowater¶

Dimensionality Remarks:
Description:	Fraction of above-ground runoff flowing to water surface during flooding [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`RunoffToWater`

s1¶

Dimensionality Remarks:
Description:	A parameter related to soil moisture dependence [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`S1`

s2¶

Dimensionality Remarks:
Description:	A parameter related to soil moisture dependence [mm]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`S2`

sathydraulicconduct¶

Dimensionality Remarks:
Description:	Hydraulic conductivity for saturated soil [mm s^-1]
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`SatHydraulicCond`

sddfull¶

Dimensionality Remarks:
Description:	The sensesence degree days (SDD) needed to initiate leaf off. [°C]
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`SDDFull`

sfr¶

Dimensionality Remarks:
Description:	Surface cover fractions.
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`Fr_Bldgs`, `Fr_Bsoil`, `Fr_DecTr`, `Fr_EveTr`, `Fr_Grass`, `Fr_Paved`, `Fr_Water`

smdmethod¶

Dimensionality Remarks:
Description:	Determines method for calculating soil moisture deficit (SMD).
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`SMDMethod`

snowalb¶

Dimensionality Remarks:
Description:	Initial snow albedo
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`SnowAlb0`

snowalbmax¶

Dimensionality Remarks:
Description:	Effective surface albedo (middle of the day value) for summertime.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`AlbedoMax`

snowalbmin¶

Dimensionality Remarks:
Description:	Effective surface albedo (middle of the day value) for wintertime (not including snow).
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`AlbedoMin`

snowdens¶

Dimensionality Remarks:
Description:	Initial snow density of each land cover.
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`SnowDensBldgs`, `SnowDensPaved`, `SnowDensDecTr`, `SnowDensEveTr`, `SnowDensGrass`, `SnowDensBSoil`, `SnowDensWater`

snowdensmax¶

Dimensionality Remarks:
Description:	Maximum snow density [kg m^-3]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`SnowDensMax`

snowdensmin¶

Dimensionality Remarks:
Description:	Fresh snow density [kg m^-3]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`SnowDensMin`

snowfrac¶

Dimensionality Remarks:
Description:	Initial plan area fraction of snow on each land cover`
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`SnowFracBldgs`, `SnowFracPaved`, `SnowFracDecTr`, `SnowFracEveTr`, `SnowFracGrass`, `SnowFracBSoil`, `SnowFracWater`

snowlimbldg¶

Dimensionality Remarks:
Description:	Limit of the snow water equivalent for snow removal from roads and roofs [mm]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`SnowLimRemove`

snowlimpaved¶

Dimensionality Remarks:
Description:	Limit of the snow water equivalent for snow removal from roads and roofs [mm]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`SnowLimRemove`

snowpack¶

Dimensionality Remarks:
Description:	Initial snow water equivalent on each land cover
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`SnowPackBldgs`, `SnowPackPaved`, `SnowPackDecTr`, `SnowPackEveTr`, `SnowPackGrass`, `SnowPackBSoil`, `SnowPackWater`

snowpacklimit¶

Dimensionality Remarks:
Description:	Limit for the snow water equivalent when snow cover starts to be patchy [mm]
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`SnowLimPatch`

snowprof_24hr¶

Dimensionality Remarks:
Description:	Hourly profile values used in snow clearing.
Dimensionality:	(24, 2)
	24: hours of a day 2: {Weekday, Weekend}
SUEWS-related variables:
	`SnowClearingProfWD`, `SnowClearingProfWE`

snowuse¶

Dimensionality Remarks:
Description:	Determines whether the snow part of the model runs.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`SnowUse`

snowwater¶

Dimensionality Remarks:
Description:	Initial amount of liquid water in the snow on each land cover
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`SnowWaterBldgsState`, `SnowWaterPavedState`, `SnowWaterDecTrState`, `SnowWaterEveTrState`, `SnowWaterGrassState`, `SnowWaterBSoilState`, `SnowWaterWaterState`

soildepth¶

Dimensionality Remarks:
Description:	Depth of soil beneath the surface [mm]
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`SoilDepth`

soilstore_id¶

Dimensionality Remarks:
Description:	Initial water stored in soil beneath each land cover
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`SoilstoreBldgsState`, `SoilstorePavedState`, `SoilstoreDecTrState`, `SoilstoreEveTrState`, `SoilstoreGrassState`, `SoilstoreBSoilState`

soilstorecap¶

Dimensionality Remarks:
Description:	Limit value for `SoilDepth` [mm]
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`SoilStoreCap`

stabilitymethod¶

Dimensionality Remarks:
Description:	Defines which atmospheric stability functions are used.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`StabilityMethod`

startdls¶

Dimensionality Remarks:
Description:	Start of the day light savings [DOY]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`StartDLS`

state_id¶

Dimensionality Remarks:
Description:	Initial wetness condition on each land cover
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`BldgsState`, `PavedState`, `DecTrState`, `EveTrState`, `GrassState`, `BSoilState`, `WaterState`

statelimit¶

Dimensionality Remarks:
Description:	Upper limit to the surface state. [mm]
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`StateLimit`

storageheatmethod¶

Dimensionality Remarks:
Description:	Determines method for calculating storage heat flux ΔQS.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`StorageHeatMethod`

storedrainprm¶

Dimensionality Remarks:
Description:	Coefficients used in drainage calculation.
Dimensionality:	(6, 7)
	6: { `StorageMin`, `DrainageEq`, `DrainageCoef1`, `DrainageCoef2`, `StorageMax`, current storage} 7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`DrainageCoef1`, `DrainageCoef2`, `DrainageEq`, `StorageMax`, `StorageMin`

surfacearea¶

Dimensionality Remarks:
Description:	Area of the grid [ha].
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`SurfaceArea`

tau_a¶

Dimensionality Remarks:
Description:	Time constant for snow albedo aging in cold snow [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`tau_a`

tau_f¶

Dimensionality Remarks:
Description:	Time constant for snow albedo aging in melting snow [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`tau_f`

tau_r¶

Dimensionality Remarks:
Description:	Time constant for snow density ageing [-]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`tau_r`

tempmeltfact¶

Dimensionality Remarks:
Description:	Hourly temperature melt factor of snow [mm K^-1 h^-1]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`TempMeltFactor`

th¶

Dimensionality Remarks:
Description:	Upper air temperature limit [°C]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`TH`

theta_bioco2¶

Dimensionality Remarks:
Description:	The convexity of the curve at light saturation.
Dimensionality:	(3,)
	3: { `EveTr`, `DecTr`, `Grass`}
SUEWS-related variables:
	`theta`

timezone¶

Dimensionality Remarks:
Description:	Time zone [h] for site relative to UTC (east is positive). This should be set according to the times given in the meteorological forcing file(s).
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`Timezone`

tl¶

Dimensionality Remarks:
Description:	Lower air temperature limit [°C]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`TL`

trafficrate¶

Dimensionality Remarks:
Description:	Traffic rate used for CO2 flux calculation.
Dimensionality:	(2,)
	2: {Weekday, Weekend}
SUEWS-related variables:
	`TrafficRate_WD`, `TrafficRate_WE`

trafficunits¶

Dimensionality Remarks:
Description:	Units for the traffic rate for the study area. Not used in v2018a.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`TrafficUnits`

traffprof_24hr¶

Dimensionality Remarks:
Description:	Hourly profile values used in traffic activity calculation.
Dimensionality:	(24, 2)
	24: hours of a day 2: {Weekday, Weekend}
SUEWS-related variables:
	`TraffProfWD`, `TraffProfWE`

tstep¶

Dimensionality Remarks:
Description:	Specifies the model time step [s].
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`Tstep`

veg_type¶

Dimensionality Remarks:
Description:	Internal use. Please DO NOT modify
Dimensionality:	0
	Scalar
SUEWS-related variables:
	None

waterdist¶

Dimensionality Remarks:
Description:	Fraction of water redistribution
Dimensionality:	(8, 6)
	8: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`, one extra land cover type (currently NOT used)} 6: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`}
SUEWS-related variables:
	`ToBSoil`, `ToBldgs`, `ToDecTr`, `ToEveTr`, `ToGrass`, `ToPaved`, `ToRunoff`, `ToSoilStore`, `ToWater`

waterusemethod¶

Dimensionality Remarks:
Description:	Defines how external water use is calculated.
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`WaterUseMethod`

wetthresh¶

Dimensionality Remarks:
Description:	Depth of water which determines whether evaporation occurs from a partially wet or completely wet surface [mm].
Dimensionality:	(7,)
	7: { `Paved`, `Bldgs`, `EveTr`, `DecTr`, `Grass`, `BSoil`, `Water`}
SUEWS-related variables:
	`WetThreshold`

wuprofa_24hr¶

Dimensionality Remarks:
Description:	Hourly profile values used in automatic irrigation.
Dimensionality:	(24, 2)
	24: hours of a day 2: {Weekday, Weekend}
SUEWS-related variables:
	`WaterUseProfAutoWD`, `WaterUseProfAutoWE`

wuprofm_24hr¶

Dimensionality Remarks:
Description:	Hourly profile values used in manual irrigation.
Dimensionality:	(24, 2)
	24: hours of a day 2: {Weekday, Weekend}
SUEWS-related variables:
	`WaterUseProfManuWD`, `WaterUseProfManuWE`

z¶

Dimensionality Remarks:
Description:	Measurement height [m].
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`z`

z0m_in¶

Dimensionality Remarks:
Description:	Roughness length for momentum [m]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`z0`

zdm_in¶

Dimensionality Remarks:
Description:	Zero-plane displacement [m]
Dimensionality:	0
	Scalar
SUEWS-related variables:
	`zd`

df_state variables¶

`df_state` variables¶