urbanopt-geojson 0.2.0.pre3 → 0.4.0

data/docs/package.json

@@ -10,20 +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",
-    "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": ">=18.1.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/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,10 +5,10 @@
 # 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.
 
 ## Measure Type
 ModelMeasure

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™, 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,6 +75,12 @@ 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
 
@@ -88,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)
 
@@ -131,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,14 +1,15 @@
+<?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>0808dbbe-ec8a-46c7-b416-cbae39e2b06c</version_id>
-  <version_modified>20190523T021410Z</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>
   <description>This measure reads an URBANopt GeoJSON and creates geometry for a particular building.  Surrounding buildings are included as shading structures.</description>
-  <modeler_description></modeler_description>
+  <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.</modeler_description>
   <arguments>
     <argument>
       <name>geojson_file</name>
@@ -43,15 +44,11 @@
           <value>ShadingOnly</value>
           <display_name>ShadingOnly</display_name>
         </choice>
-        <choice>
-          <value>All</value>
-          <display_name>All</display_name>
-        </choice>
       </choices>
     </argument>
   </arguments>
-  <outputs/>
-  <provenances/>
+  <outputs />
+  <provenances />
   <tags>
     <tag>Envelope.Form</tag>
   </tags>
@@ -94,35 +91,35 @@
       <usage_type>readmeerb</usage_type>
       <checksum>703C9964</checksum>
     </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>D339FA87</checksum>
-    </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>B646B327</checksum>
+      <checksum>EA283B74</checksum>
     </file>
     <file>
       <filename>nrel_stm_footprints.geojson</filename>
       <filetype>geojson</filetype>
       <usage_type>test</usage_type>
-      <checksum>21E06908</checksum>
+      <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>53A7DD48</checksum>
+      <checksum>4E51A05C</checksum>
     </file>
     <file>
       <filename>urban_geometry_creation_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>B55E2F27</checksum>
+      <checksum>DDAD6BFA</checksum>
     </file>
     <file>
       <version>
@@ -133,7 +130,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>E152B533</checksum>
+      <checksum>2F8C09F7</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™, 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 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,5 +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,
@@ -111,8 +113,8 @@ class UrbanGeometryCreationZoning < OpenStudio::Measure::ModelMeasure
     @runner = runner
     @origin_lat_lon = nil
 
-    all_features = URBANopt::GeoJSON::GeoFile.from_file(geojson_file)  
-    feature = URBANopt::GeoJSON::GeoFile.from_file(geojson_file).get_feature_by_id(feature_id) 
+    all_features = URBANopt::GeoJSON::GeoFile.from_file(geojson_file)
+    feature = URBANopt::GeoJSON::GeoFile.from_file(geojson_file).get_feature_by_id(feature_id)
 
     # EXPOSE NAME
     name = feature.feature_json[:properties][:name]
@@ -153,7 +155,6 @@ class UrbanGeometryCreationZoning < OpenStudio::Measure::ModelMeasure
         convert_to_shades = feature.create_other_buildings(surrounding_buildings, all_features.json, model, @origin_lat_lon, @runner)
       end
 
-      
       # intersect surfaces in this building with others
       @runner.registerInfo('Intersecting surfaces')
       spaces.each do |space|

data/lib/measures/urban_geometry_creation_zoning/measure.xml

@@ -1,13 +1,14 @@
+<?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>63e08249-fcf1-4037-9cb4-b1188702b056</version_id>
-  <version_modified>20190523T021410Z</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>
-  <description>This measure reads an URBANopt GeoJSON and creates geometry for a particular building.  Surrounding buildings are included as shading structures.</description>
+  <description>This measure reads an URBANopt GeoJSON and creates geometry with zoning for a particular building.  Surrounding buildings are included as shading structures.</description>
   <modeler_description></modeler_description>
   <arguments>
     <argument>
@@ -43,15 +44,11 @@
           <value>ShadingOnly</value>
           <display_name>ShadingOnly</display_name>
         </choice>
-        <choice>
-          <value>All</value>
-          <display_name>All</display_name>
-        </choice>
       </choices>
     </argument>
   </arguments>
-  <outputs/>
-  <provenances/>
+  <outputs />
+  <provenances />
   <tags>
     <tag>Envelope.Form</tag>
   </tags>
@@ -104,19 +101,13 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>B646B327</checksum>
+      <checksum>EA283B74</checksum>
     </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>15702F0A</checksum>
-    </file>
-    <file>
-      <filename>urban_geometry_creation_test.rb</filename>
-      <filetype>rb</filetype>
-      <usage_type>test</usage_type>
-      <checksum>111178B3</checksum>
+      <checksum>0458EE16</checksum>
     </file>
     <file>
       <version>
@@ -127,7 +118,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>F9C7D6B2</checksum>
+      <checksum>2505C43D</checksum>
+    </file>
+    <file>
+      <filename>urban_geometry_creation_zoning_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>986CB63E</checksum>
     </file>
   </files>
 </measure>

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,
@@ -33,7 +33,6 @@ require 'urbanopt/geojson/feature'
 module URBANopt
   module GeoJSON
     class Building < URBANopt::GeoJSON::Feature
-
       ##
       # Used to initialize the feature. This method is inherited from the Feature class.
       def initialize(feature = {})
@@ -88,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]
@@ -129,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,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
       ##
@@ -277,14 +313,13 @@ module URBANopt
         result[:mixed_type_3_percentage] = @mixed_type_3_percentage if @mixed_type_3_percentage
         result[:mixed_type_4] = @mixed_type_4 if @mixed_type_4
         result[:mixed_type_4_percentage] = @mixed_type_4_percentage if @mixed_type_4_percentage
-        return result 
+        return result
       end
 
-
       private
 
       ##
-      # Returns an array of instances of +OpenStudio::Model::Space+ per building
+      # Returns an array of instances of +OpenStudio::Model::Space+ per building.
       #
       # [Parameters]
       # * +min_elevation+ - _Type:Integer_ - Indicates minimum elevation across all buildings.
@@ -294,7 +329,9 @@ module URBANopt
       # * +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.
+      # rubocop:disable Style/OptionalArguments, Style/CommentedKeyword
       def create_space_per_building(min_elevation, max_elevation, model, origin_lat_lon, runner, zoning = false, other_building) #:doc:
+        # rubocop: enable Style/OptionalArguments, Style/CommentedKeyword
         if other_building
           geometry = other_building[:geometry]
           properties = other_building[:properties]
@@ -338,7 +375,7 @@ module URBANopt
           result << space
         end
         return result
-        end
+      end
 
       ##
       # Returns an array of instances of +OpenStudio::Model::Space+ per floor.
@@ -352,10 +389,20 @@ module URBANopt
       #   origin's latitude and longitude.
       # * +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. 
-      def create_space_per_floor(story_number, floor_to_floor_height, model, origin_lat_lon, runner, zoning = false) #:doc:
-        geometry = @feature_json[:geometry]
-        properties = @feature_json[:properties]
+      #   +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, scaled_footprint_area) #:doc:
+        # rubocop:enable Style/CommentedKeyword
+        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|
@@ -364,10 +411,10 @@ 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) 
+                this_floor_prints = URBANopt::GeoJSON::Zoning.divide_floor_print(floor_print, 4.0, runner)
                 floor_prints.concat(this_floor_prints)
               else
                 floor_prints << floor_print
@@ -377,8 +424,8 @@ module URBANopt
             end
             # Subsequent polygons are holes, and are not supported.
             break
-          end 
-        end 
+          end
+        end
         spaces = []
         floor_prints.each do |floor_print|
           space = OpenStudio::Model::Space.fromFloorPrint(floor_print, floor_to_floor_height, model)
@@ -394,22 +441,23 @@ module URBANopt
                 surface.setOutsideBoundaryCondition('Ground')
               end
             end
-          end 
+          end
           spaces << space
-        end 
-        
+        end
+
         building_story = OpenStudio::Model::BuildingStory.new(model)
         building_story.setName("Building Story #{story_number}")
+        building_story.setNominalZCoordinate(story_number * floor_to_floor_height)
+        building_story.setNominalFloortoFloorHeight(floor_to_floor_height)
         spaces.each do |space|
           space.setBuildingStory(building_story)
           thermal_zone = OpenStudio::Model::ThermalZone.new(model)
           thermal_zone.setName("Building Story #{story_number} ThermalZone")
           space.setThermalZone(thermal_zone)
-        end 
-        
+        end
+
         return spaces
       end
-    
-    end 
-  end 
-end 
+    end
+  end
+end