view raw
URBANopt Site {
Schema for an URBANopt Site object
id:
string
Unique id used to refer to this feature within this dataset, generated by database.
project_id:
string
Project which this feature belongs to.
latitude:
number
Latitude of site origin in WGS 84 coordinate system (deg)
longitude:
number
Longitude of site origin in WGS 84 coordinate system (deg)
surface_elevation:
number,null
The surface elevation (above NAVD88 datum) of the project (ft).
import_surrounding_buildings_as_shading:
boolean,null
If true, import geometry from surrounding buildings when performing energy calculations.
timesteps_per_hour:
integer
minimum:1
maximum:60
Number of timesteps per hour for energy simulations.
begin_date:
string
Date to begin simulation, format YYYY-MM-DD.
end_date:
string
Date to end simulation, format YYYY-MM-DD.
climate_zone:
string,null
ASHRAE 169 climate zone.
cec_climate_zone:
string,null
CEC Title24 climate zone.
default_template:
string
Default OpenStudio Standards template.
weather_filename:
string
Name of weather file in EPW format.
tariff_filename:
string,null
Name of utility tariff file in IDF or URDB format.
underground_cables_ratio:
number
Ratio of overall cables that are underground vs. overhead for RNM analysis.
only_lv_consumers:
boolean
If true, only low voltage consumers will be considered in the RNM analysis.
max_number_of_lv_nodes_per_building:
number
Maximum number of low voltage nodes to represent a single building.
emissions:
boolean
Should be set to true to calculate electricity emissions for the associated building.
electricity_emissions_future_subregion:
string
Future subregion for electricity emssions. Options: AZNMc, CAMXc, ERCTc, FRCCc, MROEc, MROWc, NEWEc, NWPPc, NYSTc, RFCEc, RFCMc, RFCWc, RMPAc, SPNOc, SPSOc, SRMVc, SRMWc, SRSOc, SRTVc, and SRVCc
electricity_emissions_hourly_historical_subregion:
string
Historical hourly subregion for electricity emissions. Options: California, Carolinas, Central, Florida, Mid-Atlantic, Midwest, New England, New York, Northwest, Rocky Mountains, Southeast, Southwest, Tennessee, and Texas
electricity_emissions_annual_historical_subregion:
string
Historical annual subregion for electricity emissions. Options: AKGD, AKMS, AZNM, CAMX, ERCT, FRCC, HIMS, HIOA, MROE, MROW, NEWE, NWPP, NYCW, NYLI, NYUP, RFCE, RFCM, RFCW, RMPA, SPNO, SPSO, SRMV, SRMW, SRSO, SRTV, and SRVC
electricity_emissions_future_year:
string
Future Year for electricity emissions. Options: 2020 to 2050 in two year increments
electricity_emissions_hourly_historical_year:
string
Hourly Historical Year for elecrtricity emissions. Options: 2019.
electricity_emissions_annual_historical_year:
string
Annual Historical Year for electricity emissions. Options: 2007, 2009, 2010, 2012, 2014, 2016, 2018, and 2019.
}
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://json-schema.org/openstudio-urban-modeling/site_properties.json#",
"title": "URBANopt Site",
"description": "Schema for an URBANopt Site object",
"type": "object",
"properties": {
"id": {
"description": "Unique id used to refer to this feature within this dataset, generated by database.",
"type": "string"
},
"project_id": {
"description": "Project which this feature belongs to.",
"type": "string"
},
"name": {
"description": "Feature name",
"type": "string"
},
"state": {
"description": "State name",
"type": "string"
},
"city": {
"description": "City name",
"type": "string"
},
"latitude": {
"description": "Latitude of site origin in WGS 84 coordinate system (deg)",
"type": "number"
},
"longitude": {
"description": "Longitude of site origin in WGS 84 coordinate system (deg)",
"type": "number"
},
"surface_elevation": {
"description": "The surface elevation (above NAVD88 datum) of the project (ft). ",
"type": [
"number",
"null"
]
},
"import_surrounding_buildings_as_shading": {
"description": "If true, import geometry from surrounding buildings when performing energy calculations.",
"type": [
"boolean",
"null"
]
},
"timesteps_per_hour": {
"description": "Number of timesteps per hour for energy simulations.",
"type": "integer",
"minimum": 1,
"maximum": 60
},
"begin_date": {
"description": "Date to begin simulation, format YYYY-MM-DD.",
"type": "string"
},
"end_date": {
"description": "Date to end simulation, format YYYY-MM-DD.",
"type": "string"
},
"climate_zone": {
"description": "ASHRAE 169 climate zone.",
"type": [
"string",
"null"
]
},
"cec_climate_zone": {
"description": "CEC Title24 climate zone.",
"type": [
"string",
"null"
]
},
"default_template": {
"description": "Default OpenStudio Standards template.",
"type": "string"
},
"weather_filename": {
"description": "Name of weather file in EPW format.",
"type": "string"
},
"tariff_filename": {
"description": "Name of utility tariff file in IDF or URDB format.",
"type": [
"string",
"null"
]
},
"underground_cables_ratio": {
"description": "Ratio of overall cables that are underground vs. overhead for RNM analysis.",
"type": "number"
},
"only_lv_consumers": {
"description": "If true, only low voltage consumers will be considered in the RNM analysis.",
"type": "boolean"
},
"max_number_of_lv_nodes_per_building": {
"description": "Maximum number of low voltage nodes to represent a single building.",
"type": "number"
},
"emissions": {
"description": "Should be set to true to calculate electricity emissions for the associated building.",
"type": "boolean"
},
"electricity_emissions_future_subregion": {
"description": "Future subregion for electricity emssions. Options: AZNMc, CAMXc, ERCTc, FRCCc, MROEc, MROWc, NEWEc, NWPPc, NYSTc, RFCEc, RFCMc, RFCWc, RMPAc, SPNOc, SPSOc, SRMVc, SRMWc, SRSOc, SRTVc, and SRVCc",
"type": "string",
"enum": [
"AZNMc",
"CAMXc",
"ERCTc",
"FRCCc",
"MROEc",
"MROWc",
"NEWEc",
"NWPPc",
"NYSTc",
"RFCEc",
"RFCMc",
"RFCWc",
"RMPAc",
"SPNOc",
"SPSOc",
"SRMVc",
"SRMWc",
"SRSOc",
"SRTVc",
"SRVCc"
]
},
"electricity_emissions_hourly_historical_subregion": {
"description": "Historical hourly subregion for electricity emissions. Options: California, Carolinas, Central, Florida, Mid-Atlantic, Midwest, New England, New York, Northwest, Rocky Mountains, Southeast, Southwest, Tennessee, and Texas",
"type": "string",
"enum": [
"California",
"Carolinas",
"Central",
"Florida",
"Mid-Atlantic",
"Midwest",
"New England",
"New York",
"Northwest",
"Rocky Mountains",
"Southeast",
"Southwest",
"Tennessee",
"Texas"
]
},
"electricity_emissions_annual_historical_subregion": {
"description": "Historical annual subregion for electricity emissions. Options: AKGD, AKMS, AZNM, CAMX, ERCT, FRCC, HIMS, HIOA, MROE, MROW, NEWE, NWPP, NYCW, NYLI, NYUP, RFCE, RFCM, RFCW, RMPA, SPNO, SPSO, SRMV, SRMW, SRSO, SRTV, and SRVC",
"type": "string",
"enum": [
"AKGD",
"AKMS",
"AZNM",
"CAMX",
"ERCT",
"FRCC",
"HIMS",
"HIOA",
"MROE",
"MROW",
"NEWE",
"NWPP",
"NYCW",
"NYLI",
"NYUP",
"RFCE",
"RFCM",
"RFCW",
"RMPA",
"SPNO",
"SPSO",
"SRMV",
"SRMW",
"SRSO",
"SRTV",
"SRVC"
]
},
"electricity_emissions_future_year": {
"description": "Future Year for electricity emissions. Options: 2020 to 2050 in two year increments",
"type": "string",
"enum": [
"2020",
"2022",
"2024",
"2026",
"2028",
"2030",
"2032",
"2034",
"2036",
"2038",
"2040",
"2042",
"2044",
"2046",
"2048",
"2050"
]
},
"electricity_emissions_hourly_historical_year": {
"description": "Hourly Historical Year for elecrtricity emissions. Options: 2019.",
"type": "string",
"enum": [
"2019"
]
},
"electricity_emissions_annual_historical_year": {
"description": "Annual Historical Year for electricity emissions. Options: 2007, 2009, 2010, 2012, 2014, 2016, 2018, and 2019.",
"type": "string",
"enum": [
"2007",
"2009",
"2010",
"2012",
"2014",
"2016",
"2018",
"2019"
]
}
},
"required": [],
"additionalProperties": false
}