EnergyAtlas Logo EnergyAtlas Wiki Edit on GitHub
  • Home
  • Install
  • UBEM
  • References
  • User Stories
  • Library
  • FAQ

Wiki Navigation

Browse topics and documentation pages.

Quick Start

New to Energy Atlas New to UBEM UBEM Wiki

EnergyAtlas References

Input Output Guide Workflows Guide Objects Guide

Resources

User Stories EnergyAtlas Library FAQ Wiki Guide Development Guide

Enums Reference¶

This page centralizes the enum value sets referenced across the documentation. For the GeoJSON input/output schema, see Input / Output Reference.

DOEBuildingType¶

Building program / archetype selector.

Value Notes
UNDEFINED Default/unknown.
NONE Explicitly “no archetype”.
FullServiceRestaurant
Hospital
LargeHotel
LargeOffice
MediumOffice
MidriseApartment Residential; aligns with RECS typehuq = 5 (5+ units).
HighriseApartment Residential; aligns with RECS typehuq = 5 (5+ units).
OutPatient
PrimarySchool
QuickServiceRestaurant
SecondarySchool
SmallHotel
SmallOffice
StandaloneRetail
StripMall
SuperMarket
Warehouse
SingleFamilyDetached Residential; RECS typehuq = 2.
SingleFamilyAttached Residential; RECS typehuq = 3.
MultiFamilyResidential Residential; RECS typehuq = 4 (2–4 units).
MobileHome Residential; RECS typehuq = 1.
OtherCommercial
OtherIndustrial

RECS typehuq reference (residential)¶

Source: RECS 2020 documentation (PDF)

typehuq Meaning
-1 Non-residential use
1 Mobile home
2 Single-family detached
3 Single-family attached (duplex/row/townhome)
4 Apartment, 2–4 units
5 Apartment, 5+ units

SystemOptions¶

HVAC system type selector.

Value Int Notes
None 0 No system
CustomSystem 1 User-specified COP & fuel
ElectricHeating 11 Electric resistance
BoilerOld 21 Low-efficiency boiler
BoilerMed 31 Medium-efficiency boiler
BoilerNew 41 High-efficiency boiler
HeatPumpAir 71 Air-source heat pump
HeatPumpWater 75 Water-source heat pump
CHP 78 Combined heat & power
DistrictSystem 79 District heating/cooling

Fuel¶

Fuel type selector.

Value Notes
Electricity
Gas
FuelOil
Coal
Gasoline
Propane
Diesel
Wood
District District energy (heating/cooling).
NA Not applicable / unknown.

CapacityClass¶

Thermal mass class selector.

Value Notes
VeryLight
Light
Medium
Heavy
VeryHeavy

GlazingOptions¶

Glazing preset selector.

Value Notes
SinglePaneClr Single pane, clear.
DoublePaneClr Double pane, clear.
DoublePaneLoEe2 Double pane, low-e (variant e2).
DoublePaneLoEe3 Double pane, low-e (variant e3).
TriplePaneLoE Triple pane, low-e.
  • Enums Reference
    • DOEBuildingType
      • RECS typehuq reference (residential)
    • SystemOptions
    • Fuel
    • CapacityClass
    • GlazingOptions

WIP EnergyAtlas Wiki

EnergyAtlas Wiki is still under active development. Thank you for your patience while we improve the documentation. If you have any questions, please contact us.