Export Factories
Export factories are pipelines that can be used to export a city. This could be a geospatial format such as geojson or obj for visualization. It can also be used to export the city in required format to run energy simulations with software such as EnergyPlus.
Energy Building Exports Factory
The Energy Building Exports Factory is responsible for exporting a city into a format compatible with external energy simulation software. The following handlers are
Handler |
Description |
|---|---|
energy_ade |
Exports the city in the extended CityGML format capable of running energy simulations and storing the results. |
idf |
Generates IDF files supported by EnergyPlus using in-house IDF creation library. Supports all buildings in a single IDF file. |
cerc_idf |
Outdated handler for creating EnergyPlus IDF files. Replaced by the idf handler. |
insel_monthly_energy_balance |
Creates input for INSEL-based Monthly Energy Balance simulation; supports only one building per file. |
Exports Factory
The Exports Factory is a versatile factory that can export a city from the CITYhub in 2D and 3D geospatial formats.
Handler |
Description |
|---|---|
stl |
Stores surface geometry as triangular facets; widely used for 3D printing and modeling. |
obj |
Text-based format storing 3D models with vertices, normals, and texture coordinates. |
sra |
Defines scene geometry and materials for radiosity-based lighting simulation. |
cesiumjs_tileset |
Tileset format used by CesiumJS for streaming and rendering large 3D geospatial data. |
glb |
Binary version of glTF file format; compact and efficient for transmitting 3D models. |
geojson |
JSON-based format for encoding geographic features with geometry and attributes. |
Results Factory
The Results Export Factory is used to export buildings from the CITYhub with their metadata and their enriched results. The following data are available:
Note
At this time, the Results Exports Factory supports exporting to the csv, geojson, and parquet formats.
Building Metadata
Building metadata consists of key attributes that belong to a building. These values are either calculated by the CITYhub or provided by the input dataset.
Property |
Description |
|---|---|
Name |
Name of the building either autosigned by the CITYhub or provided by the input dataset |
Height |
Height of the building in meters |
Number of Storeys |
Number of storeys of the building |
Footprint Area |
Area of the footprint of the building in square meters |
Total Area |
Total area of the building by multiplying the footprint area by the number of storeys |
Energy System |
Energy system used by the building |
Aliases |
Aliases provided by the input dataset |
Energy Simulation Results
Once the buildings are enriched with energy simulation results from the INSEL Monthly Energy Balance, EnergyPlus, or Simplified Radiosity Algorithm softwares, the results can be exported.
Property |
Description |
|---|---|
Cooling Peak Load |
The maximum energy required to cool a building given the worst conditions |
Heating Peak Load |
The maximum energy required to heat a building given the worst conditions |
Lighting Peak Load |
The maximum energy required to operate household appliances assuming all lights are running simultaneously |
Appliances Peak Load |
The maximum energy required to operate household appliances assuming all appliances are running simultaneously |
Cooling Demand |
The energy required to cool a building to a specific temperature |
Heating Demand |
The energy required to heat a building to a specific temperature |
Lighting Electrical Demand |
The energy required to operate lights of a building |
Appliances Electrical Demand |
The energy required to operate household appliances |
Domestic Hot Water Demand |
The energy required to provide hot water to building |
Heating Consumption |
The energy actually used to heat a building to a specific temperature |
Cooling Consumption |
The energy actually used to cool a building to a specific temperature |
Domestic Hot Water Consumption |
The energy actually used to provide hot water to building |