urbanopt-geojson 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10b59cfe6793461aa576b46a244409a271515262b58da7b2c2927eac78714c36
-  data.tar.gz: e1c9e8000666ba3daea0f6e93aad3af9df87d637d268ba3c856bea7709111d21
+  metadata.gz: 80cfe0ae8967e2b541207fa35a636db0ed735ca897220bca8b3c7525c635ccae
+  data.tar.gz: 151a2efe67159078c82cc8cdf6edcaec39e777597c11aeb09f678c408b458370
 SHA512:
-  metadata.gz: e4d16b3b4e08d93bbb3c9d070928ee29cafcb34f101fa61d6532d819d4adbf44e956e5bc02d45558b05fc1d0a8ba0fcf9c10b6bc5a0ee09b9616e540e75c5ebb
-  data.tar.gz: 0115c244f9bf66bf41d4a46bfafa9341b071b543cf773ee7de813316c4ebb23755468b6b1a37efc92a6a94639c07080d7b26f6133cfde5c6d8098bae21d4a531
+  metadata.gz: 1ee7f22be5bba1aa611dcface714342ec167bb54ad4670fb6d162bbf9da24c25026f033f68dd2641dd6651a3af93dbe736b36a6df84e46f3632c14ffe040691d
+  data.tar.gz: 1670592b66f9dc9d23bd7cfb09fbcf223712cf012cb0273ed619c4b8d1e65cc30a2046efaa6edf939bfeaf897fef8665b23300081e86ae3b87b69722ae17bd32

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # URBANopt GeoJSON Gem
  
+## Version 0.3.1
+Date Range 06/05/20 - 08/07/20
+
+Accepted Pull Requests: 9
+- Fixed [#77]( https://github.com/urbanopt/urbanopt-geojson-gem/pull/77 ), Bump acorn from 6.1.1 to 6.4.1 in /docs
+- Fixed [#92]( https://github.com/urbanopt/urbanopt-geojson-gem/pull/92 ), Adds scaling for building footprint using building area
+- Fixed [#98]( https://github.com/urbanopt/urbanopt-geojson-gem/pull/98 ), Add method to determine centroid for features
+- Fixed [#99]( https://github.com/urbanopt/urbanopt-geojson-gem/pull/99 ), Adds test to check footprint area
+- Fixed [#100]( https://github.com/urbanopt/urbanopt-geojson-gem/pull/100 ), Bump lodash from 4.17.15 to 4.17.19 in /docs
+- Fixed [#102]( https://github.com/urbanopt/urbanopt-geojson-gem/pull/102 ), make connector-type optional on electrical junction
+- Fixed [#103]( https://github.com/urbanopt/urbanopt-geojson-gem/pull/103 ), Bump elliptic from 6.4.1 to 6.5.3 in /docs
+- Fixed [#104]( https://github.com/urbanopt/urbanopt-geojson-gem/pull/104 ), bump minimist and dot-prop versions
+- Fixed [#108]( https://github.com/urbanopt/urbanopt-geojson-gem/pull/108 ), Schema errors (issues 105, 106, and 107)
+
 ## Version 0.3.0
 
 Date Range 3/25/20 - 06/04/20

data/docs/package-lock.json

@@ -1180,9 +1180,9 @@
       }
     },
     "acorn": {
-      "version": "6.1.1",
-      "resolved": "https://registry.npmjs.org/acorn/-/acorn-6.1.1.tgz",
-      "integrity": "sha512-jPTiwtOxaHNaAPg/dmrJ/beuzLRnXtB0kQPQ8JpotKJgTB6rX6c8mlf315941pyjBSaPg8NHXS9fhP4u17DpGA=="
+      "version": "6.4.1",
+      "resolved": "https://registry.npmjs.org/acorn/-/acorn-6.4.1.tgz",
+      "integrity": "sha512-ZVA9k326Nwrj3Cj9jlh3wGFutC2ZornPNARZwsNYqQYgN0EsV2d53w5RN/co65Ohn4sUAUtb1rSUAOD6XN9idA=="
     },
     "acorn-dynamic-import": {
       "version": "4.0.0",
@@ -3513,9 +3513,9 @@
       "integrity": "sha512-p1pgKOSSgcROCRiZoJ5H5wFmhqdA0L3yLL9mlfcmdA4V60IDCrsvhNqN8rLPe9e3B772Gm02kBkL1GM/g2lENg=="
     },
     "elliptic": {
-      "version": "6.4.1",
-      "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.4.1.tgz",
-      "integrity": "sha512-BsXLz5sqX8OHcsh7CqBMztyXARmGQ3LWPtGjJi6DiJHq5C/qvi9P3OqgswKSDftbu8+IoI/QDTAm2fFnQ9SZSQ==",
+      "version": "6.5.3",
+      "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.5.3.tgz",
+      "integrity": "sha512-IMqzv5wNQf+E6aHeIqATs0tOLeOTwj1QKbRcS3jBbYkl5oLAserA8yJTT7/VyHUYG91PRmPyeQDObKLPpeS4dw==",
       "requires": {
         "bn.js": "^4.4.0",
         "brorand": "^1.0.1",
@@ -5733,9 +5733,9 @@
       "integrity": "sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA=="
     },
     "json-formatter-js": {
-      "version": "2.2.1",
-      "resolved": "https://registry.npmjs.org/json-formatter-js/-/json-formatter-js-2.2.1.tgz",
-      "integrity": "sha1-sQHWKOhvAo3Jz5p+HIPGXlNsn4c="
+      "version": "2.3.4",
+      "resolved": "https://registry.npmjs.org/json-formatter-js/-/json-formatter-js-2.3.4.tgz",
+      "integrity": "sha512-gmAzYRtPRmYzeAT4T7+t3NhTF89JOAIioCVDddl9YDb3ls3kWcskirafw/MZGJaRhEU6fRimGJHl7CC7gaAI2Q=="
     },
     "json-parse-better-errors": {
       "version": "1.0.2",
@@ -6050,9 +6050,9 @@
       }
     },
     "lodash": {
-      "version": "4.17.15",
-      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz",
-      "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A=="
+      "version": "4.17.19",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.19.tgz",
+      "integrity": "sha512-JNvd8XER9GQX0v2qJgsaN/mzFCNA5BRe/j8JN9d+tWyGLSodKQHKFicdwNYzWwI3wjRnaKPsGj1XkBjx/F96DQ=="
     },
     "lodash._reinterpolate": {
       "version": "3.0.0",
@@ -9361,9 +9361,9 @@
       "integrity": "sha1-jcrkcOHIirwtYA//Sndihtp15jc="
     },
     "replace-ext": {
-      "version": "1.0.0",
-      "resolved": "https://registry.npmjs.org/replace-ext/-/replace-ext-1.0.0.tgz",
-      "integrity": "sha1-3mMSg3P8v3w8z6TeWkgMRaZ5WOs="
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/replace-ext/-/replace-ext-1.0.1.tgz",
+      "integrity": "sha512-yD5BHCe7quCgBph4rMQ+0KkIRKwWCrHDOX1p1Gp6HwjPM5kVoCdKGNhN7ydqqsX6lJEnQDKZ/tFMiEdQ1dvPEw=="
     },
     "request": {
       "version": "2.88.0",

data/docs/package.json

@@ -18,10 +18,12 @@
   },
   "devDependencies": {
     "braces": ">=2.3.1",
+    "dot-prop": ">=5.1.1",
     "gh-pages": "^2.0.1",
     "js-yaml": ">=3.13.1",
-    "lodash": ">=4.17.12",
+    "lodash": ">=4.17.19",
     "lodash.template": ">=4.5.0",
+    "minimist": ">=1.2.3",
     "mixin-deep": ">=1.3.2",
     "serialize-javascript": ">=2.1.1",
     "set-value": ">=2.0.1"

data/lib/measures/.rubocop.yml

@@ -2,4 +2,4 @@ AllCops:
   Exclude:
     - 'spec/test_measures/**/*'
 inherit_from:
-  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop.yml
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v3.yml

data/lib/measures/urban_geometry_creation/measure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *********************************************************************************
 # URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.

data/lib/measures/urban_geometry_creation/measure.xml

@@ -1,9 +1,10 @@
+<?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
   <name>urban_geometry_creation</name>
   <uid>5ab85d6b-c9af-4361-8ab9-613ee99a5666</uid>
-  <version_id>cf023329-6ef3-43b3-a316-b08fabb47cd2</version_id>
-  <version_modified>20200327T211951Z</version_modified>
+  <version_id>e32672b2-91b1-4b62-9770-7712cab86004</version_id>
+  <version_modified>20200807T210717Z</version_modified>
   <xml_checksum>D254E772</xml_checksum>
   <class_name>UrbanGeometryCreation</class_name>
   <display_name>UrbanGeometryCreation</display_name>
@@ -46,8 +47,8 @@
       </choices>
     </argument>
   </arguments>
-  <outputs/>
-  <provenances/>
+  <outputs />
+  <provenances />
   <tags>
     <tag>Envelope.Form</tag>
   </tags>
@@ -102,17 +103,23 @@
       <usage_type>test</usage_type>
       <checksum>40290298</checksum>
     </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>A09F345D</checksum>
+    </file>
     <file>
       <filename>shadowed_tests.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>861137CF</checksum>
+      <checksum>4E51A05C</checksum>
     </file>
     <file>
       <filename>urban_geometry_creation_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>6DED5C96</checksum>
+      <checksum>DDAD6BFA</checksum>
     </file>
     <file>
       <version>
@@ -123,19 +130,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>1A6BAAFA</checksum>
-    </file>
-    <file>
-      <filename>out.txt</filename>
-      <filetype>txt</filetype>
-      <usage_type>test</usage_type>
-      <checksum>C5B18B73</checksum>
-    </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>A09F345D</checksum>
+      <checksum>2F8C09F7</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/urban_geometry_creation_zoning/measure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *********************************************************************************
 # URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.

data/lib/measures/urban_geometry_creation_zoning/measure.xml

@@ -1,9 +1,10 @@
+<?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
   <name>urban_geometry_creation_zoning</name>
   <uid>96ea1317-76ac-4670-b51d-71ee3f4fdd65</uid>
-  <version_id>5109b19e-6300-4068-900e-8a989b9762c8</version_id>
-  <version_modified>20200327T211951Z</version_modified>
+  <version_id>884d6eb0-6517-40dc-96ca-ac4db7c2ad7d</version_id>
+  <version_modified>20200807T210718Z</version_modified>
   <xml_checksum>D254E772</xml_checksum>
   <class_name>UrbanGeometryCreationZoning</class_name>
   <display_name>UrbanGeometryCreationZoning</display_name>
@@ -46,8 +47,8 @@
       </choices>
     </argument>
   </arguments>
-  <outputs/>
-  <provenances/>
+  <outputs />
+  <provenances />
   <tags>
     <tag>Envelope.Form</tag>
   </tags>
@@ -102,6 +103,12 @@
       <usage_type>license</usage_type>
       <checksum>EA283B74</checksum>
     </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>0458EE16</checksum>
+    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
@@ -111,25 +118,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>EF1B3E84</checksum>
-    </file>
-    <file>
-      <filename>out.txt</filename>
-      <filetype>txt</filetype>
-      <usage_type>test</usage_type>
-      <checksum>7FAF05F3</checksum>
+      <checksum>2505C43D</checksum>
     </file>
     <file>
       <filename>urban_geometry_creation_zoning_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>60BFE46B</checksum>
-    </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>0458EE16</checksum>
+      <checksum>986CB63E</checksum>
     </file>
   </files>
 </measure>

data/lib/urbanopt/geojson/feature.rb

@@ -47,7 +47,6 @@ module URBANopt
       # rubocop:disable Style/MethodMissing
       def method_missing(name, *args, &blk)
         # rubocop:enable Style/MethodMissing
-        # rubocop:disable Style/GuardClause
         if @feature_json[:properties].keys.map(&:to_sym).include? name.to_sym
           # rubocop:enable Style/GuardClause
           return @feature_json[:properties][name.to_sym]
@@ -168,6 +167,38 @@ module URBANopt
         return OpenStudio::PointLatLon.new(min_lat, min_lon, 0)
       end
 
+      ##
+      # Used to determine the centroid for the feature's coordinates.
+      #
+      # [Parameters]
+      # * +vertices+ - The first set polygon vertices in the array of feature coordinates.
+      def find_feature_center(vertices)
+        number_of_locations = vertices.length
+
+        return vertices.first if number_of_locations == 1
+
+        x = y = z = 0.0
+        vertices.each do |station|
+          latitude = station[0] * Math::PI / 180
+          longitude = station[1] * Math::PI / 180
+
+          x += Math.cos(latitude) * Math.cos(longitude)
+          y += Math.cos(latitude) * Math.sin(longitude)
+          z += Math.sin(latitude)
+        end
+
+        x /= number_of_locations
+        y /= number_of_locations
+        z /= number_of_locations
+
+        central_longitude = Math.atan2(y, x)
+        central_square_root = Math.sqrt(x * x + y * y)
+        central_latitude = Math.atan2(z, central_square_root)
+
+        [central_latitude * 180 / Math::PI,
+         central_longitude * 180 / Math::PI]
+      end
+
       private
 
       ##

data/lib/urbanopt/geojson/geo_file.rb

@@ -161,7 +161,6 @@ module URBANopt
           if f[:properties] && f[:properties][:id] == feature_id
             # merge site origin properties
             f = merge_site_properties(f)
-            # rubocop:disable Style/GuardClause
             if f[:properties][:type] == 'Building'
               # rubocop:enable Style/GuardClause
               return URBANopt::GeoJSON::Building.new(f)

data/lib/urbanopt/geojson/helper.rb

@@ -154,7 +154,7 @@ module URBANopt
         stories.each_index do |i|
           space_type = nil
           space = stories[i].spaces.first
-          if space && space.spaceType.is_initialized
+          if space&.spaceType&.is_initialized
             space_type = space.spaceType.get
           else
             space_type = OpenStudio::Model::SpaceType.new(model)
@@ -243,6 +243,7 @@ module URBANopt
             if number_of_stories_above_ground.nil?
               number_of_stories_above_ground = number_of_stories
               number_of_stories_below_ground = 0
+
             else
               number_of_stories_below_ground = number_of_stories - number_of_stories_above_ground
             end
@@ -251,6 +252,13 @@ module URBANopt
             if number_of_stories_above_ground && number_of_stories_above_ground > 0 && maximum_roof_height
               floor_to_floor_height = maximum_roof_height / number_of_stories_above_ground
             end
+
+            # check that feature has a # stories
+            if number_of_stories_above_ground.nil?
+              runner.registerWarning("[geojson process_other_buildings] Unable to include feature #{other_building[:properties][:id]} in shading calculations: no 'number of stories' data")
+            end
+            next if number_of_stories_above_ground.nil?
+
             other_height = number_of_stories_above_ground * floor_to_floor_height
             # find the polygon of the other_building by passing it to the get_multi_polygons method
             other_building_points = building.other_points(other_building, other_height, origin_lat_lon, runner, zoning)

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

@@ -296,6 +296,9 @@
       "properties": {
         "building_type": {
           "enum": [
+            "Single-Family",
+            "Multifamily (2 to 4 units)",
+            "Multifamily (5 or more units)",
             "Vacant",
             "Office",
             "Laboratory",
@@ -341,6 +344,9 @@
         "Single-Family Detached",
         "Single-Family Attached",
         "Multifamily",
+        "Single-Family",
+        "Multifamily (2 to 4 units)",
+        "Multifamily (5 or more units)",
         "Vacant",
         "Office",
         "Laboratory",

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

@@ -1,8 +1,8 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "id": "http://json-schema.org/openstudio-urban-modeling/district_system_properties.json#",
-  "title": "URBANopt Electrical Line",
-  "description": "Schema for an URBANopt Electrical Line object",
+  "id": "http://json-schema.org/openstudio-urban-modeling/electrical_connector_properties.json#",
+  "title": "URBANopt Electrical Connector",
+  "description": "Schema for an URBANopt Electrical Connector object",
   "type": "object",
   "properties": {
     "id": {
@@ -17,7 +17,7 @@
       "description": "Type of feature.",
       "type": "string",
       "enum": [
-        "ElectricalLine"
+        "ElectricalConnector"
       ]
     },
     "source_name": {
@@ -46,7 +46,7 @@
       "description": "Total length (ft) of the line, generated on export.",
       "type": "number"
     },
-    "start_junction_id": {
+    "startJunctionId": {
       "description": "Id of the junction that this line starts at.",
       "type": "string"
     },
@@ -67,7 +67,7 @@
             "type": "string"
         }
     },
-    "end_junction_id": {
+    "endJunctionId": {
       "description": "Id of the junction that this line ends at.",
       "type": "string"
     },
@@ -79,8 +79,8 @@
     "type",
     "id",
     "connector_type",
-    "start_junction_id",
-    "end_junction_id"
+    "startJunctionId",
+    "endJunctionId"
   ],
   "additionalProperties": false,
   "definitions": {

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

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "id": "http://json-schema.org/openstudio-urban-modeling/district_system_properties.json#",
+  "id": "http://json-schema.org/openstudio-urban-modeling/electrical_junction_properties.json#",
   "title": "URBANopt Electrical Junction",
   "description": "Schema for an URBANopt Electrical Junction object",
   "type": "object",
@@ -35,11 +35,11 @@
     "connector_type": {
       "$ref": "#/definitions/ElectricalJunctionType"
     },
-    "building_id": {
+    "buildingId": {
       "description": "Id of building if this junction is inside a building.",
       "type": "string"
     },
-    "district_system_id": {
+    "DSId": {
       "description": "Id of district system if this junction is inside a district system.",
       "type": "string"
     },
@@ -49,8 +49,7 @@
   },
   "required": [
     "type",
-    "id",
-    "connector_type"
+    "id"
   ],
   "additionalProperties": false,
   "definitions": {

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

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "id": "http://json-schema.org/openstudio-urban-modeling/district_system_properties.json#",
+  "id": "http://json-schema.org/openstudio-urban-modeling/thermal_connector_properties.json#",
   "title": "URBANopt Thermal Connector",
   "description": "Schema for an URBANopt Thermal Connector object",
   "type": "object",

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

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "id": "http://json-schema.org/openstudio-urban-modeling/district_system_properties.json#",
+  "id": "http://json-schema.org/openstudio-urban-modeling/thermal_junction_properties.json#",
   "title": "URBANopt Thermal Junction",
   "description": "Schema for an URBANopt Thermal Junction object",
   "type": "object",

data/lib/urbanopt/geojson/version.rb

@@ -30,6 +30,6 @@
 
 module URBANopt
   module GeoJSON
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.3.1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-geojson
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Tanushree Charan
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -216,7 +216,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Library and measures to translate URBANopt GeoJSON format to OpenStudio