GUIDEBOOK · GLOSSARY

Data Management

Data Management

Generated from cea/schemas.yml by scripts/generate_tutorial_glossary.py. Do not hand-edit — re-run the script to refresh.

Files in this category: 66 (⚠️ 35 stale)


Files


get_building_air_conditioning

  • Path: inputs/building-properties/air_conditioning_systems.csv
  • File type: csv
  • Created by: archetypes_mapper
  • Used by: demand
VariableDescriptionTypeUnitValues
hvac_cool_endsEnd of the cooling season - use 00|00 when there is nonestring`[DDMM]`
hvac_cool_startsStart of the cooling season - use 00|00 when there is nonestring`[DDMM]`
hvac_heat_endsEnd of the heating season - use 00|00 when there is nonestring`[DDMM]`
hvac_heat_startsStart of the heating season - use 00|00 when there is nonestring`[DDMM]`
hvac_type_csType of cooling HVAC assembly (relates to “code” in HVAC assemblies)string[-]alphanumeric
hvac_type_ctrlType of heating and cooling control HVAC assembly (relates to “code” in HVAC assemblies)string[-]alphanumeric
hvac_type_dhwType of hot water HVAC assembly (relates to “code” in HVAC assemblies)string[-]alphanumeric
hvac_type_hsType of heating HVAC assembly (relates to “code” in HVAC assemblies)string[-]alphanumeric
hvac_type_ventType of ventilation HVAC assembly (relates to “code” in HVAC assemblies)string[-]alphanumeric
nameUnique building ID. It must start with a letter.string[-]alphanumeric

get_building_architecture

  • Path: inputs/building-properties/envelope.csv
  • File type: csv
  • Created by: archetypes_mapper
  • Used by: demand, emissions, radiation, occupancy
VariableDescriptionTypeUnitValues
EsFraction of gross floor area with electrical demands.float[m2/m2]{0.0…1.0}
HsFraction of gross floor area air-conditioned.float[m2/m2]{0.0…1.0}
nameUnique building ID. It must start with a letter.string[-]alphanumeric
NsFraction of net gross floor area.float[m2/m2]{0.0…1.0}
occupied_bgWhether the basement is occupied/conditioned.boolean[-]{true, false}
type_baseBasement floor construction assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_floorInternal floor construction assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_leakTightness level assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_massType of construction assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_partInternal partitions construction assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_roofRoof construction assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_shadeShading system assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_wallExternal wall construction assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_winWindow assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
wwr_eastWindow to wall ratio in in facades facing eastfloat[m2/m2]{0.0…1.0}
wwr_northWindow to wall ratio in in facades facing northfloat[m2/m2]{0.0…1.0}
wwr_southWindow to wall ratio in in facades facing southfloat[m2/m2]{0.0…1.0}
wwr_westWindow to wall ratio in in facades facing westfloat[m2/m2]{0.0…1.0}

get_building_comfort

  • Path: inputs/building-properties/indoor_comfort.csv
  • File type: csv
  • Created by: archetypes_mapper
  • Used by: demand, occupancy
VariableDescriptionTypeUnitValues
nameUnique building ID. It must start with a letter.string[-]alphanumeric
RH_max_pcUpper bound of relative humidityfloat[%]{0.0…n}
RH_min_pcLower_bound of relative humidityfloat[%]{0.0…n}
Tcs_set_CSetpoint temperature for cooling systemfloat[C]{n…n}
Tcs_setb_CSetback point of temperature for cooling systemfloat[C]{n…n}
Ths_set_CSetpoint temperature for heating systemfloat[C]{0.0…n}
Ths_setb_CSetback point of temperature for heating systemfloat[C]{0.0…n}
Ve_lspMinimum outdoor air ventilation rate per person for Air Qualityfloat[l/s/p]{5.5…n}

get_building_internal

  • Path: inputs/building-properties/internal_loads.csv
  • File type: csv
  • Created by: archetypes_mapper
  • Used by: demand
VariableDescriptionTypeUnitValues
Ea_Wm2Peak specific electrical load due to computers and devicesfloat[W/m2]{0.0…n}
Ed_Wm2Peak specific electrical load due to servers/data centresfloat[W/m2]{0.0…n}
El_Wm2Peak specific electrical load due to artificial lightingfloat[W/m2]{0.0…n}
Epro_Wm2Peak specific electrical load due to industrial processesfloat[W/m2]{0.0…n}
Ev_kWvehPeak capacity of electric battery per vehiclefloat[kW/veh]{0.0…n}
nameUnique building ID. It must start with a letter.string[-]alphanumeric
Occ_m2pOccupancy densityfloat[m2/p]{0.0…n}
Qcpro_Wm2Peak specific process cooling loadfloat[W/m2]{0.0…n}
Qcre_Wm2Peak specific cooling load due to refrigeration (cooling rooms)float[W/m2]{0.0…n}
Qhpro_Wm2Peak specific process heating loadfloat[W/m2]{0.0…n}
Qs_WpPeak sensible heat load of peoplefloat[W/p]{0.0…n}
Vw_ldpPeak specific fresh water consumption (includes cold and hot water)float[ldp]{0.0…n}
Vww_ldpPeak specific daily hot water consumptionfloat[ldp]{0.0…n}
X_ghpMoisture released by occupancy at peak conditionsfloat[ghp]{0.0…n}

get_building_property_schedules_monthly_multiplier

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/building-properties/schedules/MONTHLY_MULTIPLIERS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: archetypes_mapper
VariableDescriptionTypeUnitValues
AprMonthly schedule coefficient for Aprilfloat[-]{0.0…1.0}
AugMonthly schedule coefficient for Augustfloat[-]{0.0…1.0}
DecMonthly schedule coefficient for Decemberfloat[-]{0.0…1.0}
FebMonthly schedule coefficient for Februaryfloat[-]{0.0…1.0}
JanMonthly schedule coefficient for Januaryfloat[-]{0.0…1.0}
JulMonthly schedule coefficient for Julyfloat[-]{0.0…1.0}
JunMonthly schedule coefficient for Junefloat[-]{0.0…1.0}
MarMonthly schedule coefficient for Marchfloat[-]{0.0…1.0}
MayMonthly schedule coefficient for Mayfloat[-]{0.0…1.0}
nameUnique building ID. It must start with a letter.stringNAalphanumeric
NovMonthly schedule coefficient for Novemberfloat[-]{0.0…1.0}
OctMonthly schedule coefficient for Octoberfloat[-]{0.0…1.0}
SepMonthly schedule coefficient for Septemberfloat[-]{0.0…1.0}

get_building_supply

  • Path: inputs/building-properties/supply_systems.csv
  • File type: csv
  • Created by: archetypes_mapper
  • Used by: decentralized, demand, emissions, system_costs
VariableDescriptionTypeUnitValues
nameUnique building ID. It must start with a letter.string[-]alphanumeric
supply_type_csType of cooling supply assembly (refers to “code” in SUPPLY assemblies)string[-]alphanumeric
supply_type_dhwType of hot water supply assembly (refers to “code” in SUPPLY assemblies)string[-]alphanumeric
supply_type_elType of electrical supply assembly (refers to “code” in SUPPLY assemblies)string[-]alphanumeric
supply_type_hsType of heating supply assembly (refers to “code” in SUPPLY assemblies)string[-]alphanumeric

get_building_weekly_schedules

  • Path: inputs/building-properties/schedules/B001.csv
  • File type: csv
  • Created by: archetypes_mapper
  • Used by: demand
VariableDescriptionTypeUnitValues
appliancesAppliancesfloat{0.0…1.0}
coolingSpace coolingstring{OFF, SETBACK, SETPOINT}
electromobilityAverage number of electric vehicles in this hourfloat{0.0…10000.0}
heatingSpace heatingstring{OFF, SETBACK, SETPOINT}
hot_waterDomestic hot waterfloat{0.0…1.0}
hourDay of the week (weekday, saturday, or sunday)string{Weekday_00, Weekday_01, Weekday_02, Weekday_03, Weekday_04, Weekday_05, Weekday_06, Weekday_07, Weekday_08, Weekday_09, Weekday_10, Weekday_11, Weekday_12, Weekday_13, Weekday_14, Weekday_15, Weekday_16, Weekday_17, Weekday_18, Weekday_19, Weekday_20, Weekday_21, Weekday_22, Weekday_23, Saturday_00, Saturday_01, Saturday_02, Saturday_03, Saturday_04, Saturday_05, Saturday_06, Saturday_07, Saturday_08, Saturday_09, Saturday_10, Saturday_11, Saturday_12, Saturday_13, Saturday_14, Saturday_15, Saturday_16, Saturday_17, Saturday_18, Saturday_19, Saturday_20, Saturday_21, Saturday_22, Saturday_23, Sunday_00, Sunday_01, Sunday_02, Sunday_03, Sunday_04, Sunday_05, Sunday_06, Sunday_07, Sunday_08, Sunday_09, Sunday_10, Sunday_11, Sunday_12, Sunday_13, Sunday_14, Sunday_15, Sunday_16, Sunday_17, Sunday_18, Sunday_19, Sunday_20, Sunday_21, Sunday_22, Sunday_23}
lightingLightingfloat{0.0…1.0}
occupancyOccupancyfloat{0.0…1.0}
processesprocessesfloat{0.0…1.0}
serversServersfloat{0.0…1.0}

get_database_air_conditioning_systems

⚠️ Stale: no matching InputLocator method exists, but the locator name is still referenced by string in cea/datamanagement/databases_verification.py. Removing this from schemas.yml will also require updating that reference.

  • Path: inputs/technology/assemblies/HVAC.xlsx
  • File type: xls
  • Created by: database_helper
  • Used by: demand

Worksheet: CONTROLLER

VariableDescriptionTypeUnitValues
codeUnique ID of the controllerstring[-]alphanumeric
DescriptionDescribes the type of controllerstring[-]alphanumeric
dT_Qcscorrection temperature of emission losses due to control system of coolingfloat[C]{n…n}
dT_Qhscorrection temperature of emission losses due to control system of heatingfloat[C]{0.0…n}

Worksheet: COOLING

VariableDescriptionTypeUnitValues
class_csType or class of the cooling systemstring[-]{NONE, CEILING_COOLING, DECENTRALIZED_AC, CENTRAL_AC, HYBRID_AC, FLOOR_COOLING}
codeUnique ID of the heating systemstring[-]alphanumeric
convection_csConvective part of the power of the heating system in relation to the total powerfloat[-]{0.0…1.0}
DescriptionDescribes the type of cooling systemstring[-]alphanumeric
dTcs0_ahu_CNominal temperature increase on the water side of the air-handling unitsfloat[C]{0.0…n}
dTcs0_aru_CNominal temperature increase on the water side of the air-recirculation unitsfloat[C]{0.0…n}
dTcs0_scu_CNominal temperature increase on the water side of the sensible cooling unitsfloat[C]{0.0…n}
dTcs_CSet-point correction for space emission systemsfloat[C]{0.0…n}
Qcsmax_Wm2Maximum heat flow permitted by cooling system per m2 gross floor areafloat[W/m2]{0.0…n}
Tc_sup_air_ahu_CSupply air temperature of the air-handling unitsfloat[C]{0.0…n}
Tc_sup_air_aru_CSupply air temperature of the air-recirculation unitsfloat[C]{0.0…n}
Tscs0_ahu_CNominal supply temperature of the water side of the air-handling unitsfloat[C]{0.0…n}
Tscs0_aru_CNominal supply temperature of the water side of the air-recirculation unitsfloat[C]{0.0…n}
Tscs0_scu_CNominal supply temperature of the water side of the sensible cooling unitsfloat[C]{0.0…n}

Worksheet: HEATING

VariableDescriptionTypeUnitValues
class_hsType or class of the heating systemstring[-]{NONE, RADIATOR, CENTRAL_AC, FLOOR_HEATING}
codeUnique ID of the heating systemstring[-]alphanumeric
convection_hsConvective part of the power of the heating system in relation to the total powerfloat[-]{0.0…1.0}
DescriptionDescriptionstring[-]alphanumeric
dThs0_ahu_CNominal temperature increase on the water side of the air-handling unitsfloat[C]{0.0…n}
dThs0_aru_CNominal temperature increase on the water side of the air-recirculation unitsfloat[C]{0.0…n}
dThs0_shu_CNominal temperature increase on the water side of the sensible heating unitsfloat[C]{0.0…n}
dThs_Ccorrection temperature of emission losses due to type of heating systemfloat[C]{n…n}
Qhsmax_Wm2Maximum heat flow permitted by heating system per m2 gross floor areafloat[W/m2]{0.0…n}
Th_sup_air_ahu_CSupply air temperature of the air-recirculation unitsfloat[C]{0.0…n}
Th_sup_air_aru_CSupply air temperature of the air-handling unitsfloat[C]{0.0…n}
Tshs0_ahu_CNominal supply temperature of the water side of the air-handling unitsfloat[C]{0.0…n}
Tshs0_aru_CNominal supply temperature of the water side of the air-recirculation unitsfloat[C]{0.0…n}
Tshs0_shu_CNominal supply temperature of the water side of the sensible heating unitsfloat[C]{0.0…n}

Worksheet: HOT_WATER

VariableDescriptionTypeUnitValues
class_dhwType or class of the DHW systemstring[-]{NONE, HIGH_TEMP, MEDIUM_TEMP, LOW_TEMP}
codeUnique ID of the hot water supply systemstring[-]alphanumeric
DescriptionDescribes the Type of hot water supply systemstring[-]alphanumeric
Qwwmax_Wm2Maximum heat flow permitted by hot water system per m2 gross floor areafloat[W/m2]{0.0…n}
Tsww0_CTypical supply water temperature.float[C]{0.0…n}

Worksheet: VENTILATION

VariableDescriptionTypeUnitValues
codeUnique ID of the type of ventilationstring[-]alphanumeric
DescriptionDescribes the Type of ventilationstring[-]alphanumeric
ECONOMIZERBoolean, economizer onboolean[-]{true, false}
HEAT_RECBoolean, heat recovery onboolean[-]{true, false}
MECH_VENTBoolean, mechanical ventilation onboolean[-]{true, false}
NIGHT_FLSHBoolean, night flush onboolean[-]{true, false}
WIN_VENTBoolean, window ventilation onboolean[-]{true, false}

get_database_archetypes_construction_type

  • Path: inputs/database/ARCHETYPES/CONSTRUCTION/CONSTRUCTION_TYPES.csv
  • File type: csv
  • Created by: database_helper
  • Used by: archetypes_mapper
VariableDescriptionTypeUnitValues
const_typeUnique ID of Construction Standardstring[-]alphanumeric
descriptionDescription of the construction archetypestringNAalphanumeric
EsFraction of gross floor area with electrical demands.float[m2/m2]{0.0…1.0}
HsFraction of gross floor area air-conditioned.float[m2/m2]{0.0…1.0}
hvac_cool_endsEnd of the cooling season - use 00|00 when there is nonestring`[DDMM]`
hvac_cool_startsStart of the cooling season - use 00|00 when there is nonestring`[DDMM]`
hvac_heat_endsEnd of the heating season - use 00|00 when there is nonestring`[DDMM]`
hvac_heat_startsStart of the heating season - use 00|00 when there is nonestring`[DDMM]`
hvac_type_csType of cooling HVAC assembly (relates to “code” in HVAC assemblies)stringNAalphanumeric
hvac_type_ctrlType of heating and cooling control HVAC assembly (relates to “code” in HVAC assemblies)stringNAalphanumeric
hvac_type_dhwType of hot water HVAC assembly (relates to “code” in HVAC assemblies)stringNAalphanumeric
hvac_type_hsType of heating HVAC assembly (relates to “code” in HVAC assemblies)stringNAalphanumeric
hvac_type_ventType of ventilation HVAC assembly (relates to “code” in HVAC assemblies)stringNAalphanumeric
NsFraction of net gross floor area.float[m2/m2]{0.0…1.0}
occupied_bgBoolean, basement conditioned/occupiedboolean[-]{true, false}
supply_type_csType of cooling supply assembly (refers to “code” in SUPPLY assemblies)stringNAalphanumeric
supply_type_dhwType of hot water supply assembly (refers to “code” in SUPPLY assemblies)stringNAalphanumeric
supply_type_elType of electrical supply assembly (refers to “code” in SUPPLY assemblies)stringNAalphanumeric
supply_type_hsType of heating supply assembly (refers to “code” in SUPPLY assemblies)stringNAalphanumeric
type_baseBasement floor construction assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_floorInternal floor construction assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_leakTightness level assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_massType of mass assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_partInternal partitions construction assembly (relates to “code” in ENVELOPE assemblies)stringNAalphanumeric
type_roofRoof construction assembly (relates to “code” in ENVELOPE assemblies)stringNAalphanumeric
type_shadeShading system assembly (relates to “code” in ENVELOPE assemblies)stringNAalphanumeric
type_wallExternal wall construction assembly (relates to “code” in ENVELOPE assemblies)stringNAalphanumeric
type_winWindow assembly (relates to “code” in ENVELOPE assemblies)stringNAalphanumeric
wwr_eastWindow to wall ratio in in facades facing eastfloat[m2/m2]{0.0…1.0}
wwr_northWindow to wall ratio in in facades facing northfloat[m2/m2]{0.0…1.0}
wwr_southWindow to wall ratio in in facades facing southfloat[m2/m2]{0.0…1.0}
wwr_westWindow to wall ratio in in facades facing westfloat[m2/m2]{0.0…1.0}
year_endUpper limit of year interval where the building properties applyint[-]{0…n}
year_startLower limit of year interval where the building properties applyint[-]{0…n}

get_database_archetypes_schedules

  • Path: inputs/database/ARCHETYPES/USE/SCHEDULES/SCHEDULES_LIBRARY/MULTI_RES.csv
  • File type: csv
  • Created by: database_helper
  • Used by: archetypes_mapper
VariableDescriptionTypeUnitValues
appliancesAppliancesfloat[-]{0.0…1.0}
coolingSpace coolingstring[-]{OFF, SETBACK, SETPOINT}
electromobilityAverage number of electric vehicles in this hourfloat[-]{0.0…n}
heatingSpace heatingstring[-]{OFF, SETBACK, SETPOINT}
hot_waterDomestic hot waterfloat[-]{0.0…1.0}
hourDay of the week (weekday, saturday, or sunday)string[-]{Weekday_00, Weekday_01, Weekday_02, Weekday_03, Weekday_04, Weekday_05, Weekday_06, Weekday_07, Weekday_08, Weekday_09, Weekday_10, Weekday_11, Weekday_12, Weekday_13, Weekday_14, Weekday_15, Weekday_16, Weekday_17, Weekday_18, Weekday_19, Weekday_20, Weekday_21, Weekday_22, Weekday_23, Saturday_00, Saturday_01, Saturday_02, Saturday_03, Saturday_04, Saturday_05, Saturday_06, Saturday_07, Saturday_08, Saturday_09, Saturday_10, Saturday_11, Saturday_12, Saturday_13, Saturday_14, Saturday_15, Saturday_16, Saturday_17, Saturday_18, Saturday_19, Saturday_20, Saturday_21, Saturday_22, Saturday_23, Sunday_00, Sunday_01, Sunday_02, Sunday_03, Sunday_04, Sunday_05, Sunday_06, Sunday_07, Sunday_08, Sunday_09, Sunday_10, Sunday_11, Sunday_12, Sunday_13, Sunday_14, Sunday_15, Sunday_16, Sunday_17, Sunday_18, Sunday_19, Sunday_20, Sunday_21, Sunday_22, Sunday_23}
lightingLightingfloat[-]{0.0…1.0}
occupancyOccupancyfloat[-]{0.0…1.0}
processesprocessesfloat[-]{0.0…1.0}
serversServersfloat[-]{0.0…1.0}

get_database_archetypes_schedules_monthly_multiplier

  • Path: inputs/database/ARCHETYPES/SCHEDULES/MONTHLY_MULTIPLIERS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: archetypes_mapper
VariableDescriptionTypeUnitValues
AprMonthly schedule coefficient for Aprilfloat[-]{0.0…1.0}
AugMonthly schedule coefficient for Augustfloat[-]{0.0…1.0}
DecMonthly schedule coefficient for Decemberfloat[-]{0.0…1.0}
FebMonthly schedule coefficient for Februaryfloat[-]{0.0…1.0}
JanMonthly schedule coefficient for Januaryfloat[-]{0.0…1.0}
JulMonthly schedule coefficient for Julyfloat[-]{0.0…1.0}
JunMonthly schedule coefficient for Junefloat[-]{0.0…1.0}
MarMonthly schedule coefficient for Marchfloat[-]{0.0…1.0}
MayMonthly schedule coefficient for Mayfloat[-]{0.0…1.0}
NovMonthly schedule coefficient for Novemberfloat[-]{0.0…1.0}
OctMonthly schedule coefficient for Octoberfloat[-]{0.0…1.0}
SepMonthly schedule coefficient for Septemberfloat[-]{0.0…1.0}
use_typeuse type code (refers to building use type)stringNAalphanumeric

get_database_archetypes_use_type

  • Path: inputs/database/ARCHETYPES/USE/USE_TYPES.csv
  • File type: csv
  • Created by: database_helper
  • Used by: archetypes_mapper
VariableDescriptionTypeUnitValues
Ea_Wm2Peak specific electrical load due to computers and devicesfloat[W/m2]{0.0…n}
Ed_Wm2Peak specific electrical load due to servers/data centresfloat[W/m2]{0.0…n}
El_Wm2Peak specific electrical load due to artificial lightingfloat[W/m2]{0.0…n}
Epro_Wm2Peak specific electrical load due to industrial processesfloat[W/m2]{0.0…n}
Ev_kWvehPeak capacity of electrical battery per vehiclefloat[kW/veh]{0.0…n}
Occ_m2pOccupancy densityfloat[m2/p]{0.0…n}
Qcpro_Wm2Peak specific process cooling loadfloat[W/m2]{0.0…n}
Qcre_Wm2Peak specific cooling load due to refrigeration (cooling rooms)float[W/m2]{0.0…n}
Qhpro_Wm2Peak specific process heating loadfloat[W/m2]{0.0…n}
Qs_WpPeak sensible heat load of peoplefloat[W/p]{0.0…n}
RH_max_pcUpper bound of relative humidityfloat[%]{0.0…n}
RH_min_pcLower_bound of relative humidityfloat[%]{0.0…n}
Tcs_set_CSetpoint temperature for cooling systemfloat[C]{n…n}
Tcs_setb_CSetback point of temperature for cooling systemfloat[C]{n…n}
Ths_set_CSetpoint temperature for heating systemfloat[C]{0.0…n}
Ths_setb_CSetback point of temperature for heating systemfloat[C]{n…n}
use_typeuse type code (refers to building use type)stringNAalphanumeric
Ve_lspIndoor quality requirements of indoor ventilation per personfloat[l/s]{0.0…n}
Vw_ldpPeak specific fresh water consumption (includes cold and hot water)float[lpd]{0.0…n}
Vww_ldpPeak specific daily hot water consumptionfloat[lpd]{0.0…n}
X_ghpMoisture released by occupancy at peak conditionsfloat[g/h/p]{0.0…n}

get_database_assemblies_envelope_floor

  • Path: inputs/database/ASSEMBLIES/ENVELOPE/ENVELOPE_FLOOR.csv
  • File type: csv
  • Created by: database_helper
  • Used by: demand, radiation
VariableDescriptionTypeUnitValues
codeType of roofstringNAalphanumeric
descriptionDescribes the Type of roofstringNAalphanumeric
GHG_biogenic_floor_kgCO2m2Biogenic carbon storage per m2 of floor.(entire building life cycle)float[kg CO2-eq/m2]{n…0.0}
GHG_floor_kgCO2m2Embodied emissions per m2 of floor.(entire building life cycle)float[kg CO2-eq/m2]{0.0…n}
Service_Life_floorService life of the floor assemblyfloat[yr]{0.0…n}
U_baseThermal transmittance of floor including linear losses (+10%). Defined according to ISO 13790.float[-]{0.1…n}

get_database_assemblies_envelope_mass

  • Path: inputs/database/ASSEMBLIES/ENVELOPE/ENVELOPE_MASS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: demand, radiation
VariableDescriptionTypeUnitValues
Cm_AfInternal heat capacity per unit of air conditioned area. Defined according to ISO 13790.float[J/Km2]{0.0…n}
codeType of constructionstringNAalphanumeric
descriptionDescribes the Type of constructionstringNAalphanumeric

get_database_assemblies_envelope_roof

  • Path: inputs/database/ASSEMBLIES/ENVELOPE/ENVELOPE_ROOF.csv
  • File type: csv
  • Created by: database_helper
  • Used by: demand, radiation
VariableDescriptionTypeUnitValues
a_roofSolar absorption coefficient. Defined according to ISO 13790.float[-]{0.0…1.0}
codeType of roofstringNAalphanumeric
descriptionDescribes the Type of roofstringNAalphanumeric
e_roofEmissivity of external surface. Defined according to ISO 13790.float[-]{0.0…1.0}
GHG_biogenic_roof_kgCO2m2Biogenic carbon storage per m2 of roof.(entire building life cycle)float[kg CO2-eq/m2]{n…0.0}
GHG_roof_kgCO2m2Embodied emissions per m2 of roof.(entire building life cycle)float[kg CO2-eq/m2]{0.0…n}
r_roofReflectance in the Red spectrum. Defined according Radiance. (long-wave)float[-]{0.0…1.0}
Service_Life_roofService life of the roof assemblyfloat[yr]{0.0…n}
U_roofThermal transmittance of windows including linear losses (+10%). Defined according to ISO 13790.float[-]{0.1…n}

get_database_assemblies_envelope_shading

  • Path: inputs/database/ASSEMBLIES/ENVELOPE/ENVELOPE_SHADING.csv
  • File type: csv
  • Created by: database_helper
  • Used by: demand, radiation
VariableDescriptionTypeUnitValues
codeType of shadingstringNAalphanumeric
descriptionDescribes the source of the benchmark standards.stringNAalphanumeric
rf_shShading coefficient when shading device is active. A value of 1 means that all solar heat is gained. Defined according to ISO 13790. If exterior blinds incident window radiation will be multiplied by this factor. If interior blinds the window G-value will be multiplied by this factor and the incident radiation on the window will be multiplied by the resulting product.float[-]{0.0…1.0}
shading_locationLocation of shading device (‘interior’ or ‘exterior’ only)string[-]{interior, exterior}
shading_setpoint_Wm2Activation setpoint for shading in [W/m2]. When the direct solar radiation on a surface exceeds this value, the shading device is activated. Defaults to 300 W/m2.float[W/m2]{1.0…3500.0}

get_database_assemblies_envelope_tightness

  • Path: inputs/database/ASSEMBLIES/ENVELOPE/ENVELOPE_TIGHTNESS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: demand, radiation
VariableDescriptionTypeUnitValues
codeType of tightnessstringNAalphanumeric
descriptionDescribes the Type of tightnessstringNAalphanumeric
n50Air exchanges per hour at a pressure of 50 Pa.float[1/h]{0.0…10.0}

get_database_assemblies_envelope_wall

  • Path: inputs/database/ASSEMBLIES/ENVELOPE/ENVELOPE_WALL.csv
  • File type: csv
  • Created by: database_helper
  • Used by: demand, radiation
VariableDescriptionTypeUnitValues
a_wallSolar absorption coefficient. Defined according to ISO 13790.float[-]{0.0…1.0}
codeType of wallstringNAalphanumeric
descriptionDescribes the Type of wallstringNAalphanumeric
e_wallEmissivity of external surface. Defined according to ISO 13790.float[-]{0.0…1.0}
GHG_biogenic_wall_kgCO2m2Biogenic carbon storage per m2 of walls (entire building life cycle)float[kg CO2-eq/m2]{n…0.0}
GHG_wall_kgCO2m2Embodied emissions per m2 of walls (entire building life cycle)float[kg CO2-eq/m2]{0.0…n}
r_wallReflectance in the Red spectrum. Defined according Radiance. (long-wave)float[-]{0.0…1.0}
Service_Life_wallService life of the wall assemblyfloat[yr]{0.0…n}
U_wallThermal transmittance of windows including linear losses (+10%). Defined according to ISO 13790.float[-]{0.1…n}

get_database_assemblies_envelope_window

  • Path: inputs/database/ASSEMBLIES/ENVELOPE/ENVELOPE_WINDOW.csv
  • File type: csv
  • Created by: database_helper
  • Used by: demand, radiation
VariableDescriptionTypeUnitValues
codeWindow type code to relate to other databasesstringNAalphanumeric
descriptionDescribes the source of the benchmark standards.stringNAalphanumeric
e_winEmissivity of external surface. Defined according to ISO 13790.float[-]{0.0…1.0}
F_FWindow frame fraction coefficient. Defined according to ISO 13790.float[m2-frame/m2-window]{0.0…1.0}
G_winSolar heat gain coefficient. A value of 1 means all solar heat is gained. Defined according to ISO 13790.float[-]{0.0…1.0}
GHG_biogenic_win_kgCO2m2Biogenic carbon storage per m2 of windows.(entire building life cycle)float[kg CO2-eq/m2]{n…0.0}
GHG_win_kgCO2m2Embodied emissions per m2 of windows.(entire building life cycle)float[kg CO2-eq/m2]{0.0…n}
Service_Life_winService life of the window assemblyfloat[yr]{0.0…n}
U_winThermal transmittance of windows including linear losses (+10%). Defined according to ISO 13790.float[-]{0.1…n}

get_database_assemblies_hvac_controller

  • Path: inputs/database/ASSEMBLIES/HVAC/HVAC_CONTROLLER.xls
  • File type: csv
  • Created by: database_helper
  • Used by: demand
VariableDescriptionTypeUnitValues
codeUnique ID of the controllerstring[-]alphanumeric
descriptionDescribes the type of controllerstring[-]alphanumeric
dT_Qcscorrection temperature of emission losses due to control system of coolingfloat[C]{n…n}
dT_Qhscorrection temperature of emission losses due to control system of heatingfloat[C]{0.0…n}

get_database_assemblies_hvac_cooling

  • Path: inputs/database/ASSEMBLIES/HVAC/HVAC_COOLING.xls
  • File type: csv
  • Created by: database_helper
  • Used by: demand
VariableDescriptionTypeUnitValues
class_csType or class of the cooling systemstring[-]{NONE, CEILING_COOLING, DECENTRALIZED_AC, CENTRAL_AC, HYBRID_AC, FLOOR_COOLING}
codeUnique ID of the heating systemstring[-]alphanumeric
convection_csConvective part of the power of the heating system in relation to the total powerfloat[-]{0.0…1.0}
descriptionDescribes the type of cooling systemstring[-]alphanumeric
dTcs0_ahu_CNominal temperature increase on the water side of the air-handling unitsfloat[C]{0.0…n}
dTcs0_aru_CNominal temperature increase on the water side of the air-recirculation unitsfloat[C]{0.0…n}
dTcs0_scu_CNominal temperature increase on the water side of the sensible cooling unitsfloat[C]{0.0…n}
dTcs_CSet-point correction for space emission systemsfloat[C]{0.0…n}
Qcsmax_Wm2Maximum heat flow permitted by cooling system per m2 gross floor areafloat[W/m2]{0.0…n}
Tc_sup_air_ahu_CSupply air temperature of the air-handling unitsfloat[C]{0.0…n}
Tc_sup_air_aru_CSupply air temperature of the air-recirculation unitsfloat[C]{0.0…n}
Tscs0_ahu_CNominal supply temperature of the water side of the air-handling unitsfloat[C]{0.0…n}
Tscs0_aru_CNominal supply temperature of the water side of the air-recirculation unitsfloat[C]{0.0…n}
Tscs0_scu_CNominal supply temperature of the water side of the sensible cooling unitsfloat[C]{0.0…n}

get_database_assemblies_hvac_heating

  • Path: inputs/database/ASSEMBLIES/HVAC/HVAC_HEATING.xls
  • File type: csv
  • Created by: database_helper
  • Used by: demand
VariableDescriptionTypeUnitValues
class_hsType or class of the heating systemstring[-]{NONE, RADIATOR, CENTRAL_AC, FLOOR_HEATING}
codeUnique ID of the heating systemstring[-]alphanumeric
convection_hsConvective part of the power of the heating system in relation to the total powerfloat[-]{0.0…1.0}
descriptionDescriptionstring[-]alphanumeric
dThs0_ahu_CNominal temperature increase on the water side of the air-handling unitsfloat[C]{0.0…n}
dThs0_aru_CNominal temperature increase on the water side of the air-recirculation unitsfloat[C]{0.0…n}
dThs0_shu_CNominal temperature increase on the water side of the sensible heating unitsfloat[C]{0.0…n}
dThs_Ccorrection temperature of emission losses due to type of heating systemfloat[C]{n…n}
Qhsmax_Wm2Maximum heat flow permitted by heating system per m2 gross floor areafloat[W/m2]{0.0…n}
Th_sup_air_ahu_CSupply air temperature of the air-recirculation unitsfloat[C]{0.0…n}
Th_sup_air_aru_CSupply air temperature of the air-handling unitsfloat[C]{0.0…n}
Tshs0_ahu_CNominal supply temperature of the water side of the air-handling unitsfloat[C]{0.0…n}
Tshs0_aru_CNominal supply temperature of the water side of the air-recirculation unitsfloat[C]{0.0…n}
Tshs0_shu_CNominal supply temperature of the water side of the sensible heating unitsfloat[C]{0.0…n}

get_database_assemblies_hvac_hot_water

  • Path: inputs/database/ASSEMBLIES/HVAC/HVAC_HOTWATER.csv
  • File type: csv
  • Created by: database_helper
  • Used by: demand
VariableDescriptionTypeUnitValues
class_dhwType or class of the DHW systemstring[-]{NONE, HIGH_TEMP, MEDIUM_TEMP, LOW_TEMP}
codeUnique ID of the hot water supply systemstring[-]alphanumeric
descriptionDescribes the Type of hot water supply systemstring[-]alphanumeric
Qwwmax_Wm2Maximum heat flow permitted by hot water system per m2 gross floor areafloat[W/m2]{0.0…n}
Tsww0_CTypical supply water temperature.float[C]{0.0…n}

get_database_assemblies_hvac_ventilation

  • Path: inputs/database/ASSEMBLIES/HVAC/VENTILATION.csv
  • File type: csv
  • Created by: database_helper
  • Used by: demand
VariableDescriptionTypeUnitValues
codeUnique ID of the type of ventilationstring[-]alphanumeric
descriptionDescribes the Type of ventilationstring[-]alphanumeric
ECONOMIZERBoolean, economizer onboolean[-]{true, false}
HEAT_RECBoolean, heat recovery onboolean[-]{true, false}
MECH_VENTBoolean, mechanical ventilation onboolean[-]{true, false}
NIGHT_FLSHBoolean, night flush onboolean[-]{true, false}
WIN_VENTBoolean, window ventilation onboolean[-]{true, false}

get_database_assemblies_supply_cooling

  • Path: inputs/database/ASSEMBLIES/SUPPLY/SUPPLY_COOLING.csv
  • File type: csv
  • Created by: database_helper
  • Used by: demand, emissions, system_costs
VariableDescriptionTypeUnitValues
codeCode of cooling supply assemblystringNAalphanumeric
descriptiondescriptionstringNAalphanumeric
primary_componentscodes of components installed in the primary supply system category (i.e. main components)stringNAalphanumeric
referencereferencestringNAalphanumeric
scalewhether the all in one system is used at the building or the district scalestringNA{NONE, BUILDING, DISTRICT, CITY}
secondary_componentscodes of components installed in the secondary supply system category (i.e. supply components)stringNAalphanumeric
tertiary_componentscodes of components installed in the tertiary supply system category (i.e. rejection components)stringNAalphanumeric

get_database_assemblies_supply_electricity

  • Path: inputs/database/ASSEMBLIES/SUPPLY/SUPPLY_ELECTRICITY.csv
  • File type: csv
  • Created by: database_helper
  • Used by: demand, emissions, system_costs
VariableDescriptionTypeUnitValues
codeType of all in one systemstringNAalphanumeric
descriptionDescription of Type of all in one systemstringNAalphanumeric
efficiencyefficiency of the all in one systemfloat[-]{0.0…n}
feedstockfeedstock used by the the all in one system (refers to the FEEDSTOCK database)stringNA{NONE, NATURALGAS, BIOGAS, GRID, SOLAR, OIL, COAL, WOOD, WETBIOMASS, DRYBIOMASS, HYDROGEN}
referenceReference of the datastringNAalphanumeric
scalewhether the all in one system is used at the building or the district scalestringNA{NONE, BUILDING, DISTRICT, CITY}

get_database_assemblies_supply_heating

  • Path: inputs/database/ASSEMBLIES/SUPPLY/SUPPLY_HEATING.csv
  • File type: csv
  • Created by: database_helper
  • Used by: demand, emissions, system_costs
VariableDescriptionTypeUnitValues
codeType of all in one systemstringNAalphanumeric
descriptionDescription of Type of all in one systemstringNAalphanumeric
primary_componentscodes of components installed in the primary supply system category (i.e. main components)stringNAalphanumeric
referenceReference of the datastringNAalphanumeric
scalewhether the all in one system is used at the building or the district scalestringNA{NONE, BUILDING, DISTRICT, CITY}
secondary_componentscodes of components installed in the secondary supply system category (i.e. supply components)stringNAalphanumeric
tertiary_componentscodes of components installed in the tertiary supply system category (i.e. rejection components)stringNAalphanumeric

get_database_assemblies_supply_hot_water

  • Path: inputs/database/ASSEMBLIES/SUPPLY/SUPPLY_HOTWATER.csv
  • File type: csv
  • Created by: database_helper
  • Used by: demand, emissions, system_costs
VariableDescriptionTypeUnitValues
codeType of all in one systemstringNAalphanumeric
descriptionDescription of Type of all in one systemstringNAalphanumeric
primary_componentscodes of components installed in the primary supply system category (i.e. main components)stringNAalphanumeric
referenceReference of the datastringNAalphanumeric
scalewhether the all in one system is used at the building or the district scalestringNA{NONE, BUILDING, DISTRICT, CITY}
secondary_componentscodes of components installed in the secondary supply system category (i.e. supply components)stringNAalphanumeric
tertiary_componentscodes of components installed in the tertiary supply system category (i.e. rejection components)stringNAalphanumeric

get_database_components_conversion_absorption_chillers

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/ABSORPTION_CHILLERS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
a_eparameter in the characteristic equations to calculate the evaporator sidefloat[-]{n…n}
a_gparameter in the characteristic equations to calculate the generator sidefloat[-]{n…n}
assumptionitems made by assumptions in this technologystring[-]alphanumeric
aux_powerauxiliary electrical power supply for pumping of fluids (expressed as share of cooling produced)float[-]{0.0…n}
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
descriptiondescribes the Type of Absorption ChillerstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
e_eparameter in the characteristic equations to calculate the evaporator sidefloat[-]{0.0…n}
e_gparameter in the characteristic equations to calculate the generator sidefloat[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
m_cwexternal flow rate of cooling water at the condenser and absorberfloat[kg/s]{0.0…n}
m_hwexternal flow rate of hot water at the generatorfloat[kg/s]{0.0…n}
min_eff_ratingMinimum efficiency rating according to prevalent standards or manufacturer catalogues, expressed as a COP.float[W_th/W_el]{0.0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
r_eparameter in the characteristic equations to calculate the evaporator sidefloat[-]{n…n}
r_gparameter in the characteristic equations to calculate the generator sidefloat[-]{n…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
s_eparameter in the characteristic equations to calculate the evaporator sidefloat[kW/K]{0.0…n}
s_gparameter in the characteristic equations to calculate the generator sidefloat[-]{0.0…n}
T_cond_designdesign temperature of the outflowing water or air at the condenserfloat[°C]{0.0…n}
T_evap_designdesign temperature of the outflowing water at the evaporatorfloat[°C]{0.0…n}
T_gen_designdesign temperature of the inflowing water or steam at the generatorfloat[°C]{0.0…n}
typetype of absorption chillerstringNA{single, double, triple}
unitunit of the min/max capacitystringNAalphanumeric
V_power_supplyvoltage of the power supply under design conditionsfloat[V]{0.0…n}

get_database_components_conversion_boilers

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/BOILERS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost functionstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
descriptiondescribes the type of boilerstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
fuel_codecode of the combustible energy carrier used by the boiler (matching code in EnergyCarriers database)stringNAalphanumeric
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
min_eff_ratingminimum thermal efficiency rating of the boilerfloat[-]{n…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
T_flue_gas_designoutflowing flue gas temperature as designed by the manufacturerfloat[°C]{n…n}
T_water_in_ratingaverage inflowing water temperature of the boiler under rating conditions (i.e. conditions used for determining rated efficiency)float[°C]{n…n}
T_water_out_ratingaverage outflowing water temperature of the boiler under rating conditions (i.e. conditions used for determining rated efficiency)float[°C]{n…n}
typetype of boilerstringNA{gas, oil, gas-cond}
unitunit of the min/max capacitystringNAalphanumeric

get_database_components_conversion_bore_holes

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/BORE_HOLES.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
descriptionDescribes the source of the benchmark standards.stringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
unitunit of the min/max capacitystringNAalphanumeric

get_database_components_conversion_cogeneration_plants

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/COGENERATION_PLANTS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
descriptiondescribes the type of combined-cycle gas turbinestringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
elec_eff_designelectrical efficiency rating of the cogen plant under design conditionsfloat[-]{0.0…n}
fuel_codecode of the combustible energy carrier used by the cogeneration plant (matching code in EnergyCarriers database)stringNAalphanumeric
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
T_flue_gas_designaverage temperature of the emitted flue gas when the cogen plant is operated as designed by the manufacturerfloat[°C]{n…n}
T_water_out_designaverage temperature of the hot water generated by the cogen plant as designed by the manufacturerfloat[°C]{n…n}
therm_eff_designthermal efficiency rating of the cogen plant under design conditionsfloat[-]{0.0…n}
typetype of cogeneration plant (given by its combustion component)stringNA{engine, bio-engine, furnace, turbine}
unitunit of the min/max capacitystringNAalphanumeric
V_power_out_designvoltage level of the power generated by the cogen plant as designed by the manufacturerfloat[V]{n…n}

get_database_components_conversion_cooling_towers

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/COOLING_TOWERS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
aux_powerpower required to operate fans, pumps and water treatment devices (expressed as percentage of total heat rejection)float[-]{n…n}
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
descriptiondescribes the type of cooling towerstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
T_air_in_designaverage dry-bulb air temperature flowing into the cooling tower when it is operated as designed by the manufacturerfloat[°C]{n…n}
T_water_in_designaverage temperature of the water supply to the cooling tower as designed by the manufacturerfloat[°C]{n…n}
T_water_out_designaverage return temperature of the water exiting the cooling tower as designed by the manufacturerfloat[°C]{n…n}
typetype of cooling towerstringNA{open-circuit, closed-circuit}
unitunit of the min/max capacitystringNAalphanumeric
V_power_supplyvoltage level of the power supply for the cooling tower as designed by the manufacturerfloat[V]{n…n}

get_database_components_conversion_fuel_cells

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/FUEL_CELLS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
descriptionDescribes the type of fuel cellstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
unitunit of the min/max capacitystringNAalphanumeric

get_database_components_conversion_heat_exchangers

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/HEAT_EXCHANGERS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacity mass flow rate [W/K]float[-]{n…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacity mass flow rate [W/K]float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacity mass flow rate [W/K]float[-]{0.0…n}
cap_maxmaximum capacityfloatNA{0.0…n}
cap_minminimum capacityfloatNA{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacity mass flow rate [W/K]float[-]{n…n}
descriptionDescribes the type of heat exchangerstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), here x is the capacity mass flow rate [W/K]float[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
medium_inthermal energy carrier subtype (i.e. type of fluid) on the hot side of the heat exchangerstringNA{water, air, brine}
medium_outthermal energy carrier subtype (i.e. type of fluid) on the cold side of the heat exchangerstringNA{water, air, brine}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
T_max_operatingmaximum operating temperature of the heat exchangerfloat[°C]{n…n}
T_min_operatingminimum operating temperature of the heat exchangerfloat[°C]{n…n}
typetype of heat exchangerstringNA{counter-flow, plate, concurrent flow, tube}
unitunit of the min/max capacitystringNAalphanumeric

get_database_components_conversion_heat_pumps

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/HEAT_PUMPS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
descriptionDescribes the source of the heat pumpstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
medium_cond_sidethermal energy carrier subtype (i.e. type of fluid) on the condenser side of the heat pumpstringNA{water, air, brine}
medium_evap_sidethermal energy carrier subtype (i.e. type of fluid) on the evaporator side of the heat pumpstringNA{water, air, brine}
min_eff_rating_seasonalminimum seasonal efficiency rating of the heat pumpfloat[-]{0.0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
T_cond_designaverage temperature of the condenser-side of the heat pump if it is operated as designed by the manufacturerfloat[°C]{n…n}
T_evap_designaverage temperature of the evaporator-side of the heat pump if it is operated as designed by the manufacturerfloat[°C]{n…n}
typetype of heat pumpstringNA{geothermal, air-source, water-source}
unitunit of the min/max capacitystringNAalphanumeric
V_power_supplyvoltage level of the power supply required by the heat pumpfloat[V]{0.0…n}

get_database_components_conversion_hydraulic_pumps

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/HYDRAULIC_PUMPS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
descriptionDescribes the source of the benchmark standards.stringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
unitunit of the min/max capacitystringNAalphanumeric

get_database_components_conversion_photovoltaic_panels

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/PHOTOVOLTAIC_PANELS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization, photovoltaic
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloatNA{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
descriptionDescribes the source of the benchmark standards.stringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
misc_losseslosses from cabling, resistances etc…float[-]{0.0…1.0}
module_length_mlengh of the PV modulefloat[m]{0.0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
PV_a0parameters for air mass modifier, f(x) = a0 + a1x + a2x2 + a3*x3 + a4*x**4, where x is the relative air massfloat[-]{n…n}
PV_a1parameters for air mass modifier, f(x) = a0 + a1x + a2x2 + a3*x3 + a4*x**4, where x is the relative air massfloat[-]{-0.1…0.1}
PV_a2parameters for air mass modifier, f(x) = a0 + a1x + a2x2 + a3*x3 + a4*x**4, where x is the relative air massfloat[-]{-0.1…0.1}
PV_a3parameters for air mass modifier, f(x) = a0 + a1x + a2x2 + a3*x3 + a4*x**4, where x is the relative air massfloat[-]{-0.1…0.1}
PV_a4parameters for air mass modifier, f(x) = a0 + a1x + a2x2 + a3*x3 + a4*x**4, where x is the relative air massfloat[-]{-0.1…0.1}
PV_Brefcell maximum power temperature coefficientfloat[1/C]{0.0…1.0}
PV_nnominal efficiencyfloat[-]{0.0…n}
PV_noctnominal operating cell temperaturefloat[C]{0.0…n}
PV_thglazing thicknessfloat[m]{0.0…n}
typeredundantstringNA{PV}
unitunit of the min/max capacitystringNAalphanumeric

get_database_components_conversion_photovoltaic_thermal_panels

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/PHOTOVOLTAIC_THERMAL_PANELS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization, photovoltaic_thermal
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
descriptionDescribes the type of photovoltaic thermal technologystringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
unitunit of the min/max capacitystringNAalphanumeric

get_database_components_conversion_power_transformers

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/POWER_TRANSFORMERS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloatNA{0.0…n}
cap_minminimum capacityfloatNA{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
current_form_highVform of the current on the high voltage side, i.e. ‘AC’ or ‘DC’.stringNA{AC, DC}
current_form_lowVform of the current on the low voltage side, i.e. ‘AC’ or ‘DC’.stringNA{AC, DC}
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
descriptionDescribes the type of power transformerstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
typetype of power transformerstringNA{small interconnection transformer, medium interconnection transformer, large interconnection transformer}
unitunit of the min/max capacitystringNAalphanumeric
V_max_highV_sidemaximum voltage that can be applied to the high voltage sidefloat[V]{n…n}
V_max_lowV_sidemaximum voltage that can be applied to the low voltage sidefloat[V]{n…n}
V_min_highV_sideminimum voltage that can be applied to the high voltage sidefloat[V]{n…n}
V_min_lowV_sideminimum voltage that can be applied to the low voltage sidefloat[V]{n…n}

get_database_components_conversion_solar_collectors

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/SOLAR_COLLECTORS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization, photovoltaic_thermal
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
aperture_area_ratioratio of aperture area to panel areafloat[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
c1collector heat loss coefficient at zero temperature difference and wind speedfloat[W/M2k]{0.0…n}
c2ctemperature difference dependency of the heat loss coefficientfloat[W/m2K2]{0.0…n}
C_effthermal capacity of modulefloat[J/m2k]{0.0…n}
cap_maxmaximum capacityfloat[m2]{0.0…n}
cap_minminimum capacityfloat[m2]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
Cp_fluidheat capacity of the heat transfer fluidfloat[J/kgK]{0.0…n}
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
descriptionDescribes the type of solar collectorstringNAalphanumeric
dP1pressure drop at zero flow ratefloat[Pa/m2]{0.0…n}
dP2pressure drop at nominal flow rate (mB0)float[Pa/m2]{0.0…n}
dP3pressure drop at maximum flow rate (mB_max)float[Pa/m2]{0.0…n}
dP4pressure drop at minimum flow rate (mB_min)float[Pa/m2]{0.0…n}
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
IAM_dincident angle modifier for diffuse radiationfloat[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
mB0_rnominal flow rate per aperture areafloat[kg/m2/hr]{0.0…n}
mB_max_rmaximum flow rate per aperture areafloat[kg/m2/hr]{0.0…n}
mB_min_rminimum flow rate per aperture areafloat[kg/m2/hr]{0.0…n}
module_area_m2module area of a solar collectorfloat[m2]{0.0…n}
module_length_mlengh of a solar collector modulefloat[m]{0.0…n}
n0zero loss efficiency at normal incidencefloat[-]{0.0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
t_maxmaximum operating temperaturefloat[C]{0.0…n}
typetype of the solar collector (FP: flate-plate or ET: evacuated-tube)stringNA{FP, ET}
unitunit of the min/max capacitystringNAalphanumeric

get_database_components_conversion_thermal_energy_storages

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/THERMAL_ENERGY_STORAGES.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
assumptionitems made by assumptions in this storage technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
C_mat_%Working fluid replacement cost factor (fraction of the investment cost)float[-]{0.0…n}
cap_maxmaximum capacityfloat[m3 or kWh]{0.0…n}
cap_minminimum capacityfloat[m3 or kWh]{0.0…n}
codeUnique code that identifies the thermal energy storage technologystring[-]alphanumeric
Cp_kJkgKheat capacity of working fluidfloat[kJ/kg.K]{0.0…n}
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
descriptionDescribes the thermal energy storage technologystring[-]alphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
HL_kJkgLantent heat of working fluid at phase change temperaturefloat[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_mat_yrlifetime of the working fluid of this storage technologyint[yr]{0…n}
LT_yrlifetime of this storage technologyint[yr]{0…n}
n_chaverage charging efficiency of the thermal storagefloat[-]{n…n}
n_dischaverage discharging efficiency of the thermal storagefloat[-]{n…n}
O&M_%operation and maintnance cost factor (fraction of the investment cost)float[-]{0.0…n}
Rho_T_PHCH_kgm3Density of working fluid at phase change temperaturefloat[-]{0.0…n}
T_max_CMaximum temperature of working fluid at full dischargefloat[-]{0.0…n}
T_min_CMinimum temperature of working fluid at full chargefloat[-]{-10.0…90.0}
T_PHCH_CPhase change temperature of working fluidfloat[-]{0.0…n}
typecode that identifies whether the storage is used for heating or cooling (different properties of the transport media)string[-]{COOLING, HEATING}
unitunit which describes the minimum and maximum capacitystringNAalphanumeric

get_database_components_conversion_unitary_air_conditioners

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/UNITARY_AIR_CONDITIONERS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
descriptiondescribes the air conditioner unitstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
rated_COP_seasonalminimum seasonal coefficient of performance of the air conditionerfloat[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
T_air_indoor_ratingaverage indoor temperature under rating conditions (i.e. conditions used to determine rated COP)float[°C]{n…n}
T_air_outdoor_ratingaverage outdoor temperature under rating conditions (i.e. conditions used to determine rated COP)float[°C]{n…n}
typeType of air conditioner, expressed by its layoutstringNAalphanumeric
unitunit of the min/max capacitystringNAalphanumeric
V_power_supplyvoltage of the power supply required by the air conditionerfloat[V]{0.0…n}

get_database_components_conversion_vapor_compression_chillers

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/CONVERSION/VAPOR_COMPRESSION_CHILLERS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, optimization
VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
descriptionDescribes the source of the benchmark standards.stringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
min_eff_ratingMinimum efficiency rating according to prevalent standards or manufacturer catalogues, expressed as a COP.float[W_th/W_el]{0.0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
T_cond_designdesign temperature of the outflowing water or air at the condenserfloat[°C]{0.0…n}
T_evap_designdesign temperature of the outflowing water at the evaporatorfloat[°C]{0.0…n}
typeType of vapor compression chiller expressed by its working principle.stringNAalphanumeric
unitunit of the min/max capacitystringNAalphanumeric
V_power_supplyvoltage of the power supply under design conditionsfloat[V]{0.0…n}

get_database_components_distribution_thermal_grid

  • Path: inputs/database/COMPONENTS/DISTRIBUTION/THERMAL_GRID.csv
  • File type: csv
  • Created by: database_helper
  • Used by: optimization, thermal_network
VariableDescriptionTypeUnitValues
codepipe ID from the manufacturerstringNAalphanumeric
D_ext_mexternal pipe diameter tolerance for the nominal diameter (DN)float[m]{0.0…n}
D_ins_mmaximum pipe diameter tolerance for the nominal diameter (DN)float[m]{0.0…n}
D_int_minternal pipe diameter tolerance for the nominal diameter (DN)float[m]{0.0…n}
Inv_USD2015permTypical cost of investment for a given pipe diameter.float[$/m]{0.0…n}
pipe_DNNominal pipe diameterfloat[-]{0.0…n}
Vdot_max_m3smaximum volumetric flow rate for the nominal diameter (DN)float[m3/s]{0.0…n}
Vdot_min_m3sminimum volumetric flow rate for the nominal diameter (DN)float[m3/s]{0.0…n}

get_database_components_feedstocks_biogas

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/FEEDSTOCKS/FEEDSTOCKS_LIBRARY/BIOGAS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, emissions, system_costs, optimization
VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

get_database_components_feedstocks_coal

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/FEEDSTOCKS/FEEDSTOCKS_LIBRARY/COAL.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, emissions, system_costs, optimization
VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

get_database_components_feedstocks_drybiomass

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/FEEDSTOCKS/FEEDSTOCKS_LIBRARY/DRYBIOMASS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, emissions, system_costs, optimization
VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

get_database_components_feedstocks_energy_carriers

  • Path: inputs/database/COMPONENTS/FEEDSTOCKS/ENERGY_CARRIERS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, emissions, system_costs, optimization
VariableDescriptionTypeUnitValues
codeshort code summarising the type (e.g. ‘T’) + the mean qualifier (e.g. ‘100’) + descriptor (e.g. ‘H’)stringNAalphanumeric
descriptionwritten description of the energy carrierstringNAalphanumeric
feedstock_filereference to the file in the feedstock library containing cost and emissions of this energy carrierstringNAalphanumeric
mean_qualmean value of the qualifier corresponding to the respective energy carrierfloatNA{n…n}
qualifiercriterion differentiating energy carriers of the same typestringNA{chemical composition, voltage, wavelength, temperature}
referencereferences to documents and articles values in the table were taken fromstringNAalphanumeric
subtypesubtype characterising variation of an energy typestringNA{AC, air, biofuel, water, fossil, -}
typetype of energy characterising the energy carrierstringNA{chemical, electrical, radiation, thermal}
unit_qualSI unit of the qualifier (if any)stringNAalphanumeric

get_database_components_feedstocks_grid

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/FEEDSTOCKS/FEEDSTOCKS_LIBRARY/GRID.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, emissions, system_costs, optimization
VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

get_database_components_feedstocks_hydrogen

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/FEEDSTOCKS/FEEDSTOCKS_LIBRARY/HYDROGEN.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, emissions, system_costs, optimization
VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

get_database_components_feedstocks_naturalgas

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/FEEDSTOCKS/FEEDSTOCKS_LIBRARY/NATURALGAS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, emissions, system_costs, optimization
VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

get_database_components_feedstocks_oil

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/FEEDSTOCKS/FEEDSTOCKS_LIBRARY/OIL.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, emissions, system_costs, optimization
VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

get_database_components_feedstocks_solar

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/FEEDSTOCKS/FEEDSTOCKS_LIBRARY/SOLAR.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, emissions, system_costs, optimization
VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

get_database_components_feedstocks_wetbiomass

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/FEEDSTOCKS/FEEDSTOCKS_LIBRARY/WETBIOMASS.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, emissions, system_costs, optimization
VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

get_database_components_feedstocks_wood

⚠️ Stale: no matching InputLocator method exists for this name — safe to remove from cea/schemas.yml.

  • Path: inputs/database/COMPONENTS/FEEDSTOCKS/FEEDSTOCKS_LIBRARY/WOOD.csv
  • File type: csv
  • Created by: database_helper
  • Used by: decentralized, emissions, system_costs, optimization
VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

get_database_construction_standards

⚠️ Stale: no matching InputLocator method exists, but the locator name is still referenced by string in cea/datamanagement/databases_verification.py. Removing this from schemas.yml will also require updating that reference.

  • Path: inputs/technology/archetypes/CONSTRUCTION_STANDARDS.xlsx
  • File type: xlsx
  • Created by: database_helper
  • Used by: archetypes_mapper

Worksheet: ENVELOPE_ASSEMBLIES

VariableDescriptionTypeUnitValues
EsFraction of gross floor area with electrical demands.float[m2/m2]{0.0…1.0}
HsFraction of gross floor area air-conditioned.float[m2/m2]{0.0…1.0}
NsFraction of net gross floor area.float[m2/m2]{0.0…1.0}
occupied_bgWhether the basement is occupied/conditioned.boolean[-]{true, false}
STANDARDUnique ID of Construction Standardstring[-]alphanumeric
type_baseBasement floor construction assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_consType of construction assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_floorInternal floor construction assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_leakTightness level assembly (relates to “code” in ENVELOPE assemblies)string[-]alphanumeric
type_partInternal partitions construction assembly (relates to “code” in ENVELOPE assemblies)stringNAalphanumeric
type_roofRoof construction assembly (relates to “code” in ENVELOPE assemblies)stringNAalphanumeric
type_shadeShading system assembly (relates to “code” in ENVELOPE assemblies)stringNAalphanumeric
type_wallExternal wall construction assembly (relates to “code” in ENVELOPE assemblies)stringNAalphanumeric
type_winWindow assembly (relates to “code” in ENVELOPE assemblies)stringNAalphanumeric
wwr_eastWindow to wall ratio in in facades facing eastfloat[m2/m2]{0.0…1.0}
wwr_northWindow to wall ratio in in facades facing northfloat[m2/m2]{0.0…1.0}
wwr_southWindow to wall ratio in in facades facing southfloat[m2/m2]{0.0…1.0}
wwr_westWindow to wall ratio in in facades facing westfloat[m2/m2]{0.0…1.0}

Worksheet: HVAC_ASSEMBLIES

VariableDescriptionTypeUnitValues
cool_endsEnd of the cooling season - use 00|00 when there is nonestring`[DDMM]`
cool_startsStart of the cooling season - use 00|00 when there is nonestring`[DDMM]`
heat_endsEnd of the heating season - use 00|00 when there is nonestring`[DDMM]`
heat_startsStart of the heating season - use 00|00 when there is nonestring`[DDMM]`
STANDARDUnique ID of Construction StandardstringNAalphanumeric
type_csType of cooling HVAC assembly (relates to “code” in HVAC assemblies)stringNAalphanumeric
type_ctrlType of heating and cooling control HVAC assembly (relates to “code” in HVAC assemblies)stringNAalphanumeric
type_dhwType of hot water HVAC assembly (relates to “code” in HVAC assemblies)stringNAalphanumeric
type_hsType of heating HVAC assembly (relates to “code” in HVAC assemblies)stringNAalphanumeric
type_ventType of ventilation HVAC assembly (relates to “code” in HVAC assemblies)stringNAalphanumeric

Worksheet: STANDARD_DEFINITION

VariableDescriptionTypeUnitValues
DescriptionDescription of the construction standardstringNAalphanumeric
STANDARDUnique ID of Construction StandardstringNAalphanumeric
YEAR_ENDUpper limit of year interval where the building properties applyint[-]{0…n}
YEAR_STARTLower limit of year interval where the building properties applyint[-]{0…n}

Worksheet: SUPPLY_ASSEMBLIES

VariableDescriptionTypeUnitValues
STANDARDUnique ID of Construction StandardstringNAalphanumeric
type_csType of cooling supply assembly (refers to “code” in SUPPLY assemblies)stringNAalphanumeric
type_dhwType of hot water supply assembly (refers to “code” in SUPPLY assemblies)stringNAalphanumeric
type_elType of electrical supply assembly (refers to “code” in SUPPLY assemblies)stringNAalphanumeric
type_hsType of heating supply assembly (refers to “code” in SUPPLY assemblies)stringNAalphanumeric

get_database_conversion_systems

⚠️ Stale: no matching InputLocator method exists, but the locator name is still referenced by string in cea/datamanagement/databases_verification.py. Removing this from schemas.yml will also require updating that reference.

  • Path: inputs/technology/components/CONVERSION.xlsx
  • File type: xls
  • Created by: database_helper
  • Used by: decentralized, optimization, photovoltaic, photovoltaic_thermal, solar_collector

Worksheet: ABSORPTION_CHILLERS

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
a_eparameter in the characteristic equations to calculate the evaporator sidefloat[-]{n…n}
a_gparameter in the characteristic equations to calculate the generator sidefloat[-]{n…n}
assumptionitems made by assumptions in this technologystring[-]alphanumeric
aux_powerauxiliary electrical power supply for pumping of fluids (expressed as share of cooling produced)float[-]{0.0…n}
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
Descriptiondescribes the Type of Absorption ChillerstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
e_eparameter in the characteristic equations to calculate the evaporator sidefloat[-]{0.0…n}
e_gparameter in the characteristic equations to calculate the generator sidefloat[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
m_cwexternal flow rate of cooling water at the condenser and absorberfloat[kg/s]{0.0…n}
m_hwexternal flow rate of hot water at the generatorfloat[kg/s]{0.0…n}
min_eff_ratingMinimum efficiency rating according to prevalent standards or manufacturer catalogues, expressed as a COP.float[W_th/W_el]{0.0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
r_eparameter in the characteristic equations to calculate the evaporator sidefloat[-]{n…n}
r_gparameter in the characteristic equations to calculate the generator sidefloat[-]{n…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
s_eparameter in the characteristic equations to calculate the evaporator sidefloat[kW/K]{0.0…n}
s_gparameter in the characteristic equations to calculate the generator sidefloat[-]{0.0…n}
T_cond_designdesign temperature of the outflowing water or air at the condenserfloat[°C]{0.0…n}
T_evap_designdesign temperature of the outflowing water at the evaporatorfloat[°C]{0.0…n}
T_gen_designdesign temperature of the inflowing water or steam at the generatorfloat[°C]{0.0…n}
typetype of absorption chillerstringNA{single, double, triple}
unitunit of the min/max capacitystringNAalphanumeric
V_power_supplyvoltage of the power supply under design conditionsfloat[V]{0.0…n}

Worksheet: BOILERS

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost functionstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
Descriptiondescribes the type of boilerstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
fuel_codecode of the combustible energy carrier used by the boiler (matching code in EnergyCarriers database)stringNAalphanumeric
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
min_eff_ratingminimum thermal efficiency rating of the boilerfloat[-]{n…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
T_flue_gas_designoutflowing flue gas temperature as designed by the manufacturerfloat[°C]{n…n}
T_water_in_ratingaverage inflowing water temperature of the boiler under rating conditions (i.e. conditions used for determining rated efficiency)float[°C]{n…n}
T_water_out_ratingaverage outflowing water temperature of the boiler under rating conditions (i.e. conditions used for determining rated efficiency)float[°C]{n…n}
typetype of boilerstringNA{gas, oil, gas-cond}
unitunit of the min/max capacitystringNAalphanumeric

Worksheet: BORE_HOLES

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost functionstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
Descriptiondescribes the type of borehole heat exchangerstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)floatNA{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
unitunit of the min/max capacitystringNAalphanumeric

Worksheet: COGENERATION_PLANTS

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
Descriptiondescribes the type of combined-cycle gas turbinestringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
elec_eff_designelectrical efficiency rating of the cogen plant under design conditionsfloat[-]{0.0…n}
fuel_codecode of the combustible energy carrier used by the cogeneration plant (matching code in EnergyCarriers database)stringNAalphanumeric
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
T_flue_gas_designaverage temperature of the emitted flue gas when the cogen plant is operated as designed by the manufacturerfloat[°C]{n…n}
T_water_out_designaverage temperature of the hot water generated by the cogen plant as designed by the manufacturerfloat[°C]{n…n}
therm_eff_designthermal efficiency rating of the cogen plant under design conditionsfloat[-]{0.0…n}
typetype of cogeneration plant (given by its combustion component)stringNA{engine, bio-engine, furnace, turbine}
unitunit of the min/max capacitystringNAalphanumeric
V_power_out_designvoltage level of the power generated by the cogen plant as designed by the manufacturerfloat[V]{n…n}

Worksheet: COOLING_TOWERS

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
aux_powerpower required to operate fans, pumps and water treatment devices (expressed as percentage of total heat rejection)float[-]{n…n}
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
Descriptiondescribes the type of cooling towerstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
T_air_in_designaverage dry-bulb air temperature flowing into the cooling tower when it is operated as designed by the manufacturerfloat[°C]{n…n}
T_water_in_designaverage temperature of the water supply to the cooling tower as designed by the manufacturerfloat[°C]{n…n}
T_water_out_designaverage return temperature of the water exiting the cooling tower as designed by the manufacturerfloat[°C]{n…n}
typetype of cooling towerstringNA{open-circuit, closed-circuit}
unitunit of the min/max capacitystringNAalphanumeric
V_power_supplyvoltage level of the power supply for the cooling tower as designed by the manufacturerfloat[V]{n…n}

Worksheet: FUEL_CELLS

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
DescriptionDescribes the type of fuel cellstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
unitunit of the min/max capacitystringNAalphanumeric

Worksheet: HEAT_EXCHANGERS

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
a_pparameter in the pressure loss function, f(x) = a_p + b_px^c_p + d_pln(x) + e_pxln*(x), where x is the capacity mass flow rate [W/K]float[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
b_pparameter in the pressure loss function, f(x) = a_p + b_px^c_p + d_pln(x) + e_pxln*(x), where x is the capacity mass flow rate [W/K]float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
c_pparameter in the pressure loss function, f(x) = a_p + b_px^c_p + d_pln(x) + e_pxln*(x), where x is the capacity mass flow rate [W/K]float[-]{0.0…n}
cap_maxmaximum capacityfloatNA{0.0…n}
cap_minminimum capacityfloatNA{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
d_pparameter in the pressure loss function, f(x) = a_p + b_px^c_p + d_pln(x) + e_pxln*(x), where x is the capacity mass flow rate [W/K]float[-]{n…n}
DescriptionDescribes the type of heat exchangerstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
e_pparameter in the pressure loss function, f(x) = a_p + b_px^c_p + d_pln(x) + e_pxln*(x), where x is the capacity mass flow rate [W/K]float[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
medium_inthermal energy carrier subtype (i.e. type of fluid) on the hot side of the heat exchangerstringNA{water, air, brine}
medium_outthermal energy carrier subtype (i.e. type of fluid) on the cold side of the heat exchangerstringNA{water, air, brine}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
T_max_operatingmaximum operating temperature of the heat exchangerfloat[°C]{n…n}
T_min_operatingminimum operating temperature of the heat exchangerfloat[°C]{n…n}
typetype of heat exchangerstringNA{counter-flow, plate, concurrent flow, tube}
unitunit of the min/max capacitystringNAalphanumeric

Worksheet: HEAT_PUMPS

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
DescriptionDescribes the source of the heat pumpstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
medium_cond_sidethermal energy carrier subtype (i.e. type of fluid) on the condenser side of the heat pumpstringNA{water, air, brine}
medium_evap_sidethermal energy carrier subtype (i.e. type of fluid) on the evaporator side of the heat pumpstringNA{water, air, brine}
min_eff_rating_seasonalminimum seasonal efficiency rating of the heat pumpfloat[-]{0.0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
T_cond_designaverage temperature of the condenser-side of the heat pump if it is operated as designed by the manufacturerfloat[°C]{n…n}
T_evap_designaverage temperature of the evaporator-side of the heat pump if it is operated as designed by the manufacturerfloat[°C]{n…n}
typetype of heat pumpstringNA{geothermal, air-source, water-source}
unitunit of the min/max capacitystringNAalphanumeric
V_power_supplyvoltage level of the power supply required by the heat pumpfloat[V]{0.0…n}

Worksheet: HYDRAULIC_PUMPS

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
DescriptionDescribes the source of the benchmark standards.stringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
unitunit of the min/max capacitystringNAalphanumeric

Worksheet: PHOTOVOLTAIC_PANELS

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloatNA{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
DescriptionDescribes the source of the benchmark standards.stringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
misc_losseslosses from cabling, resistances etc…float[-]{0.0…1.0}
module_length_mlengh of the PV modulefloat[m]{0.0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
PV_a0parameters for air mass modifier, f(x) = a0 + a1x + a2x2 + a3*x3 + a4*x**4, where x is the relative air massfloat[-]{n…n}
PV_a1parameters for air mass modifier, f(x) = a0 + a1x + a2x2 + a3*x3 + a4*x**4, where x is the relative air massfloat[-]{-0.1…0.1}
PV_a2parameters for air mass modifier, f(x) = a0 + a1x + a2x2 + a3*x3 + a4*x**4, where x is the relative air massfloat[-]{-0.1…0.1}
PV_a3parameters for air mass modifier, f(x) = a0 + a1x + a2x2 + a3*x3 + a4*x**4, where x is the relative air massfloat[-]{-0.1…0.1}
PV_a4parameters for air mass modifier, f(x) = a0 + a1x + a2x2 + a3*x3 + a4*x**4, where x is the relative air massfloat[-]{-0.1…0.1}
PV_Brefcell maximum power temperature coefficientfloat[1/C]{0.0…1.0}
PV_nnominal efficiencyfloat[-]{0.0…n}
PV_noctnominal operating cell temperaturefloat[C]{0.0…n}
PV_thglazing thicknessfloat[m]{0.0…n}
typeredundantstringNA{PV}
unitunit of the min/max capacitystringNAalphanumeric

Worksheet: PHOTOVOLTAIC_THERMAL_PANELS

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
DescriptionDescribes the type of photovoltaic thermal technologystringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
unitunit of the min/max capacitystringNAalphanumeric

Worksheet: POWER_TRANSFORMERS

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloatNA{0.0…n}
cap_minminimum capacityfloatNA{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
current_form_highVform of the current on the high voltage side, i.e. ‘AC’ or ‘DC’.stringNA{AC, DC}
current_form_lowVform of the current on the low voltage side, i.e. ‘AC’ or ‘DC’.stringNA{AC, DC}
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
DescriptionDescribes the type of power transformerstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
typetype of power transformerstringNA{small interconnection transformer, medium interconnection transformer, large interconnection transformer}
unitunit of the min/max capacitystringNAalphanumeric
V_max_highV_sidemaximum voltage that can be applied to the high voltage sidefloat[V]{n…n}
V_max_lowV_sidemaximum voltage that can be applied to the low voltage sidefloat[V]{n…n}
V_min_highV_sideminimum voltage that can be applied to the high voltage sidefloat[V]{n…n}
V_min_lowV_sideminimum voltage that can be applied to the low voltage sidefloat[V]{n…n}

Worksheet: SOLAR_THERMAL_PANELS

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
aperture_area_ratioratio of aperture area to panel areafloat[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
c1collector heat loss coefficient at zero temperature difference and wind speedfloat[W/M2k]{0.0…n}
c2ctemperature difference dependency of the heat loss coefficientfloat[W/m2K2]{0.0…n}
C_effthermal capacity of modulefloat[J/m2k]{0.0…n}
cap_maxmaximum capacityfloat[m2]{0.0…n}
cap_minminimum capacityfloat[m2]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
Cp_fluidheat capacity of the heat transfer fluidfloat[J/kgK]{0.0…n}
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
DescriptionDescribes the type of solar collectorstringNAalphanumeric
dP1pressure drop at zero flow ratefloat[Pa/m2]{0.0…n}
dP2pressure drop at nominal flow rate (mB0)float[Pa/m2]{0.0…n}
dP3pressure drop at maximum flow rate (mB_max)float[Pa/m2]{0.0…n}
dP4pressure drop at minimum flow rate (mB_min)float[Pa/m2]{0.0…n}
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
IAM_dincident angle modifier for diffuse radiationfloat[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
mB0_rnominal flow rate per aperture areafloat[kg/m2/hr]{0.0…n}
mB_max_rmaximum flow rate per aperture areafloat[kg/m2/hr]{0.0…n}
mB_min_rminimum flow rate per aperture areafloat[kg/m2/hr]{0.0…n}
module_area_m2module area of a solar collectorfloat[m2]{0.0…n}
module_length_mlengh of a solar collector modulefloat[m]{0.0…n}
n0zero loss efficiency at normal incidencefloat[-]{0.0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
t_maxmaximum operating temperaturefloat[C]{0.0…n}
typetype of the solar collector (FP: flate-plate or ET: evacuated-tube)stringNA{FP, ET}
unitunit of the min/max capacitystringNAalphanumeric

Worksheet: THERMAL_ENERGY_STORAGES

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
assumptionitems made by assumptions in this storage technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{0.0…n}
C_mat_%Working fluid replacement cost factor (fraction of the investment cost)float[-]{0.0…n}
cap_maxmaximum capacityfloat[m3 or kWh]{0.0…n}
cap_minminimum capacityfloat[m3 or kWh]{0.0…n}
codeUnique code that identifies the thermal energy storage technologystring[-]alphanumeric
Cp_kJkgKheat capacity of working fluidfloat[kJ/kg.K]{0.0…n}
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
DescriptionDescribes the thermal energy storage technologystring[-]alphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x), where x is the capacityfloat[-]{n…n}
HL_kJkgLantent heat of working fluid at phase change temperaturefloat[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_mat_yrlifetime of the working fluid of this storage technologyint[yr]{0…n}
LT_yrlifetime of this storage technologyint[yr]{0…n}
n_chaverage charging efficiency of the thermal storagefloat[-]{n…n}
n_dischaverage discharging efficiency of the thermal storagefloat[-]{n…n}
O&M_%operation and maintnance cost factor (fraction of the investment cost)float[-]{0.0…n}
Rho_T_PHCH_kgm3Density of working fluid at phase change temperaturefloat[-]{0.0…n}
T_max_CMaximum temperature of working fluid at full dischargefloat[-]{0.0…n}
T_min_CMinimum temperature of working fluid at full chargefloat[-]{-10.0…90.0}
T_PHCH_CPhase change temperature of working fluidfloat[-]{0.0…n}
typecode that identifies whether the storage is used for heating or cooling (different properties of the transport media)string[-]{COOLING, HEATING}
unitunit which describes the minimum and maximum capacitystringNAalphanumeric

Worksheet: UNITARY_AIR_CONDITIONERS

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
Descriptiondescribes the air conditioner unitstringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
min_eff_ratingMinimum efficiency rating according to prevalent standards or manufacturer catalogues, expressed as a COP.float[W_th/W_el]{0.0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
rated_COP_seasonalminimum seasonal coefficient of performance of the air conditionerfloat[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
T_air_indoor_ratingaverage indoor temperature under rating conditions (i.e. conditions used to determine rated COP)float[°C]{n…n}
T_air_outdoor_ratingaverage outdoor temperature under rating conditions (i.e. conditions used to determine rated COP)float[°C]{n…n}
typeType of air conditioner, expressed by its layoutstringNAalphanumeric
unitunit of the min/max capacitystringNAalphanumeric
V_power_supplyvoltage of the power supply required by the air conditionerfloat[V]{0.0…n}

Worksheet: VAPOR_COMPRESSION_CHILLERS

VariableDescriptionTypeUnitValues
aparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
assumptionitems made by assumptions in this technologystringNAalphanumeric
bparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
cap_maxmaximum capacityfloat[W]{0.0…n}
cap_minminimum capacityfloat[W]{0.0…n}
codeidentifier of each unique equipmentstringNAalphanumeric
currencycurrency-year information of the investment cost function, should be unified to USDstringNAalphanumeric
dparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{n…n}
DescriptionDescribes the source of the benchmark standards.stringNAalphanumeric
eparameter in the investment cost function, f(x) = a + bx^c + dln(x) + exln*(x)float[-]{0.0…n}
IR_%interest rate charged on the loan for the capital costfloat[-]{0.0…n}
LT_yrlifetime of this technologyint[yr]{0…n}
min_eff_ratingMinimum efficiency rating according to prevalent standards or manufacturer catalogues, expressed as a COP.float[W_th/W_el]{0.0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[-]{0.0…n}
referencesources of some of the parameters in this data-tablestringNAalphanumeric
T_cond_designdesign temperature of the outflowing water or air at the condenserfloat[°C]{0.0…n}
T_evap_designdesign temperature of the outflowing water at the evaporatorfloat[°C]{0.0…n}
typeType of vapor compression chiller expressed by its working principle.stringNAalphanumeric
unitunit of the min/max capacitystringNAalphanumeric
V_power_supplyvoltage of the power supply under design conditionsfloat[V]{0.0…n}

get_database_distribution_systems

⚠️ Stale: no matching InputLocator method exists, but the locator name is still referenced by string in cea/datamanagement/databases_verification.py. Removing this from schemas.yml will also require updating that reference.

  • Path: inputs/technology/components/DISTRIBUTION.xlsx
  • File type: xls
  • Created by: database_helper
  • Used by: optimization, thermal_network

Worksheet: THERMAL_GRID

VariableDescriptionTypeUnitValues
codepipe ID from the manufacturerstringNAalphanumeric
D_ext_mexternal pipe diameter tolerance for the nominal diameter (DN)float[m]{0.0…n}
D_ins_mmaximum pipe diameter tolerance for the nominal diameter (DN)float[m]{0.0…n}
D_int_minternal pipe diameter tolerance for the nominal diameter (DN)float[m]{0.0…n}
Inv_USD2015permTypical cost of investment for a given pipe diameter.float[$/m]{0.0…n}
Pipe_DNNominal pipe diameterfloat[-]{0.0…n}
Vdot_max_m3smaximum volumetric flow rate for the nominal diameter (DN)float[m3/s]{0.0…n}
Vdot_min_m3sminimum volumetric flow rate for the nominal diameter (DN)float[m3/s]{0.0…n}

get_database_envelope_systems

⚠️ Stale: no matching InputLocator method exists, but the locator name is still referenced by string in cea/datamanagement/databases_verification.py. Removing this from schemas.yml will also require updating that reference.

  • Path: inputs/technology/assemblies/ENVELOPE.xlsx
  • File type: xls
  • Created by: database_helper
  • Used by: demand, radiation

Worksheet: CONSTRUCTION

VariableDescriptionTypeUnitValues
Cm_AfInternal heat capacity per unit of air conditioned area. Defined according to ISO 13790.float[J/Km2]{0.0…n}
codeType of constructionstringNAalphanumeric
DescriptionDescribes the Type of constructionstringNAalphanumeric

Worksheet: FLOOR

VariableDescriptionTypeUnitValues
codeType of roofstringNAalphanumeric
DescriptionDescribes the Type of roofstringNAalphanumeric
GHG_biogenic_floor_kgCO2m2Biogenic carbon storage per m2 of floor.(entire building life cycle)float[kg CO2-eq/m2]{n…0.0}
GHG_floor_kgCO2m2Embodied emissions per m2 of floor.(entire building life cycle)float[kg CO2-eq/m2]{0.0…n}
U_baseThermal transmittance of floor including linear losses (+10%). Defined according to ISO 13790.float[-]{0.1…n}

Worksheet: ROOF

VariableDescriptionTypeUnitValues
a_roofSolar absorption coefficient. Defined according to ISO 13790.float[-]{0.0…1.0}
codeType of roofstringNAalphanumeric
DescriptionDescribes the Type of roofstringNAalphanumeric
e_roofEmissivity of external surface. Defined according to ISO 13790.float[-]{0.0…1.0}
GHG_biogenic_roof_kgCO2m2Biogenic carbon storage per m2 of roof.(entire building life cycle)float[kg CO2-eq/m2]{n…0.0}
GHG_roof_kgCO2m2Embodied emissions per m2 of roof.(entire building life cycle)float[kg CO2-eq/m2]{0.0…n}
r_roofReflectance in the Red spectrum. Defined according Radiance. (long-wave)float[-]{0.0…1.0}
U_roofThermal transmittance of windows including linear losses (+10%). Defined according to ISO 13790.float[-]{0.1…n}

Worksheet: SHADING

VariableDescriptionTypeUnitValues
codeType of shadingstringNAalphanumeric
DescriptionDescribes the source of the benchmark standards.stringNAalphanumeric
rf_shShading coefficient when shading device is active. Defined according to ISO 13790.float[-]{0.0…1.0}

Worksheet: TIGHTNESS

VariableDescriptionTypeUnitValues
codeType of tightnessstringNAalphanumeric
DescriptionDescribes the Type of tightnessstringNAalphanumeric
n50Air exchanges per hour at a pressure of 50 Pa.float[1/h]{0.0…10.0}

Worksheet: WALL

VariableDescriptionTypeUnitValues
a_wallSolar absorption coefficient. Defined according to ISO 13790.float[-]{0.0…1.0}
codeType of wallstringNAalphanumeric
DescriptionDescribes the Type of wallstringNAalphanumeric
e_wallEmissivity of external surface. Defined according to ISO 13790.float[-]{0.0…1.0}
GHG_biogenic_wall_kgCO2m2Biogenic carbon storage per m2 of walls (entire building life cycle)float[kg CO2-eq/m2]{n…0.0}
GHG_wall_kgCO2m2Embodied emissions per m2 of walls (entire building life cycle)float[kg CO2-eq/m2]{0.0…n}
r_wallReflectance in the Red spectrum. Defined according Radiance. (long-wave)float[-]{0.0…1.0}
U_wallThermal transmittance of windows including linear losses (+10%). Defined according to ISO 13790.float[-]{0.1…n}

Worksheet: WINDOW

VariableDescriptionTypeUnitValues
codeWindow type code to relate to other databasesstringNAalphanumeric
DescriptionDescribes the source of the benchmark standards.stringNAalphanumeric
e_winEmissivity of external surface. Defined according to ISO 13790.float[-]{0.0…1.0}
F_FWindow frame fraction coefficient. Defined according to ISO 13790.float[m2-frame/m2-window]{0.0…1.0}
G_winSolar heat gain coefficient. Defined according to ISO 13790.float[-]{0.0…1.0}
GHG_biogenic_win_kgCO2m2Biogenic carbon storage per m2 of windows.(entire building life cycle)float[kg CO2-eq/m2]{n…0.0}
GHG_win_kgCO2m2Embodied emissions per m2 of windows.(entire building life cycle)float[kg CO2-eq/m2]{0.0…n}
U_winThermal transmittance of windows including linear losses (+10%). Defined according to ISO 13790.float[-]{0.1…n}

get_database_feedstocks

⚠️ Stale: no matching InputLocator method exists, but the locator name is still referenced by string in cea/datamanagement/databases_verification.py. Removing this from schemas.yml will also require updating that reference.

  • Path: inputs/technology/components/FEEDSTOCKS.xlsx
  • File type: xls
  • Created by: database_helper
  • Used by: decentralized, emissions, system_costs, optimization

Worksheet: BIOGAS

VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

Worksheet: COAL

VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

Worksheet: DRYBIOMASS

VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

Worksheet: ENERGY_CARRIERS

VariableDescriptionTypeUnitValues
codeshort code summarising the type (e.g. ‘T’) + the mean qualifier (e.g. ‘100’) + descriptor (e.g. ‘H’)stringNAalphanumeric
descriptionwritten description of the energy carrierstringNAalphanumeric
mean_qualmean value of the qualifier corresponding to the respective energy carrierfloatNA{n…n}
qualifiercriterion differentiating energy carriers of the same typestringNA{chemical composition, voltage, wavelength, temperature}
referencereferences to documents and articles values in the table were taken fromstringNAalphanumeric
subtypesubtype characterising variation of an energy typestringNA{AC, air, biofuel, water, fossil, -}
typetype of energy characterising the energy carrierstringNA{chemical, electrical, radiation, thermal}
unit_cost_USD.kWhunit cost of the energy carrierfloat[USD/kWh]{0.0…n}
unit_ghg_kgCO2.kWhgreen house gas intensity of the energy carrierfloat[kgCO2/kWh]{0.0…n}
unit_qualSI unit of the qualifier (if any)stringNAalphanumeric

Worksheet: GRID

VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

Worksheet: NATURALGAS

VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

Worksheet: OIL

VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

Worksheet: SOLAR

VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

Worksheet: WETBIOMASS

VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

Worksheet: WOOD

VariableDescriptionTypeUnitValues
GHG_kgCO2MJNon-renewable Green House Gas Emissions factorfloat[kg CO2-eq/MJ-oil eq]{0.0…n}
hourhour of a 24 hour dayint[-]{0…23}
Opex_var_buy_USD2015kWhbuying pricefloat[USD-2015/kWh]{0.0…n}
Opex_var_sell_USD2015kWhselling pricefloat[USD-2015/kWh]{0.0…n}
referencereferencestringNAalphanumeric

get_database_standard_schedules_use

  • Path: inputs/technology/archetypes/schedules/RESTAURANT.csv
  • File type: schedule
  • Created by: database_helper
  • Used by: archetypes_mapper

Worksheet: APPLIANCES

VariableDescriptionTypeUnitValues
1float{0.0…1.0}
10float{0.0…1.0}
11float{0.0…1.0}
12float{0.0…1.0}
13float{0.0…1.0}
14float{0.0…1.0}
15float{0.0…1.0}
16float{0.0…1.0}
17float{0.0…1.0}
18float{0.0…1.0}
19float{0.0…1.0}
2float{0.0…1.0}
20float{0.0…1.0}
21float{0.0…1.0}
22float{0.0…1.0}
23float{0.0…1.0}
24float{0.0…1.0}
3float{0.0…1.0}
4float{0.0…1.0}
5float{0.0…1.0}
6float{0.0…1.0}
7float{0.0…1.0}
8float{0.0…1.0}
9float{0.0…1.0}
DAYDay of the week (weekday, saturday, or sunday)string{WEEKDAY, SATURDAY, SUNDAY}

Worksheet: COOLING

VariableDescriptionTypeUnitValues
1string{OFF, SETBACK, SETPOINT}
10string{OFF, SETBACK, SETPOINT}
11string{OFF, SETBACK, SETPOINT}
12string{OFF, SETBACK, SETPOINT}
13string{OFF, SETBACK, SETPOINT}
14string{OFF, SETBACK, SETPOINT}
15string{OFF, SETBACK, SETPOINT}
16string{OFF, SETBACK, SETPOINT}
17string{OFF, SETBACK, SETPOINT}
18string{OFF, SETBACK, SETPOINT}
19string{OFF, SETBACK, SETPOINT}
2string{OFF, SETBACK, SETPOINT}
20string{OFF, SETBACK, SETPOINT}
21string{OFF, SETBACK, SETPOINT}
22string{OFF, SETBACK, SETPOINT}
23string{OFF, SETBACK, SETPOINT}
24string{OFF, SETBACK, SETPOINT}
3string{OFF, SETBACK, SETPOINT}
4string{OFF, SETBACK, SETPOINT}
5string{OFF, SETBACK, SETPOINT}
6string{OFF, SETBACK, SETPOINT}
7string{OFF, SETBACK, SETPOINT}
8string{OFF, SETBACK, SETPOINT}
9string{OFF, SETBACK, SETPOINT}
DAYDay of the week (weekday, saturday, or sunday)string{WEEKDAY, SATURDAY, SUNDAY}

Worksheet: ELECTROMOBILITY

VariableDescriptionTypeUnitValues
1Average number of electric vehicles in this hourint{0…10000}
10Average number of electric vehicles in this hourint{0…10000}
11Average number of electric vehicles in this hourint{0…10000}
12Average number of electric vehicles in this hourint{0…10000}
13Average number of electric vehicles in this hourint{0…10000}
14Average number of electric vehicles in this hourint{0…10000}
15Average number of electric vehicles in this hourint{0…10000}
16Average number of electric vehicles in this hourint{0…10000}
17Average number of electric vehicles in this hourint{0…10000}
18Average number of electric vehicles in this hourint{0…10000}
19Average number of electric vehicles in this hourint{0…10000}
2Average number of electric vehicles in this hourint{0…10000}
20Average number of electric vehicles in this hourint{0…10000}
21Average number of electric vehicles in this hourint{0…10000}
22Average number of electric vehicles in this hourint{0…10000}
23Average number of electric vehicles in this hourint{0…10000}
24Average number of electric vehicles in this hourint{0…10000}
3Average number of electric vehicles in this hourint{0…10000}
4Average number of electric vehicles in this hourint{0…10000}
5Average number of electric vehicles in this hourint{0…10000}
6Average number of electric vehicles in this hourint{0…10000}
7Average number of electric vehicles in this hourint{0…10000}
8Average number of electric vehicles in this hourint{0…10000}
9Average number of electric vehicles in this hourint{0…10000}
DAYDay of the week (weekday, saturday, or sunday)string{WEEKDAY, SATURDAY, SUNDAY}

Worksheet: HEATING

VariableDescriptionTypeUnitValues
1string{OFF, SETBACK, SETPOINT}
10string{OFF, SETBACK, SETPOINT}
11string{OFF, SETBACK, SETPOINT}
12string{OFF, SETBACK, SETPOINT}
13string{OFF, SETBACK, SETPOINT}
14string{OFF, SETBACK, SETPOINT}
15string{OFF, SETBACK, SETPOINT}
16string{OFF, SETBACK, SETPOINT}
17string{OFF, SETBACK, SETPOINT}
18string{OFF, SETBACK, SETPOINT}
19string{OFF, SETBACK, SETPOINT}
2string{OFF, SETBACK, SETPOINT}
20string{OFF, SETBACK, SETPOINT}
21string{OFF, SETBACK, SETPOINT}
22string{OFF, SETBACK, SETPOINT}
23string{OFF, SETBACK, SETPOINT}
24string{OFF, SETBACK, SETPOINT}
3string{OFF, SETBACK, SETPOINT}
4string{OFF, SETBACK, SETPOINT}
5string{OFF, SETBACK, SETPOINT}
6string{OFF, SETBACK, SETPOINT}
7string{OFF, SETBACK, SETPOINT}
8string{OFF, SETBACK, SETPOINT}
9string{OFF, SETBACK, SETPOINT}
DAYDay of the week (weekday, saturday, or sunday)string{WEEKDAY, SATURDAY, SUNDAY}

Worksheet: LIGHTING

VariableDescriptionTypeUnitValues
1float{0.0…1.0}
10float{0.0…1.0}
11float{0.0…1.0}
12float{0.0…1.0}
13float{0.0…1.0}
14float{0.0…1.0}
15float{0.0…1.0}
16float{0.0…1.0}
17float{0.0…1.0}
18float{0.0…1.0}
19float{0.0…1.0}
2float{0.0…1.0}
20float{0.0…1.0}
21float{0.0…1.0}
22float{0.0…1.0}
23float{0.0…1.0}
24float{0.0…1.0}
3float{0.0…1.0}
4float{0.0…1.0}
5float{0.0…1.0}
6float{0.0…1.0}
7float{0.0…1.0}
8float{0.0…1.0}
9float{0.0…1.0}
DAYDay of the week (weekday, saturday, or sunday)string{WEEKDAY, SATURDAY, SUNDAY}

Worksheet: METADATA

VariableDescriptionTypeUnitValues
metadatastringalphanumeric

Worksheet: MONTHLY_MULTIPLIER

VariableDescriptionTypeUnitValues
1float{0.0…1.0}
10float{0.0…1.0}
11float{0.0…1.0}
12float{0.0…1.0}
2float{0.0…1.0}
3float{0.0…1.0}
4float{0.0…1.0}
5float{0.0…1.0}
6float{0.0…1.0}
7float{0.0…1.0}
8float{0.0…1.0}
9float{0.0…1.0}

Worksheet: OCCUPANCY

VariableDescriptionTypeUnitValues
1float{0.0…1.0}
10float{0.0…1.0}
11float{0.0…1.0}
12float{0.0…1.0}
13float{0.0…1.0}
14float{0.0…1.0}
15float{0.0…1.0}
16float{0.0…1.0}
17float{0.0…1.0}
18float{0.0…1.0}
19float{0.0…1.0}
2float{0.0…1.0}
20float{0.0…1.0}
21float{0.0…1.0}
22float{0.0…1.0}
23float{0.0…1.0}
24float{0.0…1.0}
3float{0.0…1.0}
4float{0.0…1.0}
5float{0.0…1.0}
6float{0.0…1.0}
7float{0.0…1.0}
8float{0.0…1.0}
9float{0.0…1.0}
DAYDay of the week (weekday, saturday, or sunday)string{WEEKDAY, SATURDAY, SUNDAY}

Worksheet: PROCESSES

VariableDescriptionTypeUnitValues
1float{0.0…1.0}
10float{0.0…1.0}
11float{0.0…1.0}
12float{0.0…1.0}
13float{0.0…1.0}
14float{0.0…1.0}
15float{0.0…1.0}
16float{0.0…1.0}
17float{0.0…1.0}
18float{0.0…1.0}
19float{0.0…1.0}
2float{0.0…1.0}
20float{0.0…1.0}
21float{0.0…1.0}
22float{0.0…1.0}
23float{0.0…1.0}
24float{0.0…1.0}
3float{0.0…1.0}
4float{0.0…1.0}
5float{0.0…1.0}
6float{0.0…1.0}
7float{0.0…1.0}
8float{0.0…1.0}
9float{0.0…1.0}
DAYDay of the week (weekday, saturday, or sunday)string{WEEKDAY, SATURDAY, SUNDAY}

Worksheet: SERVERS

VariableDescriptionTypeUnitValues
1float{0.0…1.0}
10float{0.0…1.0}
11float{0.0…1.0}
12float{0.0…1.0}
13float{0.0…1.0}
14float{0.0…1.0}
15float{0.0…1.0}
16float{0.0…1.0}
17float{0.0…1.0}
18float{0.0…1.0}
19float{0.0…1.0}
2float{0.0…1.0}
20float{0.0…1.0}
21float{0.0…1.0}
22float{0.0…1.0}
23float{0.0…1.0}
24float{0.0…1.0}
3float{0.0…1.0}
4float{0.0…1.0}
5float{0.0…1.0}
6float{0.0…1.0}
7float{0.0…1.0}
8float{0.0…1.0}
9float{0.0…1.0}
DAYDay of the week (weekday, saturday, or sunday)string{WEEKDAY, SATURDAY, SUNDAY}

Worksheet: WATER

VariableDescriptionTypeUnitValues
1float{0.0…1.0}
10float{0.0…1.0}
11float{0.0…1.0}
12float{0.0…1.0}
13float{0.0…1.0}
14float{0.0…1.0}
15float{0.0…1.0}
16float{0.0…1.0}
17float{0.0…1.0}
18float{0.0…1.0}
19float{0.0…1.0}
2float{0.0…1.0}
20float{0.0…1.0}
21float{0.0…1.0}
22float{0.0…1.0}
23float{0.0…1.0}
24float{0.0…1.0}
3float{0.0…1.0}
4float{0.0…1.0}
5float{0.0…1.0}
6float{0.0…1.0}
7float{0.0…1.0}
8float{0.0…1.0}
9float{0.0…1.0}
DAYDay of the week (weekday, saturday, or sunday)string{WEEKDAY, SATURDAY, SUNDAY}

get_database_supply_assemblies

⚠️ Stale: no matching InputLocator method exists, but the locator name is still referenced by string in cea/datamanagement/databases_verification.py. Removing this from schemas.yml will also require updating that reference.

  • Path: inputs/technology/assemblies/SUPPLY.xlsx
  • File type: xls
  • Created by: database_helper
  • Used by: demand, emissions, system_costs

Worksheet: COOLING

VariableDescriptionTypeUnitValues
CAPEX_USD2015kWCapital costs per kWfloat[USD2015/kW]{0.0…n}
codeCode of cooling supply assemblystringNAalphanumeric
DescriptiondescriptionstringNAalphanumeric
efficiencyefficiency of the all in one systemfloat[-]{0.0…n}
feedstockfeedstock used by the the all in one system (refers to the FEEDSTOCK database)stringNA{NONE, NATURALGAS, BIOGAS, GRID, SOLAR, OIL, COAL, WOOD, WETBIOMASS, DRYBIOMASS, HYDROGEN}
IR_%interest rate charged on the loan for the capital costfloat[%]{0.0…100.0}
LT_yrlifetime of assemblyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[%]{0.0…100.0}
primary_componentscodes of components installed in the primary supply system category (i.e. main components)stringNAalphanumeric
referencereferencestringNAalphanumeric
scalewhether the all in one system is used at the building or the district scalestringNA{NONE, BUILDING, DISTRICT, CITY}
secondary_componentscodes of components installed in the secondary supply system category (i.e. supply components)stringNAalphanumeric
tertiary_componentscodes of components installed in the tertiary supply system category (i.e. rejection components)stringNAalphanumeric

Worksheet: ELECTRICITY

VariableDescriptionTypeUnitValues
CAPEX_USD2015kWCapital costs per kWfloat[USD2015/kW]{0.0…n}
codeType of all in one systemstringNAalphanumeric
DescriptionDescription of Type of all in one systemstringNAalphanumeric
efficiencyefficiency of the all in one systemfloat[-]{0.0…n}
feedstockfeedstock used by the the all in one system (refers to the FEEDSTOCK database)stringNA{NONE, NATURALGAS, BIOGAS, GRID, SOLAR, OIL, COAL, WOOD, WETBIOMASS, DRYBIOMASS, HYDROGEN}
IR_%interest rate charged on the loan for the capital costfloat[%]{0.0…100.0}
LT_yrlifetime of assemblyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[%]{0.0…100.0}
referenceReference of the datastringNAalphanumeric
scalewhether the all in one system is used at the building or the district scalestringNA{NONE, BUILDING, DISTRICT, CITY}

Worksheet: HEATING

VariableDescriptionTypeUnitValues
CAPEX_USD2015kWCapital costs per kWfloat[USD2015/kW]{0.0…n}
codeType of all in one systemstringNAalphanumeric
DescriptionDescription of Type of all in one systemstringNAalphanumeric
efficiencyefficiency of the all in one systemfloat[-]{0.0…n}
feedstockfeedstock used by the the all in one system (refers to the FEEDSTOCK database)stringNA{NONE, NATURALGAS, BIOGAS, GRID, SOLAR, OIL, COAL, WOOD, WETBIOMASS, DRYBIOMASS, HYDROGEN}
IR_%interest rate charged on the loan for the capital costfloat[%]{0.0…100.0}
LT_yrlifetime of assemblyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[%]{0.0…100.0}
primary_componentscodes of components installed in the primary supply system category (i.e. main components)stringNAalphanumeric
referenceReference of the datastringNAalphanumeric
scalewhether the all in one system is used at the building or the district scalestringNA{NONE, BUILDING, DISTRICT, CITY}
secondary_componentscodes of components installed in the secondary supply system category (i.e. supply components)stringNAalphanumeric
tertiary_componentscodes of components installed in the tertiary supply system category (i.e. rejection components)stringNAalphanumeric

Worksheet: HOT_WATER

VariableDescriptionTypeUnitValues
CAPEX_USD2015kWCapital costs per kWfloat[USD2015/kW]{0.0…n}
codeType of all in one systemstringNAalphanumeric
DescriptionDescription of Type of all in one systemstringNAalphanumeric
efficiencyefficiency of the all in one systemfloat[-]{0.0…n}
feedstockfeedstock used by the the all in one system (refers to the FEEDSTOCK database)stringNA{NONE, NATURALGAS, BIOGAS, GRID, SOLAR, OIL, COAL, WOOD, WETBIOMASS, DRYBIOMASS, HYDROGEN}
IR_%interest rate charged on the loan for the capital costfloat[%]{0.0…100.0}
LT_yrlifetime of assemblyint[yr]{0…n}
O&M_%operation and maintenance cost factor (fraction of the investment cost)float[%]{0.0…100.0}
referenceReference of the datastringNAalphanumeric
scalewhether the all in one system is used at the building or the district scalestringNA{NONE, BUILDING, DISTRICT, CITY}

get_database_use_types_properties

⚠️ Stale: no matching InputLocator method exists, but the locator name is still referenced by string in cea/datamanagement/databases_verification.py. Removing this from schemas.yml will also require updating that reference.

  • Path: inputs/technology/archetypes/use_types/USE_TYPE_PROPERTIES.xlsx
  • File type: xls
  • Created by: database_helper
  • Used by: archetypes_mapper

Worksheet: INDOOR_COMFORT

VariableDescriptionTypeUnitValues
codeuse type code (refers to building use type)stringNAalphanumeric
RH_max_pcUpper bound of relative humidityfloat[%]{0.0…n}
RH_min_pcLower_bound of relative humidityfloat[%]{0.0…n}
Tcs_set_CSetpoint temperature for cooling systemfloat[C]{n…n}
Tcs_setb_CSetback point of temperature for cooling systemfloat[C]{n…n}
Ths_set_CSetpoint temperature for heating systemfloat[C]{0.0…n}
Ths_setb_CSetback point of temperature for heating systemfloat[C]{n…n}
Ve_lspIndoor quality requirements of indoor ventilation per personfloat[l/s]{0.0…n}

Worksheet: INTERNAL_LOADS

VariableDescriptionTypeUnitValues
codeuse type code (refers to building use type)stringNAalphanumeric
Ea_Wm2Peak specific electrical load due to computers and devicesfloat[W/m2]{0.0…n}
Ed_Wm2Peak specific electrical load due to servers/data centresfloat[W/m2]{0.0…n}
El_Wm2Peak specific electrical load due to artificial lightingfloat[W/m2]{0.0…n}
Epro_Wm2Peak specific electrical load due to industrial processesfloat[W/m2]{0.0…n}
Ev_kWvehPeak capacity of electrical battery per vehiclefloat[kW/veh]{0.0…n}
Occ_m2pOccupancy densityfloat[m2/p]{0.0…n}
Qcpro_Wm2Peak specific process cooling loadfloat[W/m2]{0.0…n}
Qcre_Wm2Peak specific cooling load due to refrigeration (cooling rooms)float[W/m2]{0.0…n}
Qhpro_Wm2Peak specific process heating loadfloat[W/m2]{0.0…n}
Qs_WpPeak sensible heat load of peoplefloat[W/p]{0.0…n}
Vw_ldpPeak specific fresh water consumption (includes cold and hot water)float[lpd]{0.0…n}
Vww_ldpPeak specific daily hot water consumptionfloat[lpd]{0.0…n}
X_ghpMoisture released by occupancy at peak conditionsfloat[g/h/p]{0.0…n}

get_tree_geometry

  • Path: inputs/tree-geometry/trees.shp
  • File type: shp
  • Created by: tree_helper
  • Used by: radiation
VariableDescriptionTypeUnitValues
density_tcTree canopy density. It is the proportion of ground area covered by the vertical projection of tree canopies. It is a measure of how much of the sky is obscured by the canopy when viewed from below.floatNA{0.0…1.0}
geometryShapefile POLYGONPolygonNA
height_tcTree canopy height above ground.float[m]{0.0…n}
nameUnique tree ID.stringNAalphanumeric
REFERENCEReference to data (if any)stringNAalphanumeric

get_weather_file

  • Path: inputs/weather/weather.epw
  • File type: epw
  • Created by: weather_helper
  • Used by: decentralized, demand, optimization, photovoltaic, photovoltaic_thermal, radiation, occupancy, shallow_geothermal_potential, solar_collector, thermal_network
VariableDescriptionTypeUnitValues
aerosol_opt_thousandths (index = 29)TODOfloatTODO{n…n}
Albedo (index = 32)TODOfloatTODO{n…n}
atmos_Pa (index = 9)TODOintTODO{n…n}
ceiling_hgt_m (index = 25)TODOintTODO{n…n}
datasource (index = 5)TODOstringTODOalphanumeric
day (index = 2)TODOintTODO{n…n}
days_last_snow (index = 31)TODOintTODO{n…n}
dewpoint_C (index = 7)TODOfloatTODO{n…n}
difhorillum_lux (index = 18)TODOintTODO{n…n}
difhorrad_Whm2 (index = 15)TODOintTODO{n…n}
dirnorillum_lux (index = 17)TODOintTODO{n…n}
dirnorrad_Whm2 (index = 14)TODOintTODO{n…n}
drybulb_C (index = 6)TODOfloatTODO{n…n}
extdirrad_Whm2 (index = 11)TODOintTODO{n…n}
exthorrad_Whm2 (index = 10)TODOintTODO{n…n}
glohorillum_lux (index = 16)TODOintTODO{n…n}
glohorrad_Whm2 (index = 13)TODOintTODO{n…n}
horirsky_Whm2 (index = 12)TODOintTODO{n…n}
hour (index = 3)TODOintTODO{n…n}
liq_precip_depth_mm (index = 33)TODOfloatTODO{n…n}
liq_precip_rate_Hour (index = 34)TODOfloatTODO{n…n}
minute (index = 4)TODOintTODO{n…n}
month (index = 1)TODOintTODO{n…n}
opaqskycvr_tenths (index = 23)TODOintTODO{n…n}
precip_wtr_mm (index = 28)TODOintTODO{n…n}
presweathcodes (index = 27)TODOintTODO{n…n}
presweathobs (index = 26)TODOintTODO{n…n}
relhum_percent (index = 8)TODOintTODO{n…n}
snowdepth_cm (index = 30)TODOintTODO{n…n}
totskycvr_tenths (index = 22)TODOintTODO{n…n}
visibility_km (index = 24)TODOintTODO{n…n}
winddir_deg (index = 20)TODOintTODO{n…n}
windspd_ms (index = 21)TODOfloatTODO{n…n}
year (index = 0)TODOintTODO{n…n}
zenlum_lux (index = 19)TODOintTODO{n…n}

← Energy Supply System Optimisation | Glossary index | Utilities →

Source: view raw on GitHub ↗