Honeybee logo
Documentation Powered by Redocly

Honeybee Project Information Schema (2.2.0)

Download OpenAPI specification:Download

Ladybug Tools: info@ladybug.tools URL: https://github.com/ladybug-tools/honeybee-schema License: BSD

Honeybee project-information schema.

OpenAPI Specification with Inheritance

Autocalculate

type
string (Type)
Default: "Autocalculate"
Value: "Autocalculate"
{
  • "type": "Autocalculate"
}

BuildingTypes

string (BuildingTypes)
Enum: "Residential" "NonResidential" "MidriseApartment" "HighriseApartment" "LargeOffice" "MediumOffice" "SmallOffice" "Retail" "StripMall" "PrimarySchool" "SecondarySchool" "SmallHotel" "LargeHotel" "Hospital" "Outpatient" "Warehouse" "SuperMarket" "FullServiceRestaurant" "QuickServiceRestaurant" "Laboratory" "Courthouse" "College"
"Residential"

ClimateZones

string (ClimateZones)
Enum: "0A" "1A" "2A" "3A" "4A" "5A" "6A" "0B" "1B" "2B" "3B" "4B" "5B" "6B" "3C" "4C" "5C" "7" "8"
"0A"

EfficiencyStandards

string (EfficiencyStandards)
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"
"ASHRAE_2019"

Location

type
string (Type)
Default: "Location"
Value: "Location"
city
string (City)
Default: "-"

Name of the city as a string.

latitude
number <double> (Latitude)
Default: 0

Location latitude between -90 and 90 (Default: 0).

longitude
number <double> (Longitude)
Default: 0

Location longitude between -180 (west) and 180 (east) (Default: 0).

Autocalculate (object) or Time Zone (integer) (Time Zone)
Default: {"type":"Autocalculate"}

Time zone between -12 hours (west) and +14 hours (east). If None, the time zone will be an estimated integer value derived from the longitude in accordance with solar time.

elevation
number <double> (Elevation)
Default: 0

A number for elevation of the location in meters. (Default: 0).

station_id
string (Station Id)
Default: null

ID of the location if the location is representing a weather station.

source
string (Source)
Default: null

Source of data (e.g. TMY, TMY3).

{
  • "type": "Location",
  • "city": "-",
  • "latitude": 0,
  • "longitude": 0,
  • "time_zone": {
    },
  • "elevation": 0,
  • "station_id": null,
  • "source": null
}

ProjectInfo

type
string (Type)
Default: "ProjectInfo"
Value: "ProjectInfo"
north
number <double> (North) [ -360 .. 360 ]
Default: 0

A number between -360 to 360 where positive values rotate the compass counterclockwise (towards the West) and negative values rotate the compass clockwise (towards the East).

Array of Weather Urls (strings) or Weather Urls (null) (Weather Urls)
Default: null

A list of URLs to zip files that includes EPW, DDY and STAT files. You can find these URLs from the EPWMAP. The first URL will be used as the primary weather file.

Location (object) or null
Default: null

Project location. This value is usually generated from the information in the weather files.

ClimateZones (string) or null
Default: null

Project location climate zone.

Array of Building Type (strings) or Building Type (null) (Building Type)
Default: null

A list of building types for the project. The first building type is considered the primary type for the project.

Array of Vintage (strings) or Vintage (null) (Vintage)
Default: null

A list of building vintages (e.g. ASHRAE_2019, ASHRAE_2016).

{
  • "type": "ProjectInfo",
  • "north": 0,
  • "weather_urls": null,
  • "location": null,
  • "ashrae_climate_zone": null,
  • "building_type": null,
  • "vintage": null
}