4.7. SUEWS input converter¶

SUEWS input converter is a Python 3 script to convert input files between different versions based on pre-defined rules.

4.7.1. How to use¶

Download the converter script and rule.csv below, and specify these arguments in the script:

fromVer: which version to convert from.
toVer: which version to convert to.
fromDir: where the input files are located.
toDir: where the converted files are produced.

4.7.2. Downloads¶

SUEWS input converter in python

SUEWS_TableConverter.py
Rules for conversions between different SUEWS versions

rules.csv

4.7.3. Description of rules¶

The converter currently picks up the following types of actions:

Add: New entries or files to be added with default values.
Rename: Entries to be renamed from one version to another.
Delete: Entries to be deleted from one version to another.

Note

For entries introduced in a version via a new file, the new file will be created to hold the new entries without extra delaration for new files.

The current available rules are listed below:

From	To	Action	File	Variable	Column	Value
2017a	2018a	Delete	RunControl.nml	anthropco2method	-999	-999
2017a	2018a	Rename	RunControl.nml	AnthropHeatMethod	-999	EmissionsMethod
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	AHMin_WD	9	15
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	AHMin_WE	10	15
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	AHSlope_Heating_WD	11	2.7
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	AHSlope_Heating_WE	12	2.7
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	AHSlope_Cooling_WD	13	2.7
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	AHSlope_Cooling_WE	14	2.7
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	TCritic_Heating_WD	15	7
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	TCritic_Heating_WE	16	7
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	TCritic_Cooling_WD	17	7
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	TCritic_Cooling_WE	18	7
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	EnergyUseProfWD	19	44
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	EnergyUseProfWE	20	45
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	ActivityProfWD	21	55663
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	ActivityProfWE	22	55664
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	TraffProfWD	23	701
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	TraffProfWE	24	702
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	PopProfWD	25	801
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	PopProfWE	26	802
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	MinQFMetab	27	75
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	MaxQFMetab	28	175
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	FrFossilFuel_Heat	29	0.05
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	FrFossilFuel_NonHeat	30	0
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	EF_umolCO2perJ	31	1.159
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	EnEF_v_Jkm	32	3.97E+06
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	FcEF_v_kgkm	33	0.285
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	TrafficUnits	34	1
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	EnergyUseProfWD	19	-999
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	EnergyUseProfWE	20	-999
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	ActivityProfWD	21	-999
2017a	2018a	Add	SUEWS_AnthropogenicHeat.txt	ActivityProfWE	22	-999
2017a	2018a	Delete	SUEWS_AnthropogenicHeat.txt	AHMin	-999	-999
2017a	2018a	Delete	SUEWS_AnthropogenicHeat.txt	AHSlope	-999	-999
2017a	2018a	Delete	SUEWS_AnthropogenicHeat.txt	TCritic	-999	-999
2017a	2018a	Rename	SUEWS_AnthropogenicHeat.txt	QF_A_Weekday	-999	QF_A_WD
2017a	2018a	Rename	SUEWS_AnthropogenicHeat.txt	QF_B_Weekday	-999	QF_B_WD
2017a	2018a	Rename	SUEWS_AnthropogenicHeat.txt	QF_C_Weekday	-999	QF_C_WD
2017a	2018a	Rename	SUEWS_AnthropogenicHeat.txt	QF_A_Weekend	-999	QF_A_WE
2017a	2018a	Rename	SUEWS_AnthropogenicHeat.txt	QF_B_Weekend	-999	QF_B_WE
2017a	2018a	Rename	SUEWS_AnthropogenicHeat.txt	QF_C_Weekend	-999	QF_C_WE
2017a	2018a	Add	SUEWS_BiogenCO2.txt	Code	1	31
2017a	2018a	Add	SUEWS_BiogenCO2.txt	alpha	2	0.004
2017a	2018a	Add	SUEWS_BiogenCO2.txt	beta	3	8.747
2017a	2018a	Add	SUEWS_BiogenCO2.txt	theta	4	0.96
2017a	2018a	Add	SUEWS_BiogenCO2.txt	alpha_enh	5	0.016
2017a	2018a	Add	SUEWS_BiogenCO2.txt	beta_enh	6	33.353
2017a	2018a	Add	SUEWS_BiogenCO2.txt	resp_a	7	2.43
2017a	2018a	Add	SUEWS_BiogenCO2.txt	resp_b	8	0
2017a	2018a	Add	SUEWS_BiogenCO2.txt	min_respi	9	0.6
2017a	2018a	Delete	SUEWS_SiteSelect.txt	TrafficRate	-999	-999
2017a	2018a	Delete	SUEWS_SiteSelect.txt	BuildEnergyUse	-999	-999
2017a	2018a	Delete	SUEWS_SiteSelect.txt	EnergyUseProfWD	-999	-999
2017a	2018a	Delete	SUEWS_SiteSelect.txt	EnergyUseProfWE	-999	-999
2017a	2018a	Delete	SUEWS_SiteSelect.txt	ActivityProfWD	-999	-999
2017a	2018a	Delete	SUEWS_SiteSelect.txt	ActivityProfWE	-999	-999
2017a	2018a	Add	SUEWS_SiteSelect.txt	TrafficRate_WD	34	0.01
2017a	2018a	Add	SUEWS_SiteSelect.txt	TrafficRate_WE	35	0.01
2017a	2018a	Add	SUEWS_SiteSelect.txt	QF0_BEU_WD	36	0.88
2017a	2018a	Add	SUEWS_SiteSelect.txt	QF0_BEU_WE	37	0.88
2017a	2018a	Add	SUEWS_Veg.txt	BiogenCO2Code	38	31
2016a	2017a	Add	SUEWS_Conductance.txt	gsModel	13	1
2016a	2017a	Add	SUEWS_NonVeg.txt	OHMThresh_SW	19	10
2016a	2017a	Add	SUEWS_NonVeg.txt	OHMThresh_WD	20	0.9
2016a	2017a	Add	SUEWS_NonVeg.txt	ESTMCode	21	806
2016a	2017a	Add	SUEWS_NonVeg.txt	AnOHM_Cp	22	20000000
2016a	2017a	Add	SUEWS_NonVeg.txt	AnOHM_Kk	23	1.2
2016a	2017a	Add	SUEWS_NonVeg.txt	AnOHM_Ch	24	4
2016a	2017a	Add	SUEWS_Snow.txt	OHMThresh_SW	20	10
2016a	2017a	Add	SUEWS_Snow.txt	OHMThresh_WD	21	0.9
2016a	2017a	Add	SUEWS_Snow.txt	ESTMCode	22	61
2016a	2017a	Add	SUEWS_Snow.txt	AnOHM_Cp	23	100000
2016a	2017a	Add	SUEWS_Snow.txt	AnOHM_Kk	24	1.2
2016a	2017a	Add	SUEWS_Snow.txt	AnOHM_Ch	25	4
2016a	2017a	Add	SUEWS_Water.txt	WaterDepth	9	0
2016a	2017a	Add	SUEWS_Water.txt	OHMThresh_SW	17	10
2016a	2017a	Add	SUEWS_Water.txt	OHMThresh_WD	18	0.9
2016a	2017a	Add	SUEWS_Water.txt	ESTMCode	19	60
2016a	2017a	Add	SUEWS_Water.txt	AnOHM_Cp	20	100000
2016a	2017a	Add	SUEWS_Water.txt	AnOHM_Kk	21	1.2
2016a	2017a	Add	SUEWS_Water.txt	AnOHM_Ch	22	4
2016a	2017a	Add	SUEWS_Veg.txt	PorosityMin	20	-999
2016a	2017a	Add	SUEWS_Veg.txt	PorosityMax	21	-999
2016a	2017a	Add	SUEWS_Veg.txt	OHMThresh_SW	32	10
2016a	2017a	Add	SUEWS_Veg.txt	OHMThresh_WD	33	0.9
2016a	2017a	Add	SUEWS_Veg.txt	ESTMCode	34	200
2016a	2017a	Add	SUEWS_Veg.txt	AnOHM_Cp	35	100000
2016a	2017a	Add	SUEWS_Veg.txt	AnOHM_Kk	36	1.2
2016a	2017a	Add	SUEWS_Veg.txt	AnOHM_Ch	37	4
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Code	1	800
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_thick1	2	0.1
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_k1	3	0.74
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_rhoCp1	4	1500000
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_thick2	5	0.1
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_k2	6	0.93
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_rhoCp2	7	1500000
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_thick3	8	0.05
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_k3	9	0.06
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_rhoCp3	10	70000
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_thick4	11	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_k4	12	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_rhoCp4	13	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_thick5	14	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_k5	15	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Surf_rhoCp5	16	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_thick1	17	0.1
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_k1	18	1
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_rhoCp1	19	1600000
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_thick2	20	0.1
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_k2	21	1
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_rhoCp2	22	1600000
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_thick3	23	0.1
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_k3	24	1
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_rhoCp3	25	1600000
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_thick4	26	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_k4	27	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_rhoCp4	28	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_thick5	29	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_k5	30	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Wall_rhoCp5	31	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_thick1	32	0.05
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_k1	33	0.5
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_rhoCp1	34	1500000
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_thick2	35	0.05
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_k2	36	0.5
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_rhoCp2	37	1500000
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_thick3	38	0.05
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_k3	39	0.5
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_rhoCp3	40	1500000
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_thick4	41	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_k4	42	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_rhoCp4	43	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_thick5	44	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_k5	45	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_rhoCp5	46	-999
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	nroom	47	10
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_albedo	48	0.5
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_emissivity	49	1
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_CHwall	50	0.001
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_CHroof	51	0.001
2016a	2017a	Add	SUEWS_ESTMCoefficients.txt	Internal_CHbld	52	0.001
2016a	2017a	Add	SUEWS_SiteSelect.txt	Timezone	7	0
2016a	2017a	Add	SUEWS_SiteSelect.txt	z	10	999
2016a	2017a	Add	SUEWS_SiteSelect.txt	TrafficRate	34	99999
2016a	2017a	Add	SUEWS_SiteSelect.txt	BuildEnergyUse	35	99999
2016a	2017a	Add	SUEWS_SiteSelect.txt	ActivityProfWD	54	5663
2016a	2017a	Add	SUEWS_SiteSelect.txt	ActivityProfWE	55	5664
2016a	2017a	Add	SUEWS_SiteSelect.txt	AreaWall	87	7000
2016a	2017a	Add	SUEWS_SiteSelect.txt	Fr_ESTMClass_Paved1	88	0
2016a	2017a	Add	SUEWS_SiteSelect.txt	Fr_ESTMClass_Paved2	89	1
2016a	2017a	Add	SUEWS_SiteSelect.txt	Fr_ESTMClass_Paved3	90	0
2016a	2017a	Add	SUEWS_SiteSelect.txt	Code_ESTMClass_Paved1	91	806
2016a	2017a	Add	SUEWS_SiteSelect.txt	Code_ESTMClass_Paved2	92	807
2016a	2017a	Add	SUEWS_SiteSelect.txt	Code_ESTM_Paved3	93	808
2016a	2017a	Add	SUEWS_SiteSelect.txt	Fr_ESTMClass_Bldgs1	94	1
2016a	2017a	Add	SUEWS_SiteSelect.txt	Fr_ESTMClass_Bldgs2	95	0
2016a	2017a	Add	SUEWS_SiteSelect.txt	Fr_ESTMClass_Bldgs3	96	0
2016a	2017a	Add	SUEWS_SiteSelect.txt	Fr_ESTMClass_Bldgs4	97	0
2016a	2017a	Add	SUEWS_SiteSelect.txt	Fr_ESTMClass_Blgds5	98	0
2016a	2017a	Add	SUEWS_SiteSelect.txt	Code_ESTMClass_Bldgs1	99	801
2016a	2017a	Add	SUEWS_SiteSelect.txt	Code_ESTMClass_Bldgs2	100	802
2016a	2017a	Add	SUEWS_SiteSelect.txt	Code_ESTMClass_Bldgs3	101	803
2016a	2017a	Add	SUEWS_SiteSelect.txt	Code_ESTMClass_Bldgs4	102	804
2016a	2017a	Add	SUEWS_SiteSelect.txt	Code_ESTMClass_Bldgs5	103	805
2016a	2017a	Rename	RunControl.nml	AnthropHeatChoice	-999	AnthropHeatMethod
2016a	2017a	Rename	RunControl.nml	CBLuse	-999	CBLUse
2016a	2017a	Rename	RunControl.nml	NetRadiationChoice	-999	NetRadiationMethod
2016a	2017a	Rename	RunControl.nml	RoughLen_heat	-999	RoughLenHeatMethod
2016a	2017a	Rename	RunControl.nml	smd_choice	-999	SMDMethod
2016a	2017a	Rename	RunControl.nml	WU_choice	-999	WaterUseMethod
2016a	2017a	Rename	RunControl.nml	z0_method	-999	RoughLenMomMethod
2016a	2017a	Delete	RunControl.nml	gsChoice	-999	-999
2016a	2017a	Delete	RunControl.nml	SkipHeaderSiteInfo	-999	-999
2016a	2017a	Delete	RunControl.nml	SkipHeaderMet	-999	-999
2016a	2017a	Delete	RunControl.nml	SnowFractionChoice	-999	-999
2016a	2017a	Delete	RunControl.nml	TIMEZONE	-999	-999
2016a	2017a	Delete	RunControl.nml	z	-999	-999
2016a	2017a	Rename	RunControl.nml	SOLWEIGuse	-999	SOLWEIGUse
2016a	2017a	Rename	RunControl.nml	QSChoice	-999	StorageHeatMethod
2016a	2017a	Add	RunControl.nml	AnthropCO2Method	-999	1
2016a	2017a	Add	RunControl.nml	MultipleMetFiles	-999	0
2016a	2017a	Add	RunControl.nml	MultipleInitFiles	-999	0
2016a	2017a	Add	RunControl.nml	MultipleESTMFiles	-999	0
2016a	2017a	Add	RunControl.nml	ResolutionFilesIn	-999	3600
2016a	2017a	Add	RunControl.nml	ResolutionFilesInESTM	-999	3600
2016a	2017a	Add	RunControl.nml	ResolutionFilesOut	-999	3600
2016a	2017a	Add	RunControl.nml	DissagMethod	-999	1
2016a	2017a	Add	RunControl.nml	RainDissagMethod	-999	100
2016a	2017a	Add	RunControl.nml	SuppressWarnings	-999	1
2016a	2017a	Add	RunControl.nml	ncMode	-999	0
2016a	2017a	Add	RunControl.nml	nRow	-999	0
2016a	2017a	Add	RunControl.nml	nCol	-999	0
2016a	2017a	Add	RunControl.nml	Diagnose	-999	0
2016a	2017a	Rename	RunControl.nml	WriteSurfsFile	-999	WriteOutOption