urbanopt-cli 0.6.2 → 0.7.1

data/example_files/mappers/Baseline.rb

@@ -402,9 +402,6 @@ module URBANopt
         feature_id = feature.id
         feature_type = feature.type
 
-        # take the first vertex as the location of the building
-        #feature_location = feature.feature_json[:geometry][:coordinates][0][0].to_s
-
         # take the centroid of the vertices as the location of the building
         feature_vertices_coordinates = feature.feature_json[:geometry][:coordinates][0]
         feature_location = feature.find_feature_center(feature_vertices_coordinates).to_s
@@ -442,16 +439,15 @@ module URBANopt
             rescue
             end
 
-            args[:simulation_control_run_period_begin_month] = 1
-            args[:simulation_control_run_period_begin_day_of_month] = 1
-            args[:simulation_control_run_period_end_month] = 12
-            args[:simulation_control_run_period_end_day_of_month] = 31
+            args[:simulation_control_run_period] = 'Jan 1 - Dec 31'
             args[:simulation_control_run_period_calendar_year] = 2007
             begin
-              args[:simulation_control_run_period_begin_month] = feature.begin_date[5, 2].to_i
-              args[:simulation_control_run_period_begin_day_of_month] = feature.begin_date[8, 2].to_i
-              args[:simulation_control_run_period_end_month] = feature.end_date[5, 2].to_i
-              args[:simulation_control_run_period_end_day_of_month] = feature.end_date[8, 2].to_i
+              abbr_monthnames = Date::ABBR_MONTHNAMES
+              begin_month = abbr_monthnames[feature.begin_date[5, 2].to_i]
+              begin_day_of_month = feature.begin_date[8, 2].to_i
+              end_month = abbr_monthnames[feature.end_date[5, 2].to_i]
+              end_day_of_month = feature.end_date[8, 2].to_i
+              args[:simulation_control_run_period] = "#{begin_month} #{begin_day_of_month} - #{end_month} #{end_day_of_month}"
               args[:simulation_control_run_period_calendar_year] = feature.begin_date[0, 4].to_i
             rescue
             end
@@ -463,15 +459,19 @@ module URBANopt
             case building_type
             when 'Single-Family Detached'
               args[:geometry_unit_type] = 'single-family detached'
+              args[:geometry_unit_num_floors_above_grade] = feature.number_of_stories_above_ground
             when 'Single-Family Attached'
               args[:geometry_building_num_units] = feature.number_of_residential_units
               args[:geometry_unit_type] = 'single-family attached'
+              args[:geometry_unit_num_floors_above_grade] = feature.number_of_stories_above_ground
             when 'Multifamily'
               args[:geometry_building_num_units] = feature.number_of_residential_units
               args[:geometry_unit_type] = 'apartment unit'
-              args[:geometry_corridor_position] = 'Double Exterior' # if we had an interior corridor, we'd have to subtract its area from the footprint area
+              args[:geometry_unit_num_floors_above_grade] = 1
             end
 
+            args[:geometry_num_floors_above_grade] = feature.number_of_stories_above_ground
+
             args[:geometry_foundation_type] = 'SlabOnGrade'
             args[:geometry_foundation_height] = 0.0
             case feature.foundation_type
@@ -492,40 +492,35 @@ module URBANopt
               args[:geometry_foundation_height] = 8.0
             end
 
-            args[:geometry_attic_type] = 'VentedAttic'
-            args[:geometry_roof_type] = 'flat'
+            args[:geometry_attic_type] = 'FlatRoof'
+            args[:geometry_roof_type] = 'gable'
             begin
               case feature.attic_type
               when 'attic - vented'
-                args[:geometry_roof_type] = 'gable'
+                args[:geometry_attic_type] = 'VentedAttic'
               when 'attic - unvented'
                 args[:geometry_attic_type] = 'UnventedAttic'
-                args[:geometry_roof_type] = 'gable'
               when 'attic - conditioned'
                 args[:geometry_attic_type] = 'ConditionedAttic'
-                args[:geometry_roof_type] = 'gable'
               end
             rescue
             end
 
-            args[:geometry_num_floors_above_grade] = feature.number_of_stories_above_ground
+            args[:geometry_unit_cfa] = feature.floor_area / args[:geometry_building_num_units]
 
-            args[:geometry_cfa] = feature.floor_area / args[:geometry_building_num_units]
+            args[:geometry_unit_num_bedrooms] = feature.number_of_bedrooms / args[:geometry_building_num_units]
 
-            args[:geometry_wall_height] = 8.0
+            args[:geometry_average_ceiling_height] = 8.0
             begin
-              args[:geometry_wall_height] = feature.maximum_roof_height / args[:geometry_num_floors_above_grade]
+              args[:geometry_average_ceiling_height] = feature.maximum_roof_height / feature.number_of_stories_above_ground
             rescue
             end
 
-            args[:geometry_num_bedrooms] = feature.number_of_bedrooms
-            args[:geometry_num_bedrooms] /= args[:geometry_building_num_units]
-
             begin
               num_garage_spaces = 0
               if feature.onsite_parking_fraction
                 num_garage_spaces = 1
-                if args[:geometry_cfa] > 2500.0
+                if args[:geometry_unit_cfa] > 2500.0
                   num_garage_spaces = 2
                 end
               end
@@ -544,9 +539,9 @@ module URBANopt
               feature_ids << feature.id
             end
 
-            args[:schedules_type] = 'stochastic'
             args[:feature_id] = feature_ids.index(feature_id)
-            args[:schedules_variation] = 'building' # building or unit
+            args[:schedules_type] = 'stochastic' # smooth or stochastic
+            args[:schedules_variation] = 'unit' # building or unit
 
             # HVAC
 
@@ -628,10 +623,12 @@ module URBANopt
                 # Determine which surfaces to place insulation on
                 if args[:geometry_foundation_type].include? 'Basement'
                   row[:foundation_wall_assembly_r] = row[:foundation_wall_assembly_r_basement]
-                  row[:floor_assembly_r] = 2.1
+                  row[:floor_over_foundation_assembly_r] = 2.1
+                  row[:floor_over_garage_assembly_r] = 2.1
                 elsif args[:geometry_foundation_type].include? 'Crawlspace'
                   row[:foundation_wall_assembly_r] = row[:foundation_wall_assembly_r_crawlspace]
-                  row[:floor_assembly_r] = 2.1
+                  row[:floor_over_foundation_assembly_r] = 2.1
+                  row[:floor_over_garage_assembly_r] = 2.1
                 end
                 row.delete(:foundation_wall_assembly_r_basement)
                 row.delete(:foundation_wall_assembly_r_crawlspace)
@@ -715,7 +712,7 @@ module URBANopt
 
             args.keys.each do |arg_name|
               unless default_args.keys.include? arg_name
-                next if [:feature_id, :schedules_variation].include?(arg_name)
+                next if [:feature_id, :schedules_type, :schedules_variation, :geometry_num_floors_above_grade].include?(arg_name)
 
                 puts "Argument '#{arg_name}' is unknown."
               end
@@ -936,12 +933,17 @@ module URBANopt
                 end
               end
 
+              # geojson schema doesn't have modify_wkdy_op_hrs and modify_wknd_op_hrs checking for both start and duration to set to true in osw
+              weekday_flag = 0 # set modify arg to true of this gets to 2
+              weekend_flag = 0 # set modify arg to true of this gets to 2
+
               # set weekday start time
               begin
                 weekday_start_time = feature.weekday_start_time
                 if !feature.weekday_start_time.empty?
                   new_weekday_start_time = time_mapping(weekday_start_time)
                   OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wkdy_op_hrs_start_time', new_weekday_start_time, 'create_typical_building_from_model 1')
+                  weekday_flag += 1
                 end
               rescue
               end
@@ -952,6 +954,15 @@ module URBANopt
                 if !feature.weekday_duration.empty?
                   new_weekday_duration = time_mapping(weekday_duration)
                   OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wkdy_op_hrs_duration', new_weekday_duration, 'create_typical_building_from_model 1')
+                  weekday_flag += 1
+                end
+              rescue
+              end
+
+              # set weekday modify 
+              begin
+                if weekday_flag == 2
+                  OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'modify_wkdy_op_hrs', true, 'create_typical_building_from_model 1')
                 end
               rescue
               end
@@ -962,6 +973,7 @@ module URBANopt
                 if !feature.weekend_start_time.empty?
                   new_weekend_start_time = time_mapping(weekend_start_time)
                   OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wknd_op_hrs_start_time', new_weekend_start_time, 'create_typical_building_from_model 1')
+                  weekend_flag += 1
                 end
               rescue
               end
@@ -972,10 +984,19 @@ module URBANopt
                 if !feature.weekend_duration.empty?
                   new_weekend_duration = time_mapping(weekend_duration)
                   OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wknd_op_hrs_duration', new_weekend_duration, 'create_typical_building_from_model 1')
+                  weekend_flag += 1
                 end
               rescue
               end
 
+              # set weekday modify 
+              begin
+                if weekend_flag == 2
+                  OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'modify_wknd_op_hrs', true, 'create_typical_building_from_model 1')
+                end
+              rescue
+              end
+              
               # template
               begin
                 new_template = nil

data/example_files/mappers/CreateBar.rb

@@ -258,7 +258,12 @@ module URBANopt
         feature = features[0]
         feature_id = feature.id
         feature_type = feature.type
+        # take the centroid of the vertices as the location of the building
+        feature_vertices_coordinates = feature.feature_json[:geometry][:coordinates][0]
+        feature_location = feature.find_feature_center(feature_vertices_coordinates).to_s
+        
         feature_name = feature.name
+        
         if feature_names.size == 1
           feature_name = feature_names[0]
         end
@@ -311,6 +316,13 @@ module URBANopt
             osw[:file_paths] << File.join(File.dirname(__FILE__), '../osm_building/')
             osw[:seed_file] = detailed_model_filename
 
+            # skip create_bar measure with detailed models:
+            OpenStudio::Extension.set_measure_argument(osw, 'create_bar_from_building_type_ratios', '__SKIP__', true)
+
+            # skip create typical building measure with detailed models:
+            OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', '__SKIP__', true)
+
+
             # skip PMV measure with detailed models:
             OpenStudio::Extension.set_measure_argument(osw, 'PredictedMeanVote', '__SKIP__', true)
 
@@ -453,12 +465,17 @@ module URBANopt
               end
             end
 
+            # geojson schema doesn't have modify_wkdy_op_hrs and modify_wknd_op_hrs checking for both start and duration to set to true in osw
+            weekday_flag = 0 # set modify arg to true of this gets to 2
+            weekend_flag = 0 # set modify arg to true of this gets to 2
+
             # set weekday start time
             begin
               weekday_start_time = feature.weekday_start_time
               if !feature.weekday_start_time.empty?
                 new_weekday_start_time = time_mapping(weekday_start_time)
                 OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wkdy_op_hrs_start_time', new_weekday_start_time, 'create_typical_building_from_model')
+                weekday_flag += 1
               end
             rescue StandardError
             end
@@ -469,6 +486,15 @@ module URBANopt
               if !feature.weekday_duration.empty?
                 new_weekday_duration = time_mapping(weekday_duration)
                 OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wkdy_op_hrs_duration', new_weekday_duration, 'create_typical_building_from_model')
+                weekday_flag += 1
+              end
+            rescue StandardError
+            end
+
+            # set weekday modify 
+            begin
+              if weekday_flag == 2
+                OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'modify_wknd_op_hrs', true, 'create_typical_building_from_model')
               end
             rescue StandardError
             end
@@ -479,6 +505,7 @@ module URBANopt
               if !feature.weekend_start_time.empty?
                 new_weekend_start_time = time_mapping(weekend_start_time)
                 OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wknd_op_hrs_start_time', new_weekend_start_time, 'create_typical_building_from_model')
+                weekend_flag += 1
               end
             rescue StandardError
             end
@@ -489,6 +516,15 @@ module URBANopt
               if !feature.weekend_duration.empty?
                 new_weekend_duration = time_mapping(weekend_duration)
                 OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wknd_op_hrs_duration', new_weekend_duration, 'create_typical_building_from_model')
+                weekend_flag += 1
+              end
+            rescue StandardError
+            end
+
+            # set weekday modify 
+            begin
+              if weekend_flag == 2
+                OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'modify_wkdy_op_hrs', true, 'create_typical_building_from_model')
               end
             rescue StandardError
             end
@@ -552,6 +588,7 @@ module URBANopt
           OpenStudio::Extension.set_measure_argument(osw, 'default_feature_reports', 'feature_id', feature_id)
           OpenStudio::Extension.set_measure_argument(osw, 'default_feature_reports', 'feature_name', feature_name)
           OpenStudio::Extension.set_measure_argument(osw, 'default_feature_reports', 'feature_type', feature_type)
+          OpenStudio::Extension.set_measure_argument(osw, 'default_feature_reports', 'feature_location', feature_location)
         end
 
         return osw

data/example_files/mappers/FlexibleHotWater.rb

@@ -0,0 +1,69 @@
+#*********************************************************************************
+# 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,
+# 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 'urbanopt/reporting'
+
+require_relative 'Baseline'
+
+require 'json'
+
+module URBANopt
+  module Scenario
+    class FlexibleHotWaterMapper < BaselineMapper
+
+      def create_osw(scenario, features, feature_names)
+
+        osw = super(scenario, features, feature_names)
+
+        feature = features[0]
+        building_type = feature.building_type
+
+        # Only apply to commercial buildings, not residential models
+        if commercial_building_types.include? building_type
+          OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', '__SKIP__', false)
+          # Add a sizing multiplier to the tank capacity to cover flex periods
+          OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'vol', 2)
+          # Update maximum tank and minimum temperature setpoints
+          OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'max_temp', 185)
+          OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'min_temp', 125)
+
+          # Manage water heat charge float periods by building
+          OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'flex0', 'Charge - Heat Pump')
+          OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'flex_hrs0', '16:00-17:00')
+          OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'flex1', 'Float')
+          OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'flex_hrs1', '17:01-19:00')
+        end
+
+        return osw
+      end
+
+    end
+  end
+end

data/example_files/mappers/Floorspace.rb

@@ -258,6 +258,11 @@ module URBANopt
         feature = features[0]
         feature_id = feature.id
         feature_type = feature.type
+
+        # take the centroid of the vertices as the location of the building
+        feature_vertices_coordinates = feature.feature_json[:geometry][:coordinates][0]
+        feature_location = feature.find_feature_center(feature_vertices_coordinates).to_s
+
         feature_name = feature.name
         if feature_names.size == 1
           feature_name = feature_names[0]
@@ -539,12 +544,17 @@ module URBANopt
               end
             end
 
+            # geojson schema doesn't have modify_wkdy_op_hrs and modify_wknd_op_hrs checking for both start and duration to set to true in osw
+            weekday_flag = 0 # set modify arg to true of this gets to 2
+            weekend_flag = 0 # set modify arg to true of this gets to 2
+
             # set weekday start time
             begin
               weekday_start_time = feature.weekday_start_time
               if !feature.weekday_start_time.empty?
                 new_weekday_start_time = time_mapping(weekday_start_time)
                 OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wkdy_op_hrs_start_time', new_weekday_start_time, 'create_typical_building_from_model 1')
+                weekday_flag += 1
               end
             rescue StandardError
             end
@@ -555,6 +565,15 @@ module URBANopt
               if !feature.weekday_duration.empty?
                 new_weekday_duration = time_mapping(weekday_duration)
                 OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wkdy_op_hrs_duration', new_weekday_duration, 'create_typical_building_from_model 1')
+                weekday_flag += 1
+              end
+            rescue StandardError
+            end
+
+            # set weekday modify 
+            begin
+              if weekday_flag == 2
+                OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'modify_wkdy_op_hrs', true, 'create_typical_building_from_model 1')
               end
             rescue StandardError
             end
@@ -565,6 +584,7 @@ module URBANopt
               if !feature.weekend_start_time.empty?
                 new_weekend_start_time = time_mapping(weekend_start_time)
                 OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wknd_op_hrs_start_time', new_weekend_start_time, 'create_typical_building_from_model 1')
+                weekend_flag += 1
               end
             rescue StandardError
             end
@@ -575,6 +595,15 @@ module URBANopt
               if !feature.weekend_duration.empty?
                 new_weekend_duration = time_mapping(weekend_duration)
                 OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'wknd_op_hrs_duration', new_weekend_duration, 'create_typical_building_from_model 1')
+                weekend_flag += 1
+              end
+            rescue StandardError
+            end
+
+            # set weekday modify 
+            begin
+              if weekend_flag == 2
+                OpenStudio::Extension.set_measure_argument(osw, 'create_typical_building_from_model', 'modify_wknd_op_hrs', true, 'create_typical_building_from_model 1')
               end
             rescue StandardError
             end
@@ -656,6 +685,7 @@ module URBANopt
           OpenStudio::Extension.set_measure_argument(osw, 'default_feature_reports', 'feature_id', feature_id)
           OpenStudio::Extension.set_measure_argument(osw, 'default_feature_reports', 'feature_name', feature_name)
           OpenStudio::Extension.set_measure_argument(osw, 'default_feature_reports', 'feature_type', feature_type)
+          OpenStudio::Extension.set_measure_argument(osw, 'default_feature_reports', 'feature_location', feature_location)
         end
 
         return osw

data/example_files/mappers/HighEfficiency.rb

@@ -70,10 +70,11 @@ module URBANopt
           end
 
           args[:wall_assembly_r] = Float(args[:wall_assembly_r]) * 1.2 # 20% increase
-          args[:plug_loads_television_usage_multiplier] = Float(args[:plug_loads_television_usage_multiplier]) * 0.9 # 10% reduction
-          args[:plug_loads_other_usage_multiplier] = Float(args[:plug_loads_other_usage_multiplier]) * 0.9 # 10% reduction
-          args[:lighting_usage_multiplier_interior] = Float(args[:lighting_usage_multiplier_interior]) * 0.9 # 10% reduction
-          args[:lighting_usage_multiplier_exterior] = Float(args[:lighting_usage_multiplier_exterior]) * 0.9 # 10% reduction
+          args[:misc_plug_loads_television_usage_multiplier] = Float(args[:misc_plug_loads_television_usage_multiplier]) * 0.9 # 10% reduction
+          args[:misc_plug_loads_other_usage_multiplier] = Float(args[:misc_plug_loads_other_usage_multiplier]) * 0.9 # 10% reduction
+          args[:lighting_interior_usage_multiplier] = Float(args[:lighting_interior_usage_multiplier]) * 0.9 # 10% reduction
+          args[:lighting_exterior_usage_multiplier] = Float(args[:lighting_exterior_usage_multiplier]) * 0.9 # 10% reduction
+          args[:lighting_garage_usage_multiplier] = Float(args[:lighting_garage_usage_multiplier]) * 0.9 # 10% reduction
           args[:clothes_washer_usage_multiplier] = Float(args[:clothes_washer_usage_multiplier]) * 0.9 # 10% reduction
           args[:clothes_dryer_usage_multiplier] = Float(args[:clothes_dryer_usage_multiplier]) * 0.9 # 10% reduction
           args[:dishwasher_usage_multiplier] = Float(args[:dishwasher_usage_multiplier]) * 0.9 # 10% reduction

data/example_files/mappers/base_workflow.osw

@@ -138,6 +138,11 @@
         "charge_start":"23:00",
         "inter_sp":46
       }
+    },{
+      "measure_dir_name":"add_hpwh",
+      "arguments":{
+        "__SKIP__":true
+        }
     },{
       "measure_dir_name":"add_packaged_ice_storage",
       "arguments":{

data/example_files/mappers/createbar_workflow.osw

@@ -40,6 +40,7 @@
         "num_stories_above_grade": null,
         "num_stories_below_grade": null,
         "building_rotation": 0,
+        "perim_mult": 0,
         "template": "90.1-2004",
         "ns_to_ew_ratio": 0,
         "wwr": 0,
@@ -89,7 +90,8 @@
       "arguments": {
         "feature_id": null,
         "feature_name": null,
-        "feature_type": null
+        "feature_type": null,
+        "feature_location": null
       }
     }
   ],

data/example_files/mappers/floorspace_workflow.osw

@@ -134,7 +134,8 @@
       "arguments": {
         "feature_id": null,
         "feature_name": null,
-        "feature_type": null
+        "feature_type": null,
+        "feature_location":null
       }
     }
   ],