urbanopt-geojson 0.3.0 → 0.5.2

data/docs/package.json

@@ -10,20 +10,24 @@
   },
   "author": "Brian Schiller",
   "dependencies": {
-    "highlight.js": "^9.15.6",
-    "json-schema-ref-parser": "^6.1.0",
+    "highlight.js": "^10.4.1",
+    "json-schema-ref-parser": "^9.0.6",
     "json-schema-view-js": "git+https://git@github.com/bgschiller/json-schema-view-js.git",
-    "vuepress": "^0.14.10",
+    "vuepress": "^1.5.4",
     "webpack-dev-middleware": "^3.6.0"
   },
   "devDependencies": {
-    "braces": ">=2.3.1",
-    "gh-pages": "^2.0.1",
+    "braces": "^3.0.2",
+    "dot-prop": ">=5.1.1",
+    "gh-pages": "^3.1.0",
     "js-yaml": ">=3.13.1",
-    "lodash": ">=4.17.12",
+    "lodash": ">=4.17.19",
     "lodash.template": ">=4.5.0",
-    "mixin-deep": ">=1.3.2",
-    "serialize-javascript": ">=2.1.1",
-    "set-value": ">=2.0.1"
+    "minimist": ">=1.2.3",
+    "mixin-deep": "^2.0.1",
+    "serialize-javascript": "^5.0.1",
+    "set-value": "^3.0.2",
+    "yargs-parser": "^20.2.3",
+    "ini": "^2.0.0"
   }
 }

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/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
+URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, 

data/lib/measures/urban_geometry_creation/README.md

@@ -43,6 +43,14 @@ Select which surrounding buildings to include.
 **Required:** true,
 **Model Dependent:** false
 
+### Scale Footprint Area by the Floor Area?
+If true, the footprint area from GeoJSON will be scaled by the floor_area provided by the user in URBANopt.
+**Name:** scale_footprint_area_by_floor_area,
+**Type:** Boolean,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
 
 
 

data/lib/measures/urban_geometry_creation/measure.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -73,13 +75,17 @@ class UrbanGeometryCreation < OpenStudio::Measure::ModelMeasure
     surrounding_buildings.setDescription('Select which surrounding buildings to include.')
     surrounding_buildings.setDefaultValue('ShadingOnly')
     args << surrounding_buildings
+    # not a required argument
+    scale_footprint_area_by_floor_area = OpenStudio::Ruleset::OSArgument.makeBoolArgument('scale_footprint_area_by_floor_area', false)
+    scale_footprint_area_by_floor_area.setDisplayName('Scale Footprint Area by the Floor Area?')
+    scale_footprint_area_by_floor_area.setDescription('If true, the footprint area from GeoJSON will be scaled by the floor_area provided by the user in URBANopt.')
+    scale_footprint_area_by_floor_area.setDefaultValue(false)
+    args << scale_footprint_area_by_floor_area
     return args
   end
 
   # define what happens when the measure is run
-  # rubocop:disable Metrics/AbcSize
   def run(model, runner, user_arguments)
-    # rubocop:enable Metrics/AbcSize
     super(model, runner, user_arguments)
     # use the built-in error checking
     if !runner.validateUserArguments(arguments(model), user_arguments)
@@ -90,6 +96,7 @@ class UrbanGeometryCreation < OpenStudio::Measure::ModelMeasure
     geojson_file = runner.getStringArgumentValue('geojson_file', user_arguments)
     feature_id = runner.getStringArgumentValue('feature_id', user_arguments)
     surrounding_buildings = runner.getStringArgumentValue('surrounding_buildings', user_arguments)
+    scale_footprint_area_by_floor_area = runner.getBoolArgumentValue('scale_footprint_area_by_floor_area', user_arguments)
 
     default_construction_set = URBANopt::GeoJSON::Model.create_construction_set(model, runner)
 
@@ -133,7 +140,17 @@ class UrbanGeometryCreation < OpenStudio::Measure::ModelMeasure
 
     if feature.type == 'Building'
       # make requested building
-      spaces = feature.create_building(:space_per_floor, model, @origin_lat_lon, @runner)
+      # pass in scaled_footprint_area (calculated from floor_area / number_of_stories)
+      scaled_footprint_area = 0
+      if scale_footprint_area_by_floor_area
+        building_hash = feature.to_hash
+        if building_hash[:number_of_stories] && building_hash[:floor_area]
+          scaled_footprint_area = building_hash[:floor_area].to_f / building_hash[:number_of_stories].to_f
+          @runner.registerInfo("Desired footprint area in ft2: #{scaled_footprint_area}")
+        end
+      end
+
+      spaces = feature.create_building(:space_per_floor, model, @origin_lat_lon, @runner, false, scaled_footprint_area)
       if spaces.nil?
         @runner.registerError("Failed to create spaces for building '#{name}'")
         return false

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>2e224aaa-0d77-486f-b8ef-c25121fabd91</version_id>
+  <version_modified>20201208T232103Z</version_modified>
   <xml_checksum>D254E772</xml_checksum>
   <class_name>UrbanGeometryCreation</class_name>
   <display_name>UrbanGeometryCreation</display_name>
@@ -45,9 +46,28 @@
         </choice>
       </choices>
     </argument>
+    <argument>
+      <name>scale_footprint_area_by_floor_area</name>
+      <display_name>Scale Footprint Area by the Floor Area?</display_name>
+      <description>If true, the footprint area from GeoJSON will be scaled by the floor_area provided by the user in URBANopt.</description>
+      <type>Boolean</type>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+      <default_value>false</default_value>
+      <choices>
+        <choice>
+          <value>true</value>
+          <display_name>true</display_name>
+        </choice>
+        <choice>
+          <value>false</value>
+          <display_name>false</display_name>
+        </choice>
+      </choices>
+    </argument>
   </arguments>
-  <outputs/>
-  <provenances/>
+  <outputs />
+  <provenances />
   <tags>
     <tag>Envelope.Form</tag>
   </tags>
@@ -90,29 +110,29 @@
       <usage_type>readmeerb</usage_type>
       <checksum>703C9964</checksum>
     </file>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>EA283B74</checksum>
-    </file>
     <file>
       <filename>nrel_stm_footprints.geojson</filename>
       <filetype>geojson</filetype>
       <usage_type>test</usage_type>
       <checksum>40290298</checksum>
     </file>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>D8541540</checksum>
+    </file>
     <file>
       <filename>shadowed_tests.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>861137CF</checksum>
+      <checksum>F656F8DE</checksum>
     </file>
     <file>
       <filename>urban_geometry_creation_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>6DED5C96</checksum>
+      <checksum>B4A7376B</checksum>
     </file>
     <file>
       <version>
@@ -123,19 +143,13 @@
       <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>
+      <checksum>791A977E</checksum>
     </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>A09F345D</checksum>
+      <checksum>74F54DC5</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/urban_geometry_creation_zoning/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
+URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, 

data/lib/measures/urban_geometry_creation_zoning/measure.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -81,9 +83,7 @@ class UrbanGeometryCreationZoning < OpenStudio::Measure::ModelMeasure
   end
 
   # define what happens when the measure is run
-  # rubocop:disable Metrics/AbcSize
   def run(model, runner, user_arguments)
-    # rubocop:enable Metrics/AbcSize
     super(model, runner, user_arguments)
     # use the built-in error checking
     if !runner.validateUserArguments(arguments(model), user_arguments)

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>0c0d1135-a50f-40c6-82fb-fc357e46dd02</version_id>
+  <version_modified>20201208T232103Z</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>
@@ -100,7 +101,7 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>EA283B74</checksum>
+      <checksum>D8541540</checksum>
     </file>
     <file>
       <version>
@@ -111,19 +112,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>3E6D4653</checksum>
     </file>
     <file>
       <filename>urban_geometry_creation_zoning_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>60BFE46B</checksum>
+      <checksum>D609CD4C</checksum>
     </file>
     <file>
       <filename>README.md</filename>

data/lib/urbanopt-geojson.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/geojson.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -39,3 +39,4 @@ require 'urbanopt/geojson/zoning'
 require 'urbanopt/geojson/model'
 require 'urbanopt/geojson/derived_extension'
 require 'urbanopt/geojson/logging'
+require 'urbanopt/geojson/scale_area'

data/lib/urbanopt/geojson/building.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -87,9 +87,11 @@ module URBANopt
       # * +origin_lat_lon+ - _Type:Float_ - An instance of +OpenStudio::PointLatLon+ indicating the latitude and longitude of the origin.
       # * +runner+ - _Type:String_ - An instance of +OpenStudio::Measure::OSRunner+ for the measure run.
       # * +zoning+ - _Type:Boolean_ - Value is +true+ if utilizing detailed zoning, else
-      #   +false+. Zoning is set to False by default.
+      #   +false+ Zoning is set to False by default.
+      # * +scaled_footprint_area+ - Used to scale the footprint area using the floor area. 0 by
+      #   default (no scaling).
       # * +other_building+ - _Type:URBANopt::GeoJSON::Feature - Optional, allow the user to pass in a different building to process. This is used for creating the other buildings for shading.
-      def create_building(create_method, model, origin_lat_lon, runner, zoning = false, other_building = @feature_json)
+      def create_building(create_method, model, origin_lat_lon, runner, zoning = false, scaled_footprint_area = 0, other_building = @feature_json)
         number_of_stories = other_building[:properties][:number_of_stories]
         number_of_stories_above_ground = other_building[:properties][:number_of_stories_above_ground]
         number_of_stories_below_ground = other_building[:properties][:number_of_stories_below_ground]
@@ -128,7 +130,7 @@ module URBANopt
         spaces = []
         if create_method == :space_per_floor || create_method == :spaces_per_floor
           (-number_of_stories_below_ground + 1..number_of_stories_above_ground).each do |story_number|
-            new_spaces = create_space_per_floor(story_number, floor_to_floor_height, model, origin_lat_lon, runner, zoning)
+            new_spaces = create_space_per_floor(story_number, floor_to_floor_height, model, origin_lat_lon, runner, zoning, scaled_footprint_area)
             spaces.concat(new_spaces)
           end
         elsif create_method == :space_per_building
@@ -248,9 +250,50 @@ module URBANopt
       end
 
       ##
-      # Convert to a Hash equivalent for JSON serialization
+      # Used to calculate the perimeter from the floor polygon of a Feature. Returns the perimeter
+      # value.
+      #
+      # [Parameters]
+      # * +feature+ - An instance of URBANopt::GeoJSON::Feature
+      #
+      def calculate_perimeter(feature)
+        model = OpenStudio::Model::Model.new
+        runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+        origin_lat_lon = nil
+        origin_lat_lon = feature.create_origin_lat_lon(runner)
+        spaces = feature.create_building(:space_per_building, model, origin_lat_lon, runner)
+        surfaces = spaces[0].surfaces
+        ground_surface = nil
+        surfaces.each do |surface|
+          boundary_condition = surface.outsideBoundaryCondition
+          if boundary_condition == 'Ground'
+            ground_surface = surface
+          end
+        end
+        vertices = ground_surface.vertices
+        n = vertices.size
+        perimeter = 0
+        for i in (0..n - 1) do i
+                               vertex_1 = nil
+                               vertex_2 = nil
+                               if i == n - 1
+                                 vertex_1 = vertices[n - 1]
+                                 vertex_2 = vertices[0]
+                               else
+                                 vertex_1 = vertices[i]
+                                 vertex_2 = vertices[i + 1]
+                               end
+                               length = OpenStudio::Vector3d.new(vertex_2 - vertex_1).length
+                               perimeter += length
+        end
+        perimeter = OpenStudio.convert(perimeter, 'm', 'ft').get
+        perimeter = perimeter.round(4)
+        return perimeter
+      end
+
       ##
-      # - Exclude attributes with nil values.
+      # Convert to a Hash equivalent for JSON serialization.
+      # Excludes attributes with nil value.
       ##
       def to_hash
         result = {}
@@ -354,10 +397,18 @@ module URBANopt
       # * +zoning+ - _Type:Boolean_ - Value is +true+ if utilizing detailed zoning, else
       #   +false+. Zoning is set to False by default.
       # rubocop:disable Style/CommentedKeyword
-      def create_space_per_floor(story_number, floor_to_floor_height, model, origin_lat_lon, runner, zoning = false) #:doc:
+      def create_space_per_floor(story_number, floor_to_floor_height, model, origin_lat_lon, runner, zoning = false, scaled_footprint_area) #:doc:
         # rubocop:enable Style/CommentedKeyword
-        geometry = @feature_json[:geometry]
-        properties = @feature_json[:properties]
+        begin
+          if other_building
+            geometry = other_building[:geometry]
+            properties = other_building[:properties]
+          else
+            geometry = @feature_json[:geometry]
+            properties = @feature_json[:properties]
+          end
+        rescue StandardError
+        end
         floor_prints = []
         multi_polygons = get_multi_polygons
         multi_polygons.each do |multi_polygon|
@@ -366,7 +417,7 @@ module URBANopt
           end
           multi_polygon.each do |polygon|
             elevation = (story_number - 1) * floor_to_floor_height
-            floor_print = URBANopt::GeoJSON::Helper.floor_print_from_polygon(polygon, elevation, origin_lat_lon, runner, zoning)
+            floor_print = URBANopt::GeoJSON::Helper.floor_print_from_polygon(polygon, elevation, origin_lat_lon, runner, zoning, scaled_footprint_area)
             if floor_print
               if zoning
                 this_floor_prints = URBANopt::GeoJSON::Zoning.divide_floor_print(floor_print, 4.0, runner)

data/lib/urbanopt/geojson/derived_extension.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/geojson/district_system.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,