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
get_street_network
get_surroundings_geometry
get_terrain
get_weather
get_zone_geometry

`get_site_polygon`

Path: inputs/building-geometry/site.shp
File type: shp
Created by: user input
Used by: zone_helper

Variable	Description	Type	Unit	Values
`FID`	Shapefile ID	int	`[-]`	{0…n}
`geometry`	Shapefile POLYGON	Polygon	`NA`

`get_street_network`

Path: inputs/networks/streets.shp
File type: shp
Created by: user input
Used by: network_layout, optimization

Variable	Description	Type	Unit	Values
`geometry`	Geometry	LineString	`NA`
`Id`	Unique street ID. It must start with a letter.	string	`NA`	alphanumeric

`get_surroundings_geometry`

Path: inputs/building-geometry/surroundings.shp
File type: shp
Created by: user input
Used by: radiation

Variable	Description	Type	Unit	Values
`floors_ag`	Number of floors above ground (incl. ground floor, Minimum one floor is needed)	int	`[-]`	{1…n}
`geometry`	Shapefile POLYGON	Polygon	`NA`
`height_ag`	Height above ground (incl. ground floor, Minimum one floor is needed)	float	`[m]`	{2.0…n}
`name`	Unique building ID. It must start with a letter.	string	`NA`	alphanumeric
`REFERENCE`	Reference to data (if any)	string	`NA`	alphanumeric

`get_terrain`

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

Variable	Description	Type	Unit	Values
`raster_value`	TODO	TODO	`TODO`

`get_weather`

Path: databases/weather/Zug-inducity_1990_2010_TMY.epw
File type: epw
Created by: user input
Used by: weather_helper

Variable	Description	Type	Unit
`aerosol_opt_thousandths (index = 29)`	TODO	TYPE	`TODO`
`Albedo (index = 32)`	Albedo	TYPE	`TODO`
`atmos_Pa (index = 9)`	Atmospheric pressure	TYPE	`TODO`
`ceiling_hgt_m (index = 25)`	TODO	TYPE	`TODO`
`datasource (index = 5)`	Source of data	TYPE	`TODO`
`day (index = 2)`	TODO	TYPE	`TODO`
`days_last_snow (index = 31)`	Days since last snow	TYPE	`TODO`
`dewpoint_C (index = 7)`	TODO	TYPE	`TODO`
`difhorillum_lux (index = 18)`	TODO	TYPE	`TODO`
`difhorrad_Whm2 (index = 15)`	TODO	TYPE	`TODO`
`dirnorillum_lux (index = 17)`	TODO	TYPE	`TODO`
`dirnorrad_Whm2 (index = 14)`	TODO	TYPE	`TODO`
`drybulb_C (index = 6)`	TODO	TYPE	`TODO`
`extdirrad_Whm2 (index = 11)`	TODO	TYPE	`TODO`
`exthorrad_Whm2 (index = 10)`	TODO	TYPE	`TODO`
`glohorillum_lux (index = 16)`	TODO	TYPE	`TODO`
`glohorrad_Whm2 (index = 13)`	TODO	TYPE	`TODO`
`horirsky_Whm2 (index = 12)`	TODO	TYPE	`TODO`
`hour (index = 3)`	TODO	TYPE	`TODO`
`liq_precip_depth_mm (index = 33)`	TODO	TYPE	`TODO`
`liq_precip_rate_Hour (index = 34)`	TODO	TYPE	`TODO`
`minute (index = 4)`	TODO	TYPE	`TODO`
`month (index = 1)`	TODO	TYPE	`TODO`
`opaqskycvr_tenths (index = 23)`	TODO	TYPE	`TODO`
`precip_wtr_mm (index = 28)`	TODO	TYPE	`TODO`
`presweathcodes (index = 27)`	TODO	TYPE	`TODO`
`presweathobs (index = 26)`	TODO	TYPE	`TODO`
`relhum_percent (index = 8)`	TODO	TYPE	`TODO`
`snowdepth_cm (index = 30)`	TODO	TYPE	`TODO`
`totskycvr_tenths (index = 22)`	TODO	TYPE	`TODO`
`visibility_km (index = 24)`	TODO	TYPE	`TODO`
`winddir_deg (index = 20)`	TODO	TYPE	`TODO`
`windspd_ms (index = 21)`	TODO	TYPE	`TODO`
`year (index = 0)`	TODO	TYPE	`TODO`
`zenlum_lux (index = 19)`	TODO	TYPE	`TODO`

`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

Variable	Description	Type	Unit	Values
`const_type`	Construction Archetypes	string	`[-]`	alphanumeric
`floors_ag`	Number of floors above ground (incl. ground floor, minimum one floor is needed). For a building with a void deck, what this counts depends on which void column the scenario uses. With height_vd it counts only the ENCLOSED storeys above the void deck. With the legacy void_deck column it counts EVERY storey, void ones included, so the enclosed count is floors_ag minus void_deck. Either way height_ag spans the void deck plus the enclosed building, and the storey height of the enclosed part is (height_ag - void deck height) / enclosed floors.	int	`[-]`	{1…n}
`floors_bg`	Number of floors below ground (basement)	int	`[-]`	{0…n}
`geometry`	Shapefile POLYGON	Polygon	`NA`
`height_ag`	Height above ground (incl. ground floor, minimum one floor is needed). Always measured from the ground to the roof, so it spans any void deck as well as the enclosed building above it. Because of that it is not floors_ag times the storey height whenever a void deck is present - see floors_ag and height_vd.	float	`[m]`	{2.0…n}
`height_bg`	Height below ground (basement)	float	`[m]`	{0.0…n}
`height_vd`	Height of the void deck - the open, unenclosed portion at the bottom of the building (default = 0, and it must leave at least 2 m of height per enclosed floor). Optional. Replaces void_deck, which could only express whole floors. IMPORTANT - when height_vd is used, floors_ag counts only the ENCLOSED storeys sitting above the void deck, while height_ag still spans the void deck plus the enclosed solid. This is what lets a void deck be taller than a normal storey. With the legacy void_deck column, floors_ag instead spans the whole height, void storeys included. A void deck is always at ground level; CEA does not model an open storey part-way up a building. Where both columns are present, height_vd is used for any building whose cell has a value - a blank cell falls back to void_deck, so leaving it empty in an older scenario changes nothing.	float	`[m]`	{0.0…n}
`name`	Unique building ID. It must start with a letter.	string	`NA`	alphanumeric
`reference`	Reference to data (if any)	string	`NA`	alphanumeric
`use_type1`	First (Main) Use type of the building	string	`[-]`	alphanumeric
`use_type1r`	Fraction of gross floor area for first Use Type	float	`[m2/m2]`	{0.0…1.0}
`use_type2`	Second Use type of the building	string	`[-]`	alphanumeric
`use_type2r`	Fraction of gross floor area for second Use Type	float	`[m2/m2]`	{0.0…1.0}
`use_type3`	Third Use type of the building	string	`[-]`	alphanumeric
`use_type3r`	Fraction of gross floor area for third Use Type	float	`[m2/m2]`	{0.0…1.0}
`void_deck`	Legacy column - number of floors (from the ground up) with an open envelope (default = 0, should be lower than floors_ag). Here floors_ag spans the whole above-ground height, void storeys included, so the enclosed storey count is floors_ag minus void_deck. Superseded by height_vd, which records the void in metres and is not tied to whole storeys. Still fully supported - CEA-3 scenarios are migrated onto this column unchanged. Where both are present, height_vd is used.	int	`[-]`	{0…n}
`year`	Construction year	int	`[-]`	{0…n}

Glossary index | Solar Radiation Analysis →

Source: view raw on GitHub ↗