GUIDEBOOK · GLOSSARY

User Inputs

User Inputs

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: 6


Files


get_site_polygon

  • Path: inputs/building-geometry/site.shp
  • File type: shp
  • Created by: user input
  • Used by: zone_helper
VariableDescriptionTypeUnitValues
FIDShapefile IDint[-]{0…n}
geometryShapefile POLYGONPolygonNA

get_street_network

  • Path: inputs/networks/streets.shp
  • File type: shp
  • Created by: user input
  • Used by: network_layout, optimization
VariableDescriptionTypeUnitValues
geometryGeometryLineStringNA
IdUnique street ID. It must start with a letter.stringNAalphanumeric

get_surroundings_geometry

  • Path: inputs/building-geometry/surroundings.shp
  • File type: shp
  • Created by: user input
  • Used by: radiation
VariableDescriptionTypeUnitValues
floors_agNumber of floors above ground (incl. ground floor, Minimum one floor is needed)int[-]{1…n}
geometryShapefile POLYGONPolygonNA
height_agHeight above ground (incl. ground floor, Minimum one floor is needed)float[m]{2.0…n}
nameUnique building ID. It must start with a letter.stringNAalphanumeric
REFERENCEReference to data (if any)stringNAalphanumeric

get_terrain

  • Path: inputs/topography/terrain.tif
  • File type: tif
  • Created by: user input
  • Used by: radiation
VariableDescriptionTypeUnitValues
raster_valueTODOTODOTODO

get_weather

  • Path: databases/weather/Zug-inducity_1990_2010_TMY.epw
  • File type: epw
  • Created by: user input
  • Used by: weather_helper
VariableDescriptionTypeUnitValues
aerosol_opt_thousandths (index = 29)TODOTYPETODO
Albedo (index = 32)AlbedoTYPETODO
atmos_Pa (index = 9)Atmospheric pressureTYPETODO
ceiling_hgt_m (index = 25)TODOTYPETODO
datasource (index = 5)Source of dataTYPETODO
day (index = 2)TODOTYPETODO
days_last_snow (index = 31)Days since last snowTYPETODO
dewpoint_C (index = 7)TODOTYPETODO
difhorillum_lux (index = 18)TODOTYPETODO
difhorrad_Whm2 (index = 15)TODOTYPETODO
dirnorillum_lux (index = 17)TODOTYPETODO
dirnorrad_Whm2 (index = 14)TODOTYPETODO
drybulb_C (index = 6)TODOTYPETODO
extdirrad_Whm2 (index = 11)TODOTYPETODO
exthorrad_Whm2 (index = 10)TODOTYPETODO
glohorillum_lux (index = 16)TODOTYPETODO
glohorrad_Whm2 (index = 13)TODOTYPETODO
horirsky_Whm2 (index = 12)TODOTYPETODO
hour (index = 3)TODOTYPETODO
liq_precip_depth_mm (index = 33)TODOTYPETODO
liq_precip_rate_Hour (index = 34)TODOTYPETODO
minute (index = 4)TODOTYPETODO
month (index = 1)TODOTYPETODO
opaqskycvr_tenths (index = 23)TODOTYPETODO
precip_wtr_mm (index = 28)TODOTYPETODO
presweathcodes (index = 27)TODOTYPETODO
presweathobs (index = 26)TODOTYPETODO
relhum_percent (index = 8)TODOTYPETODO
snowdepth_cm (index = 30)TODOTYPETODO
totskycvr_tenths (index = 22)TODOTYPETODO
visibility_km (index = 24)TODOTYPETODO
winddir_deg (index = 20)TODOTYPETODO
windspd_ms (index = 21)TODOTYPETODO
year (index = 0)TODOTYPETODO
zenlum_lux (index = 19)TODOTYPETODO

get_zone_geometry

  • Path: inputs/building-geometry/zone.shp
  • File type: shp
  • Created by: user input
  • Used by: archetypes_mapper, decentralized, demand, emissions, network_layout, optimization, photovoltaic, photovoltaic_thermal, radiation, occupancy, sewage_potential, shallow_geothermal_potential, solar_collector, thermal_network
VariableDescriptionTypeUnitValues
const_typeConstruction Archetypesstring[-]alphanumeric
floors_agNumber of floors above ground (incl. ground floor, minimum one floor is needed)int[-]{1…n}
floors_bgNumber of floors below ground (basement)int[-]{0…n}
geometryShapefile POLYGONPolygonNA
height_agHeight above ground (incl. ground floor, minimum one floor is needed)float[m]{2.0…n}
height_bgHeight below ground (basement)float[m]{0.0…n}
nameUnique building ID. It must start with a letter.stringNAalphanumeric
referenceReference to data (if any)stringNAalphanumeric
use_type1First (Main) Use type of the buildingstring[-]alphanumeric
use_type1rFraction of gross floor area for first Use Typefloat[m2/m2]{0.0…1.0}
use_type2Second Use type of the buildingstring[-]alphanumeric
use_type2rFraction of gross floor area for second Use Typefloat[m2/m2]{0.0…1.0}
use_type3Third Use type of the buildingstring[-]alphanumeric
use_type3rFraction of gross floor area for third Use Typefloat[m2/m2]{0.0…1.0}
void_deckNumber of floors (from the ground up) with an open envelope (default = 0, should be lower than floors_ag.)int[-]{0…n}
yearConstruction yearint[-]{0…n}

Glossary index | Solar Radiation Analysis →

Source: view raw on GitHub ↗