urbanopt-cli 0.5.1 → 0.6.2

data/example_files/mappers/Baseline.rb

@@ -1,21 +1,31 @@
-#*********************************************************************************
-# URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# *********************************************************************************
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.
@@ -26,13 +36,14 @@
 # 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 'openstudio/common_measures'
 require 'openstudio/model_articulation'
 require 'openstudio/ee_measures'
 require 'openstudio/calibration'
+require 'openstudio/load_flexibility_measures'
 
 require 'json'
 require 'rexml/document'
@@ -147,7 +158,7 @@ module URBANopt
           when "Inpatient health care"
             return "Hospital"
           when "Laboratory"
-            return "Hospital"
+            return "Laboratory"
           when "Lodging"
             if number_of_stories
               if number_of_stories.to_i > 3
@@ -279,9 +290,9 @@ module URBANopt
           'Uncovered Parking',
           'Covered Parking',
           'Mixed use',
-          'Single-Family',
           'Multifamily (2 to 4 units)',
-          'Multifamily (5 or more units)'
+          'Multifamily (5 or more units)',
+          'Single-Family'
         ]
       end
 
@@ -414,6 +425,11 @@ module URBANopt
 
           building_type = feature.building_type
 
+          if building_type.nil?
+            # need building type
+            raise "Building type is not set"
+          end
+
           if residential_building_types.include? building_type
             debug = false
 
@@ -446,48 +462,48 @@ module URBANopt
             args[:geometry_building_num_units] = 1
             case building_type
             when 'Single-Family Detached'
-              args[:geometry_unit_type] = "single-family detached"
+              args[:geometry_unit_type] = 'single-family detached'
             when 'Single-Family Attached'
               args[:geometry_building_num_units] = feature.number_of_residential_units
-              args[:geometry_unit_type] = "single-family attached"
+              args[:geometry_unit_type] = 'single-family attached'
             when 'Multifamily'
               args[:geometry_building_num_units] = feature.number_of_residential_units
-              args[:geometry_unit_type] = "apartment unit"
+              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
             end
 
-            args[:geometry_foundation_type] = "SlabOnGrade"
+            args[:geometry_foundation_type] = 'SlabOnGrade'
             args[:geometry_foundation_height] = 0.0
             case feature.foundation_type
             when 'crawlspace - vented'
-              args[:geometry_foundation_type] = "VentedCrawlspace"
+              args[:geometry_foundation_type] = 'VentedCrawlspace'
               args[:geometry_foundation_height] = 3.0
             when 'crawlspace - unvented'
-              args[:geometry_foundation_type] = "UnventedCrawlspace"
+              args[:geometry_foundation_type] = 'UnventedCrawlspace'
               args[:geometry_foundation_height] = 3.0
             when 'basement - unconditioned'
-              args[:geometry_foundation_type] = "UnconditionedBasement"
+              args[:geometry_foundation_type] = 'UnconditionedBasement'
               args[:geometry_foundation_height] = 8.0
             when 'basement - conditioned'
-              args[:geometry_foundation_type] = "ConditionedBasement"
+              args[:geometry_foundation_type] = 'ConditionedBasement'
               args[:geometry_foundation_height] = 8.0
             when 'ambient'
-              args[:geometry_foundation_type] = "Ambient"
+              args[:geometry_foundation_type] = 'Ambient'
               args[:geometry_foundation_height] = 8.0
             end
 
-            args[:geometry_attic_type] = "ConditionedAttic"
-            args[:geometry_roof_type] = "flat"
+            args[:geometry_attic_type] = 'VentedAttic'
+            args[:geometry_roof_type] = 'flat'
             begin
               case feature.attic_type
               when 'attic - vented'
-                args[:geometry_attic_type] = "VentedAttic"
-                args[:geometry_roof_type] = "gable"
+                args[:geometry_roof_type] = 'gable'
               when 'attic - unvented'
-                args[:geometry_attic_type] = "UnventedAttic"
-                args[:geometry_roof_type] = "gable"
+                args[:geometry_attic_type] = 'UnventedAttic'
+                args[:geometry_roof_type] = 'gable'
               when 'attic - conditioned'
-                args[:geometry_attic_type] = "ConditionedAttic"
-                args[:geometry_roof_type] = "gable"
+                args[:geometry_attic_type] = 'ConditionedAttic'
+                args[:geometry_roof_type] = 'gable'
               end
             rescue
             end
@@ -505,60 +521,76 @@ module URBANopt
             args[:geometry_num_bedrooms] = feature.number_of_bedrooms
             args[:geometry_num_bedrooms] /= args[:geometry_building_num_units]
 
-            # SCHEDULES
-
-            args[:schedules_type] = 'stochastic'
             begin
-              schedules_random_seed = Float(feature_id)
-              if schedules_random_seed % 1 == 0
-                args[:schedules_random_seed] = Integer(schedules_random_seed)
+              num_garage_spaces = 0
+              if feature.onsite_parking_fraction
+                num_garage_spaces = 1
+                if args[:geometry_cfa] > 2500.0
+                  num_garage_spaces = 2
+                end
               end
+              args[:geometry_garage_width] = 12.0 * num_garage_spaces
+              args[:geometry_garage_protrusion] = 1.0
             rescue
             end
 
+            args[:neighbor_left_distance] = 0.0
+            args[:neighbor_right_distance] = 0.0
+
+            # SCHEDULES
+
+            feature_ids = []
+            scenario.feature_file.features.each do |feature|
+              feature_ids << feature.id
+            end
+
+            args[:schedules_type] = 'stochastic'
+            args[:feature_id] = feature_ids.index(feature_id)
+            args[:schedules_variation] = 'building' # building or unit
+
             # HVAC
 
-            system_type = "Residential - furnace and central air conditioner"
+            system_type = 'Residential - furnace and central air conditioner'
             begin
               system_type = feature.system_type
             rescue
             end
 
-            args[:heating_system_type] = "none"
+            args[:heating_system_type] = 'none'
             if system_type.include?('electric resistance')
-              args[:heating_system_type] = "ElectricResistance"
+              args[:heating_system_type] = 'ElectricResistance'
             elsif system_type.include?('furnace')
-              args[:heating_system_type] = "Furnace"
+              args[:heating_system_type] = 'Furnace'
             elsif system_type.include?('boiler')
-              args[:heating_system_type] = "Boiler"
+              args[:heating_system_type] = 'Boiler'
             end
 
-            args[:cooling_system_type] = "none"
+            args[:cooling_system_type] = 'none'
             if system_type.include?('central air conditioner')
-              args[:cooling_system_type] = "central air conditioner"
+              args[:cooling_system_type] = 'central air conditioner'
             elsif system_type.include?('room air conditioner')
-              args[:cooling_system_type] = "room air conditioner"
+              args[:cooling_system_type] = 'room air conditioner'
             elsif system_type.include?('evaporative cooler')
-              args[:cooling_system_type] = "evaporative cooler"
+              args[:cooling_system_type] = 'evaporative cooler'
             end
 
-            args[:heat_pump_type] = "none"
+            args[:heat_pump_type] = 'none'
             if system_type.include?('air-to-air')
-              args[:heat_pump_type] = "air-to-air"
+              args[:heat_pump_type] = 'air-to-air'
             elsif system_type.include?('mini-split')
-              args[:heat_pump_type] = "mini-split"
+              args[:heat_pump_type] = 'mini-split'
             elsif system_type.include?('ground-to-air')
-              args[:heat_pump_type] = "ground-to-air"
+              args[:heat_pump_type] = 'ground-to-air'
             end
 
-            args[:heating_system_fuel] = "natural gas"
+            args[:heating_system_fuel] = 'natural gas'
             begin
               args[:heating_system_fuel] = feature.heating_system_fuel_type
             rescue
             end
 
-            if args[:heating_system_type] == "ElectricResistance"
-              args[:heating_system_fuel] = "electricity"
+            if args[:heating_system_type] == 'ElectricResistance'
+              args[:heating_system_fuel] = 'electricity'
             end
 
             # APPLIANCES
@@ -566,10 +598,7 @@ module URBANopt
             args[:cooking_range_oven_fuel_type] = args[:heating_system_fuel]
             args[:clothes_dryer_fuel_type] = args[:heating_system_fuel]
 
-            # VENTILATION
-
-            args[:kitchen_fans_present] = true
-            args[:bathroom_fans_present] = true
+            # WATER HEATER
 
             args[:water_heater_fuel_type] = args[:heating_system_fuel]
 
@@ -614,21 +643,21 @@ module URBANopt
 
                 # HVAC
 
-                if args[:heating_system_type] != "none"
+                if args[:heating_system_type] != 'none'
                   heating_system_filepath = File.join(File.dirname(__FILE__), 'residential/heating_system.tsv')
                   heating_system = get_lookup_tsv(args, heating_system_filepath)
                   row = get_lookup_row(args, heating_system, template_vals)
                   args.update(row) unless row.nil?
                 end
 
-                if args[:cooling_system_type] != "none"
+                if args[:cooling_system_type] != 'none'
                   cooling_system_filepath = File.join(File.dirname(__FILE__), 'residential/cooling_system.tsv')
                   cooling_system = get_lookup_tsv(args, cooling_system_filepath)
                   row = get_lookup_row(args, cooling_system, template_vals)
                   args.update(row) unless row.nil?
                 end
 
-                if args[:heat_pump_type] != "none"
+                if args[:heat_pump_type] != 'none'
                   heat_pump_filepath = File.join(File.dirname(__FILE__), 'residential/heat_pump.tsv')
                   heat_pump = get_lookup_tsv(args, heat_pump_filepath)
                   row = get_lookup_row(args, heat_pump, template_vals)
@@ -644,13 +673,20 @@ module URBANopt
                   args.update(row) unless row.nil?
                 end
 
-                # VENTILATION
+                # MECHANICAL VENTILATION
 
-                mechvent_filepath = File.join(File.dirname(__FILE__), "residential/mechanical_ventilation.tsv")
+                mechvent_filepath = File.join(File.dirname(__FILE__), 'residential/mechanical_ventilation.tsv')
                 mechvent = get_lookup_tsv(args, mechvent_filepath)
                 row = get_lookup_row(args, mechvent, template_vals)
                 args.update(row) unless row.nil?
 
+                # EXHAUST
+
+                exhaust_filepath = File.join(File.dirname(__FILE__), 'residential/exhaust.tsv')
+                exhaust = get_lookup_tsv(args, exhaust_filepath)
+                row = get_lookup_row(args, exhaust, template_vals)
+                args.update(row) unless row.nil?
+
                 # WATER HEATER
 
                 water_heater_filepath = File.join(File.dirname(__FILE__), 'residential/water_heater.tsv')
@@ -679,6 +715,8 @@ module URBANopt
 
             args.keys.each do |arg_name|
               unless default_args.keys.include? arg_name
+                next if [:feature_id, :schedules_variation].include?(arg_name)
+
                 puts "Argument '#{arg_name}' is unknown."
               end
             end
@@ -709,10 +747,13 @@ module URBANopt
 
             OpenStudio::Extension.set_measure_argument(osw, 'set_run_period', '__SKIP__', false)
             # set_run_period
+
             begin
               timesteps_per_hour = feature.timesteps_per_hour
               if timesteps_per_hour
                 OpenStudio::Extension.set_measure_argument(osw, 'set_run_period', 'timesteps_per_hour', timesteps_per_hour)
+              else
+                puts "No timesteps_per_hours set in the feature file...using default"
               end
             rescue StandardError
             end
@@ -724,6 +765,8 @@ module URBANopt
                   begin_date = begin_date[0, 10]
                 end
                 OpenStudio::Extension.set_measure_argument(osw, 'set_run_period', 'begin_date', begin_date)
+              else
+                puts "no simulation begin_date set in the feature file...using default"
               end
             rescue StandardError
             end
@@ -735,6 +778,8 @@ module URBANopt
                   end_date = end_date[0, 10]
                 end
                 OpenStudio::Extension.set_measure_argument(osw, 'set_run_period', 'end_date', end_date)
+              else
+                puts "no simulation end_date set in the feature file...using default"
               end
             rescue StandardError
             end
@@ -766,6 +811,9 @@ module URBANopt
                 number_of_stories_below_ground = 0
               end
               template = building_hash.key?(:template) ? building_hash[:template] : nil
+              if template.nil?
+                raise "Template is not defined in the feature file"
+              end
               footprint_area = building_hash[:footprint_area]
 
               mapped_building_type_1 = lookup_building_type(building_type_1, template, footprint_area, number_of_stories)

data/example_files/mappers/CreateBar.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.
@@ -28,7 +38,7 @@
 # OF THE POSSIBILITY OF SUCH DAMAGE.
 # *********************************************************************************
 
-require 'urbanopt/scenario'
+require 'urbanopt/reporting'
 require 'openstudio/common_measures'
 require 'openstudio/model_articulation'
 require 'openstudio/ee_measures'

data/example_files/mappers/EvCharging.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.
@@ -41,14 +51,14 @@ module URBANopt
     class EvChargingMapper < HighEfficiencyMapper
       def create_osw(scenario, features, feature_names)
         osw = super(scenario, features, feature_names)
-        
+
         feature = features[0]
 
         def ev_charging_type(building_type)
           typical_home = ['Single-Family', 'Multifamily (2 to 4 units)', 'Multifamily (5 or more units)', 'Lodging']
           typical_public = ['Public assembly', 'Strip shopping mall', 'Enclosed mall', 'Retail other than mall', 'Food service', 'Nonrefrigerated warehouse', 'Food sales', 'Refrigerated warehouse', 'Religious worship', 'Service', 'Public order and safety', 'Uncovered Parking', 'Covered Parking']
           typical_work = ['Office', 'Laboratory', 'Education', 'Inpatient health care', 'Outpatient health care', 'Nursing']
-  
+
           if typical_home.include? building_type
             return 'Typical Home'
           elsif typical_public.include? building_type
@@ -57,7 +67,7 @@ module URBANopt
             return 'Typical Work'
           end
         end
-  
+
         # add EV loads
         ev_charging = nil
 
@@ -65,7 +75,7 @@ module URBANopt
           ev_charging = feature.ev_charging
         rescue
         end
-          
+
         if ev_charging != true
           puts "Please set ev_charging to true to add EV loads."
         elsif ev_charging == true