Skip to content

URBANopt Building

Schema for an URBANopt Building object. Fields prefaced with [unused] in the description are placeholders (or informational) and are not actually connected in the GMT.

Properties

  • id (string): Unique id used to refer to this feature within this dataset.
  • project_id (string): [unused] Project which this feature belongs to.
  • type (string): Type of feature. Must be one of: ["Building"].
  • source_name (string): [unused] Name of the original data source.
  • source_id (string): [unused] Id of the feature in original data source.
  • name (string): [unused] Feature name.
  • legal_name (string): [unused] Legal name used to identify this feature.
  • address (string): [unused] Street address.
  • building_status (string): [unused] Building status. Must be one of: ["Proposed", "Existing"].
  • detailed_model_filename (string): [unused] Name of a detailed model which can be loaded from disk as a seed model or complete model. Mapper class decides which measures to disable if this is present.
  • weather_filename (string): [unused] Name of EPW weather file for this building. Defaults to site's weather_filename.
  • tariff_filename (string): [unused] Name of the tariff file for this building. Defaults to site's tariff_filename.
  • surface_elevation (number): [unused] The surface elevation (above NAVD88 datum) of the building (ft). This is the elevation of the ground at the building location, any below ground stories will be lower than this. Defaults to site's surface_elevation.
  • timesteps_per_hour (integer): [unused] Number of timesteps per hour for energy simulations. Defaults to site's timesteps_per_hour. Minimum: 1. Maximum: 60.
  • begin_date (string): [unused] Date to begin simulation, format YYYY-MM-DD. Defaults to site's begin_date.
  • end_date (string): [unused] Date to end simulation, format YYYY-MM-DD. Defaults to site's end_date.
  • climate_zone (string): [unused] ASHRAE 169 climate zone. Defaults to site's climate_zone.
  • cec_climate_zone (string): [unused] CEC Title24 climate zone. Defaults to site's cec_climate_zone.
  • floor_area (number): Usable floor area (ft^2). Required for residential buildings, this represents conditioned floor area.
  • number_of_stories (integer): The maximum number of building stories, sum of number of above and below ground stories.
  • number_of_stories_above_ground (integer): The number of building stories above ground. Defaults to number_of_stories. Required for residential buildings.
  • maximum_roof_height (number): [unused] Maximum height of the roof relative to surface elevation (ft).
  • roof_type (string): [unused] The type of roof. Defaults to flat. Must be one of: ["Flat", "Gable", "Hip"].
  • foundation_type: Refer to #/definitions/foundationType.
  • attic_type: Refer to #/definitions/atticType.
  • footprint_area (number): [unused] Area of the footprint (ft^2). Calculated on export.
  • footprint_perimeter (number): [unused] Perimeter of the footprint (ft). Calculated on export.
  • year_built (integer): The year construction of the building was completed. Can be in the future to indicate future build out. Defaults to current year.
  • template: Refer to #/definitions/templateType.
  • building_type: Refer to #/definitions/buildingType.
  • system_type: Refer to #/definitions/systemType.
  • heating_system_fuel_type: Refer to #/definitions/heatingSystemFuelType.
  • weekday_start_time (string): [unused] Weekday operating hours start time in 08:30 format, using 24-hr clock. Leave blank to use default.
  • weekday_duration (string): [unused] Length of weekend operating hours in 08:30 format, up to 24:00.
  • weekend_start_time (string): [unused] Weekend operating hours start time in 08:30 format, using 24-hr clock. Leave blank to use default.
  • weekend_duration (string): [unused] Length of weekend operating hours in 08:30 format, up to 24:00.
  • mixed_type_1: Refer to #/definitions/buildingType.
  • mixed_type_1_percentage (number): [unused] Percentage of 1st mixed building space type. Only used when building_type is Mixed use. Minimum: 0. Maximum: 100.
  • mixed_type_2: Refer to #/definitions/buildingType.
  • mixed_type_2_percentage (number): [unused] Percentage of 2nd mixed building space type. Only used when building_type is Mixed use. Minimum: 0. Maximum: 100.
  • mixed_type_3: Refer to #/definitions/buildingType.
  • mixed_type_3_percentage (number): [unused] Percentage of 3rd mixed building space type. Only used when building_type is Mixed use. Minimum: 0. Maximum: 100.
  • mixed_type_4: Refer to #/definitions/buildingType.
  • mixed_type_4_percentage (number): [unused] Percentage of 4th mixed building space type. Only used when building_type is Mixed use. Minimum: 0. Maximum: 100.
  • number_of_residential_units (integer): [unused] Total number of residential units in the building. Required for single-family attached and multifamily residential buildings.
  • number_of_bedrooms (integer): [unused] Total number of bedrooms in the building. Required for residential buildings. Must be divisible by the number of residential units.
  • exterior_lighting_zone (string): [unused] Choice of exterior lighting zone. Must be one of: ["0 - Undeveloped Areas Parks", "1 - Developed Areas Parks", "2 - Neighborhood", "3 - All Other Areas", "4 - High Activity"].
  • onsite_parking_fraction (number): [unused] Fraction of building parking to include in this model. Choose 1 to include exterior lights for parking in this building model. Choose 0 if parking is modeled separately. Minimum: 0. Maximum: 1.
  • power_factor (number): [unused] Ratio of the real power used by building to the apparent power seen by grid. Minimum: 0.
  • user_data: [unused] Arbitrary user data.
  • ev_charging (boolean): [unused] Should be set to true if EV charging is associated with the building.
  • ev_charging_station_type (string): [unused] Indicates whether EV charging associated with the building is for Typical Home, Public or Work charging station. Must be one of: ["Typical Home", "Typical Public", "Typical Work"].
  • delay_type (string): [unused] Adds workplace charging flexibility for different scenarios. Min delay scenario indicates EV charging immediately upon arriving to work, Max delay indicates not charging until necessary thereby shifting EV charging load to later in the day and Min power indicates charging EVs at a minimum rate over the parking event. Must be one of: ["Min Delay", "Max Delay", "Min Power"].
  • ev_charging_behavior (string): [unused] Describes scenarios for EV charging behavior, Business as Usual implies home dominant charging behavior, Free Workplace Charging at Project Site implies peak power draw from EV charging during morning hours due to EV charging at workplaces and Free Workplace Charging Across Metro Area scenario reduces Home EV charging relative to Free Workplace Charging at Project Site for residents who work elsewhere and can charge their vehicles for free at those workplaces. Must be one of: ["Business as Usual", "Free Workplace Charging at Project Site", "Free Workplace Charging Across Metro Area"].
  • ev_percent (number): Denotes the % of vehicles parked at the building that are EVs.
  • ev_curtailment_frac (number): [unused] Fraction between 0 and 1 that denotes curtailment of EV charging load to better align EV charging with expected energy production from a solar PV system.

Definitions

  • buildingType (string): [unused] Primary building space type. Must be one of: ["Single-Family Detached", "Single-Family Attached", "Multifamily", "Single-Family", "Multifamily (2 to 4 units)", "Multifamily (5 or more units)", "Vacant", "Office", "Laboratory", "Nonrefrigerated warehouse", "Food sales", "Public order and safety", "Outpatient health care", "Refrigerated warehouse", "Religious worship", "Public assembly", "Education", "Food service", "Inpatient health care", "Nursing", "Lodging", "Strip shopping mall", "Enclosed mall", "Retail other than mall", "Service", "Mixed use", "Uncovered Parking", "Covered Parking", "null"].
  • systemType (string): [unused] Building HVAC system type. Must be one of: ["PTAC with baseboard electric", "PTAC with baseboard gas boiler", "PTAC with baseboard district hot water", "PTAC with gas unit heaters", "PTAC with electric coil", "PTAC with gas coil", "PTAC with gas boiler", "PTAC with no heat", "PTAC with district hot water", "PTAC with central air source heat pump", "PTHP", "PSZ-AC with gas coil", "PSZ-AC with baseboard electric", "PSZ-AC with no heat", "PSZ-AC with district hot water", "PSZ-AC with central air source heat pump", "PSZ-HP", "Fan coil district chilled water with no heat", "Fan coil district chilled water with boiler", "Fan coil district chilled water with central air source heat pump", "Fan coil district chilled water with gas unit heaters", "Fan coil district chilled water with baseboard electric", "Fan coil district chilled water with district hot water", "Fan coil chiller with district hot water", "Fan coil air-cooled chiller with district hot water", "Fan coil chiller with boiler", "Fan coil air-cooled chiller with boiler", "Fan coil chiller with central air source heat pump", "Fan coil air-cooled chiller with central air source heat pump", "Fan coil chiller with no heat", "DOAS with fan coil district chilled water with no heat", "DOAS with fan coil district chilled water and boiler", "DOAS with fan coil district chilled water with central air source heat pump", "DOAS with fan coil district chilled water with gas unit heaters", "DOAS with fan coil district chilled water with baseboard electric", "DOAS with fan coil district chilled water with district hot water", "DOAS with fan coil chiller with district hot water", "DOAS with fan coil air-cooled chiller with district hot water", "DOAS with fan coil air-cooled chiller with boiler", "DOAS with fan coil chiller with central air source heat pump", "DOAS with fan coil air-cooled chiller with central air source heat pump", "DOAS with fan coil chiller with no heat", "DOAS with VRF", "VRF", "DOAS with water source heat pumps with ground source heat pump", "Forced air furnace", "Baseboard district hot water", "Baseboard electric", "Baseboard gas boiler", "Baseboard central air source heat pump", "Window AC with no heat", "Window AC with forced air furnace", "Window AC with baseboard district hot water", "Window AC with baseboard electric", "Window AC with unit heaters", "Window AC with baseboard gas boiler", "Window AC with baseboard central air source heat pump", "Direct evap coolers with baseboard district hot water", "Direct evap coolers with baseboard electric", "Direct evap coolers with baseboard gas boiler", "Direct evap coolers with baseboard central air source heat pump", "Direct evap coolers with no heat", "Direct evap coolers with gas unit heaters", "Direct evap coolers with forced air furnace", "Gas unit heaters", "VAV chiller with gas boiler reheat", "VAV chiller with gas coil reheat", "VAV chiller with central air source heat pump reheat", "VAV chiller with PFP boxes", "VAV air-cooled chiller with gas boiler reheat", "VAV air-cooled chiller with central air source heat pump reheat", "VAV air-cooled chiller with district hot water reheat", "VAV air-cooled chiller with gas coil reheat", "VAV air-cooled chiller with no reheat with gas unit heaters", "VAV district chilled water with gas boiler reheat", "VAV district chilled water with central air source heat pump reheat", "VAV district chilled water with no reheat with zone heat pump", "VAV chiller with no reheat with baseboard electric", "VAV air-cooled chiller with no reheat with zone heat pump", "VAV district chilled water with district hot water reheat", "VAV district chilled water with gas coil reheat", "PVAV with gas heat with electric reheat", "PVAV with central air source heat pump reheat", "PVAV with PFP boxes", "Residential - electric resistance and no cooling", "Residential - electric resistance and central air conditioner", "Residential - electric resistance and room air conditioner", "Residential - electric resistance and evaporative cooler", "Residential - furnace and no cooling", "Residential - furnace and central air conditioner", "Residential - furnace and room air conditioner", "Residential - furnace and evaporative cooler", "Residential - boiler and no cooling", "Residential - boiler and central air conditioner", "Residential - boiler and room air conditioner", "Residential - boiler and evaporative cooler", "Residential - air-to-air heat pump", "Residential - mini-split heat pump", "Residential - ground-to-air heat pump"].
  • heatingSystemFuelType (string): [unused] The fuel type of the heating system. This does not apply for certain system types (e.g., electric resistance or heat pumps). Must be one of: ["electricity", "natural gas", "fuel oil", "propane", "wood"].
  • templateType (string): [unused] Standard template applied to building. Default to site's default_template. Must be one of: ["DOE Ref Pre-1980", "DOE Ref 1980-2004", "90.1-2004", "90.1-2007", "90.1-2010", "90.1-2013", "NREL ZNE Ready 2017", "DEER Pre-1975", "DEER 1985", "DEER 1996", "DEER 2003", "DEER 2007", "DEER 2011", "DEER 2014", "DEER 2015", "DEER 2017", "DEER 2020", "DEER 2025", "DEER 2030", "DEER 2035", "DEER 2040", "DEER 2045", "DEER 2050", "DEER 2055", "DEER 2060", "DEER 2065", "DEER 2070", "DEER 2075", "Residential IECC 2006 - Customizable Template Sep 2020", "Residential IECC 2009 - Customizable Template Sep 2020", "Residential IECC 2012 - Customizable Template Sep 2020", "Residential IECC 2015 - Customizable Template Sep 2020", "Residential IECC 2018 - Customizable Template Sep 2020"].
  • foundationType (string): [unused] The foundation type of the building. Required for residential buildings. Must be one of: ["slab", "crawlspace - vented", "crawlspace - unvented", "basement - unconditioned", "basement - conditioned", "ambient"].
  • atticType (string): [unused] The attic type of the building. Required for single-family residential buildings. Must be one of: ["attic - vented", "attic - unvented", "attic - conditioned", "flat roof"].