urbanopt-geojson 0.1.0

data/lib/urbanopt/geojson/schema/region_properties.json

@@ -0,0 +1,93 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "http://json-schema.org/openstudio-urban-modeling/region_properties.json#",
+  "title": "URBANopt Region",
+  "description": "Schema for an URBANopt Region object",
+  "type": "object",
+  "properties": {
+    "id": {
+      "description": "Unique id used to refer to this feature within this dataset.",
+      "type": "string"
+    },
+    "project_id": {
+      "description": "Project which this feature belongs to.",
+      "type": "string"
+    },
+    "type": {
+      "description": "Type of feature.",
+      "type": "string",
+      "enum": [
+        "Region"
+      ]
+    },
+    "region_type": {
+      "description": "Type of region.",
+      "type": "string",
+      "enum": [
+        "Taxlot",
+        "Park",
+        "Road",
+        "Lake",
+        "Obstacle"
+      ]
+    },
+    "source_name": {
+      "description": "Name of the original data source.",
+      "type": "string"
+    },
+    "source_id": {
+      "description": "Id of the feature in original data source.",
+      "type": "string"
+    },
+    "name": {
+      "description": "Feature name.",
+      "type": "string"
+    },
+    "legal_name": {
+      "description": "Legal name used to identify this feature.",
+      "type": "string"
+    },
+    "address": {
+      "description": "Street address.",
+      "type": "string"
+    },
+    "footprint_area": {
+      "description": "Area of the footprint (ft^2).  Calculated on export.",
+      "type": "number"
+    },
+    "footprint_perimeter": {
+      "description": "Perimeter of the footprint (ft). Calculated on export.",
+      "type": "number"
+    },
+    "exterior_lighting_zone": {
+      "description": "Choice of exterior lighting zone.",
+      "type": "string",
+      "enum": [
+        "0 - Undeveloped Areas Parks",
+        "1 - Developed Areas Parks",
+        "2 - Neighborhood",
+        "3 - All Other Areas",
+        "4 - High Activity"
+      ]
+    },
+    "taxlot_zoning": {
+      "description": "Type of zoning if this feature is a taxlot.",
+      "type": "string",
+      "enum": [
+        "Vacant",
+        "Mixed",
+        "Residential",
+        "Commercial",
+        "OpenSpace"
+      ]
+    },
+    "user_data": {
+      "description": "Arbitrary user data"
+    }
+  },
+  "required": [
+    "type",
+    "region_type"
+  ],
+  "additionalProperties": false
+}

data/lib/urbanopt/geojson/schema/site_properties.json

@@ -0,0 +1,87 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "http://json-schema.org/openstudio-urban-modeling/taxlot_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"
+    },
+    "import_surrounding_buildings_as_shading": {
+      "description": "If true, import geometry from surrounding buildings when performing energy calculations.",
+      "type": "boolean"
+    },
+    "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"
+    },
+    "cec_climate_zone": {
+      "description": "CEC Title24 climate zone.",
+      "type": "string"
+    },
+    "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"
+    },
+    "user_data": {
+      "description": "Arbitrary user data"
+    }
+  },
+  "required": [
+    "latitude",
+    "longitude"
+  ],
+  "additionalProperties": false
+}

data/lib/urbanopt/geojson/schema/thermal_connector_properties.json

@@ -0,0 +1,107 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "http://json-schema.org/openstudio-urban-modeling/district_system_properties.json#",
+  "title": "URBANopt Thermal Connector",
+  "description": "Schema for an URBANopt Thermal Connector object",
+  "type": "object",
+  "properties": {
+    "id": {
+      "description": "Unique id used to refer to this feature within this dataset.",
+      "type": "string"
+    },
+    "project_id": {
+      "description": "Project which this feature belongs to.",
+      "type": "string"
+    },
+    "type": {
+      "description": "Type of feature.",
+      "type": "string",
+      "enum": [
+        "ThermalConnector"
+      ]
+    },
+    "source_name": {
+      "description": "Name of the original data source.",
+      "type": "string"
+    },
+    "source_id": {
+      "description": "Id of the feature in original data source.",
+      "type": "string"
+    },
+    "name": {
+      "description": "Feature name",
+      "type": "string"
+    },
+    "connector_type": {
+      "$ref": "#/definitions/ThermalConnectorType"
+    },
+    "lengths": {
+      "description": "Length of each segment in ft, generated on export.",
+      "type": "array",
+      "items": {
+        "type": "number"
+      }
+    },
+    "total_length": {
+      "description": "Total length of the connector in ft, generated on export.",
+      "type": "number"
+    },
+    "start_junction_id": {
+      "description": "Id of the junction that this connector starts at.",
+      "type": "string"
+    },
+    "end_junction_id": {
+      "description": "Id of the junction that this connector ends at.",
+      "type": "string"
+    },
+    "fluid_temperature_type": {
+      "description": "Classification of temperature range of fluid in this connector",
+      "$ref": "#/definitions/TemperatureType"
+    },
+    "flow_direction": {
+      "description": "Charcterization of connector, relative to the central plant",
+      "$ref": "#/definitions/FlowDirection"
+    },
+    "user_data": {
+      "description": "Arbitrary user data"
+    }
+  },
+  "required": [
+    "type",
+    "connector_type",
+    "start_junction_id",
+    "end_junction_id",
+    "fluid_temperature_type",
+    "flow_direction"
+  ],
+  "additionalProperties": false,
+  "definitions": {
+    "ThermalConnectorType": {
+      "description": "Type of thermal connector.",
+      "type": "string",
+      "enum": [
+        "OnePipe",
+        "TwoPipe",
+        "ThreePipe",
+        "FourPipe"
+      ]
+    },
+    "TemperatureType": {
+      "description": "Temperature of fluid flowing in connector.",
+      "type": "string",
+      "enum": [
+        "Hot",
+        "Cold",
+        "Ambient"
+      ]
+    },
+    "FlowDirection": {
+      "description": "Direction of flow from start junction to end junction.",
+      "type": "string",
+      "enum": [
+        "Supply",
+        "Return"
+      ]
+    }
+  }
+}

data/lib/urbanopt/geojson/schema/thermal_junction_properties.json

@@ -0,0 +1,83 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "http://json-schema.org/openstudio-urban-modeling/district_system_properties.json#",
+  "title": "URBANopt Thermal Junction",
+  "description": "Schema for an URBANopt Thermal Junction object",
+  "type": "object",
+  "properties": {
+    "id": {
+      "description": "Unique id used to refer to this feature within this dataset.",
+      "type": "string"
+    },
+    "project_id": {
+      "description": "Project which this feature belongs to.",
+      "type": "string"
+    },
+    "type": {
+      "description": "Type of feature.",
+      "type": "string",
+      "enum": [
+        "ThermalJunction"
+      ]
+    },
+    "source_name": {
+      "description": "Name of the original data source.",
+      "type": "string"
+    },
+    "source_id": {
+      "description": "Id of the feature in original data source.",
+      "type": "string"
+    },
+    "name": {
+      "description": "Feature name",
+      "type": "string"
+    },
+    "connector_type": {
+      "$ref": "#/definitions/ThermalJunctionType"
+    },
+    "building_id": {
+      "description": "Id of building if this junction is inside a building.",
+      "type": "string"
+    },
+    "district_system_id": {
+      "description": "Id of district system if this junction is inside a district system.",
+      "type": "string"
+    },
+    "pump_presence": {
+      "description": "Presence of pump: true if present, false if absent",
+      "type": "boolean"
+    },
+    "connection_type": {
+      "description": "Characterize the connection as series or parallel",
+      "$ref": "#/definitions/ThermalJunctionConnectionType"
+    },
+    "user_data": {
+      "description": "Arbitrary user data"
+    }
+  },
+  "required": [
+    "type",
+    "connector_type",
+    "connection_type"
+  ],
+  "additionalProperties": false,
+  "definitions": {
+    "ThermalJunctionType": {
+      "description": "Type of thermal junction.",
+      "type": "string",
+      "enum": [
+        "DES",
+        "ETS",
+        "Valve"
+      ]
+    },
+    "ThermalJunctionConnectionType": {
+      "description": "Type of connection for connectors meeting at this junction.",
+      "type": "string",
+      "enum": [
+        "Series",
+        "Parallel"
+      ]
+    }
+  }
+}

data/lib/urbanopt/geojson/update_areas.rb

@@ -0,0 +1,102 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+require 'openstudio'
+require 'json'
+
+file = ARGV[0]
+
+geojson = JSON.parse(File.open(file, 'r').read, symbolize_names: true)
+
+geojson[:features].each do |feature|
+  properties = feature[:properties]
+  geometry = feature[:geometry]
+
+  number_of_stories = properties[:number_of_stories]
+  if number_of_stories.nil?
+    number_of_stories = 1
+  end
+
+  maximum_roof_height = properties[:maximum_roof_height]
+  # if maximum_roof_height.nil?
+  maximum_roof_height = 10 * number_of_stories
+  # end
+
+  multi_polygons = nil
+  if geometry[:type] == 'Polygon'
+    polygons = geometry[:coordinates]
+    multi_polygons = [polygons]
+  elsif geometry[:type] == 'MultiPolygon'
+    multi_polygons = geometry[:coordinates]
+  end
+
+  area = 0
+  distance = 0
+  multi_polygons[0].each do |polygon|
+    origin_lat_lon = nil
+    floor_print = OpenStudio::Point3dVector.new
+    polygon.each do |p|
+      lon = p[0]
+      lat = p[1]
+      origin_lat_lon = OpenStudio::PointLatLon.new(lat, lon, 0) if origin_lat_lon.nil?
+      point_3d = origin_lat_lon.toLocalCartesian(OpenStudio::PointLatLon.new(lat, lon, 0))
+      point_3d = OpenStudio::Point3d.new(point_3d.x, point_3d.y, 0)
+      floor_print << point_3d
+    end
+    area += OpenStudio.getArea(floor_print).get
+
+    polygon.each_index do |i|
+      if i == (polygon.size - 1)
+        distance += OpenStudio.getDistance(floor_print[i], floor_print[0])
+      else
+        distance += OpenStudio.getDistance(floor_print[i], floor_print[i + 1])
+      end
+    end
+  end
+
+  if number_of_stories == 0
+    floor_area = area
+  else
+    floor_area = number_of_stories * area
+  end
+
+  properties[:footprint_area] = OpenStudio.convert(area, 'm^2', 'ft^2').get
+  properties[:footprint_perimeter] = OpenStudio.convert(distance, 'm', 'ft').get
+  properties[:floor_area] = OpenStudio.convert(floor_area, 'm^2', 'ft^2').get
+  properties[:number_of_stories] = number_of_stories
+  properties[:maximum_roof_height] = maximum_roof_height
+
+  # Point3d toLocalCartesian(const PointLatLon& point) const;
+  # std::vector<Point3d> toLocalCartesian(const std::vector<PointLatLon>& points) const;
+end
+
+File.open(ARGV[0], 'w') do |file|
+  file << JSON.pretty_generate(geojson)
+end