urbanopt-geojson 0.3.1 → 0.4.0

data/docs/package.json

@@ -10,22 +10,23 @@
   },
   "author": "Brian Schiller",
   "dependencies": {
-    "highlight.js": "^9.15.6",
-    "json-schema-ref-parser": "^6.1.0",
+    "highlight.js": "^10.2.0",
+    "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",
+    "braces": "^3.0.2",
     "dot-prop": ">=5.1.1",
-    "gh-pages": "^2.0.1",
+    "gh-pages": "^3.1.0",
     "js-yaml": ">=3.13.1",
     "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"
+    "mixin-deep": "^2.0.1",
+    "serialize-javascript": "^5.0.1",
+    "set-value": "^3.0.2",
+    "yargs-parser": ">=18.1.1"
   }
 }

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™, 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

@@ -5,7 +5,7 @@
 # UrbanGeometryCreation
 
 ## Description
-This measure reads an URBANopt GeoJSON and creates geometry for a particular building.  Surrounding buildings are included as shading structures.
+This measure reads an URBANopt™ GeoJSON and creates geometry for a particular building.  Surrounding buildings are included as shading structures.
 
 ## Modeler Description
 This measure takes in the GeoJSON file, the feature_id of the building and the surrounding buildings as arguments and add has methods to create space types and add default construction sets.

data/lib/measures/urban_geometry_creation/measure.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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,
@@ -75,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)
@@ -92,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)
 
@@ -135,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_zoning/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
+URBANopt™, 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/README.md

@@ -5,7 +5,7 @@
 # UrbanGeometryCreationZoning
 
 ## Description
-This measure reads an URBANopt GeoJSON and creates geometry with zoning for a particular building.  Surrounding buildings are included as shading structures.
+This measure reads an URBANopt™ GeoJSON and creates geometry with zoning for a particular building.  Surrounding buildings are included as shading structures.
 
 ## Modeler Description
 

data/lib/measures/urban_geometry_creation_zoning/measure.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, 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,
@@ -83,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/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
@@ -247,6 +249,41 @@ module URBANopt
         end
       end
 
+      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
+
       ##
       # Convert to a Hash equivalent for JSON serialization
       ##
@@ -354,10 +391,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 +411,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,

data/lib/urbanopt/geojson/feature.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,
@@ -48,7 +48,7 @@ module URBANopt
       def method_missing(name, *args, &blk)
         # rubocop:enable Style/MethodMissing
         if @feature_json[:properties].keys.map(&:to_sym).include? name.to_sym
-          # rubocop:enable Style/GuardClause
+
           return @feature_json[:properties][name.to_sym]
         else
           super
@@ -98,6 +98,84 @@ module URBANopt
         return @@feature_schema[feature_type]
       end
 
+      def calculate_aspect_ratio
+        multi_polygons = get_multi_polygons(@feature_json)
+        rad_per_deg = 0.017453293
+
+        multi_polygons.each do |multi_polygon|
+          if multi_polygon.size > 1
+            runner.registerWarning('Ignoring holes in polygon')
+          end
+          multi_polygon.each do |polygon|
+            n = polygon.size
+            length = 0
+            north = 0
+            east = 0
+            south = 0
+            west = 0
+            aspect_ratio = 0
+
+            for i in (0..n - 2) do i
+                                   vertex_1 = nil
+                                   vertex_2 = nil
+                                   if i == n - 2
+                                     vertex_1 = polygon[n - 2]
+                                     vertex_2 = polygon[0]
+                                   else
+                                     vertex_1 = polygon[i]
+                                     vertex_2 = polygon[i + 1]
+                                   end
+                                   x_1 = vertex_1[0]
+                                   y_1 = vertex_1[1]
+                                   x_2 = vertex_2[0]
+                                   y_2 = vertex_2[1]
+
+                                   dist = (x_2 - x_1)**2 + (y_2 - y_1)**2
+
+                                   length = Math.sqrt(dist)
+
+                                   # delta latitude
+                                   dlat = x_2 - x_1
+                                   # delta longitude
+                                   dlon = y_2 - y_1
+
+                                   # convert radian to degree
+                                   sin_angle = Math.asin(dlon / length) * (1 / rad_per_deg)
+                                   sin_angle = sin_angle.round(4)
+
+                                   cos_angle = Math.acos(dlat / length) * (1 / rad_per_deg)
+                                   cos_angle = cos_angle.round(4)
+
+                                   if cos_angle >= 45 && cos_angle <= 135 && sin_angle >= 45 && sin_angle <= 90
+                                     north += length
+                                   elsif cos_angle >= 0 && cos_angle < 45 && sin_angle > -45 && sin_angle < 45
+                                     east += length
+                                   elsif  cos_angle >= 45 && cos_angle <= 135 && sin_angle >= -90 && sin_angle <= -45
+                                     south += length
+                                   elsif  cos_angle > 135 && cos_angle <= 180 && sin_angle > -45 && sin_angle < 45
+                                     west += length
+                                   end
+
+                                   if east + west != 0
+                                     aspect_ratio = (north + south) / (east + west)
+                                   else
+                                     aspect_ratio = 1
+                                   end
+
+            end
+
+            aspect_ratio = aspect_ratio.round(4)
+            return aspect_ratio
+          end
+        end
+      end
+
+      def get_perimeter_multiplier(area, aspect_ratio, perimeter_original)
+        perimeter_new = 2 * (Math.sqrt(area * aspect_ratio) + Math.sqrt(area / aspect_ratio))
+        perimeter_ratio = perimeter_original / perimeter_new
+        return perimeter_ratio
+      end
+
       ##
       # Returns coordinate with the minimum longitute and latitude within a given +building_json+ .
       def get_min_lon_lat

data/lib/urbanopt/geojson/geo_file.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,
@@ -162,7 +162,7 @@ module URBANopt
             # merge site origin properties
             f = merge_site_properties(f)
             if f[:properties][:type] == 'Building'
-              # rubocop:enable Style/GuardClause
+
               return URBANopt::GeoJSON::Building.new(f)
             elsif f[:properties] && f[:properties][:type] == 'District System'
               return URBANopt::GeoJSON::DistrictSystem.new(f)

data/lib/urbanopt/geojson/helper.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,
@@ -183,7 +183,9 @@ module URBANopt
       # * +origin_lat_lon+ - _Type:Float_ - An instance of +OpenStudio::PointLatLon+ indicating the origin's latitude and longitude.
       # * +runner+ - _Type:String_ - The measure run's instance of +OpenStudio::Measure::OSRunner+ .
       # * +zoning+ - _Type:Boolean_ - Value is +True+ if utilizing detailed zoning, else +False+. Zoning is set to False by default.
-      def self.floor_print_from_polygon(polygon, elevation, origin_lat_lon, runner, zoning = false)
+      # * +scaled_footprint_area+ - Used to scale the footprint area using the floor area. 0 by
+      #   default (no scaling).
+      def self.floor_print_from_polygon(polygon, elevation, origin_lat_lon, runner, zoning = false, scaled_footprint_area = 0)
         floor_print = OpenStudio::Point3dVector.new
         all_points = OpenStudio::Point3dVector.new
         polygon.each do |p|
@@ -207,9 +209,35 @@ module URBANopt
           floor_print = OpenStudio.reverse(floor_print)
           runner.registerWarning('Reversing floor print')
         end
+
+        # check for scaling
+        if scaled_footprint_area > 0
+
+          # check that the scaled_footprint_area desired is no less than X % of the original
+          original_floor_print_area = OpenStudio.getArea(floor_print).get
+          if scaled_footprint_area / original_floor_print_area <= 0.5 || scaled_footprint_area / original_floor_print_area >= 2
+            # TOO MUCH SCALING...using original footprint when scaled is 2x bigger or smaller than the original
+            runner.registerWarning('Desired scaled_footprint_area is a factor of 2 of the original footprint...keeping original footprint (no scaling!)')
+          else
+            new_floor_print = adjust_vertices_to_area(floor_print, scaled_footprint_area, runner)
+            new_footprint_area = OpenStudio.getArea(new_floor_print).get
+            runner.registerInfo("New floor area: #{new_footprint_area}, compared to scaled area desired: #{scaled_footprint_area}")
+            floor_print = new_floor_print
+          end
+        end
+
         return floor_print
       end
 
+      # scale footprint to desired area, keeping the shape
+      def self.adjust_vertices_to_area(vertices, desired_area, runner, eps = 0.1)
+        ar = ScaleArea.new(vertices, desired_area, runner, eps)
+
+        n = Newton.nlsolve(ar, [0])
+
+        return ar.new_vertices
+      end
+
       ##
       # Calculate which other buildings are shading the current feature and return as an array of
       # +OpenStudio::Model::Space+.

data/lib/urbanopt/geojson/logging.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,