urbanopt-cli 0.8.3 → 0.9.1

data/example_files/mappers/Baseline.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2023, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -34,6 +34,7 @@ require 'openstudio/model_articulation'
 require 'openstudio/ee_measures'
 require 'openstudio/calibration'
 require 'openstudio/load_flexibility_measures'
+require 'openstudio/geb'
 
 require 'json'
 require 'rexml/document'
@@ -775,7 +776,7 @@ module URBANopt
             rescue StandardError
             end
 
-            args[:geometry_unit_num_occupants] = 'auto'
+#            args[:geometry_unit_num_occupants] = 'auto'
             begin
               args[:geometry_unit_num_occupants] = (feature.number_of_occupants / args[:geometry_building_num_units]).to_s
             rescue StandardError
@@ -938,7 +939,9 @@ module URBANopt
                 appliances_filepath = File.join(File.dirname(__FILE__), "residential/#{appliance}.tsv")
                 appliances = get_lookup_tsv(args, appliances_filepath)
                 row = get_lookup_row(args, appliances, template_vals)
+
                 args.update(row) unless row.nil?
+
               end
 
               # MECHANICAL VENTILATION
@@ -949,11 +952,11 @@ module URBANopt
               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?
+              # deprecated in OpenStudio-HPXML v1.5.0
+              # 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
 
@@ -1016,7 +1019,7 @@ module URBANopt
             # can enable reporting (commercial building types only for now)
             # OpenStudio::Extension.set_measure_argument(osw, 'openstudio_results', '__SKIP__', false)
             # OpenStudio::Extension.set_measure_argument(osw, 'envelope_and_internal_load_breakdown', '__SKIP__', false)
-            # OpenStudio::Extension.set_measure_argument(osw, 'generic_qaqc', '__SKIP__', false)
+            OpenStudio::Extension.set_measure_argument(osw, 'generic_qaqc', '__SKIP__', false)
 
             begin
               timesteps_per_hour = feature.timesteps_per_hour

data/example_files/mappers/ChilledWaterStorage.rb

@@ -0,0 +1,98 @@
+# *********************************************************************************
+# URBANopt™, Copyright (c) 2019-2022, 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.
+# *********************************************************************************
+# Mapper created by LBNL using the measure from openstudio-geb gem
+# (https://github.com/LBNL-ETA/Openstudio-GEB-gem)
+# *********************************************************************************
+
+require 'urbanopt/reporting'
+
+
+require_relative 'Baseline'
+
+require 'json'
+
+module URBANopt
+  module Scenario
+    class ChilledWaterStorageMapper < 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_chilled_water_storage_tank', '__SKIP__', false)
+          # Provide a tank volume in m3 or a sizing run will be run to decide the tank volume automatically
+          # OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'tank_vol', 2)
+
+          # Select to use the tank for "Full Storage" or "Partial Storage"
+          OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'objective', 'Partial Storage')
+
+          # Select a plant loop as the primary loop to add the water tank on. By default it will be "Chilled water loop" if exists
+          # OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'selected_primary_loop_name', "Chilled water loop")
+
+          # Primary Loop (charging) Setpoint Temperature in degree C
+          OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'primary_loop_sp', 6.7)
+          # Secondary Loop (discharging) Setpoint Temperature in degree C
+          OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'secondary_loop_sp', 6.7)
+          # Chilled Water Tank Setpoint Temperature in degree C
+          OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'tank_charge_sp', 6.7)
+          # Loop Design Temperature Difference in degree C. Use the existing setting or provide a numeric value
+          OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'primary_delta_t', 'Use Existing Loop Value')
+          # Secondary Loop Design Temperature Difference in degree C
+          OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'secondary_delta_t', 4.5)
+
+          # Seasonal Availability of Chilled Water Storage. Use MM/DD-MM/DD format, e.g., 04/01-10/31, default is full year.
+          OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'thermal_storage_season', '01/01-12/31')
+          # Starting Time for Chilled Water Tank Discharge. Use 24 hour format (HH:MM)
+          OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'discharge_start', '08:00')
+          # End Time for Chilled Water Tank Discharge. Use 24 hour format (HH:MM)
+          OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'discharge_end', '21:00')
+          # Starting Time for Chilled Water Tank Charge. Use 24 hour format (HH:MM)
+          OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'charge_start', '23:00')
+          # End Time for Chilled Water Tank Charge. Use 24 hour format (HH:MM)
+          OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'charge_end', '07:00')
+
+          # Allow Chilled Water Tank Work on Weekends?
+          OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'wknds', false)
+
+          # Provide an output path for tank sizing run (if tank volume is not provided)
+          OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'run_output_path', '.')
+
+          # Provide a epw file path for tank sizing run (if tank volume is not provided). By default it uses the model's weather file
+          # OpenStudio::Extension.set_measure_argument(osw, 'add_chilled_water_storage_tank', 'epw_path', feature.weather_filename)
+        end
+
+        return osw
+      end
+    end
+  end
+end

data/example_files/mappers/ClassProject.rb

@@ -0,0 +1,110 @@
+# *********************************************************************************
+# URBANopt™, Copyright (c) 2019-2023, 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 'openstudio/common_measures'
+require 'openstudio/model_articulation'
+require 'openstudio/ee_measures'
+require 'openstudio/calibration'
+
+require_relative 'Baseline'
+
+require 'json'
+
+module URBANopt
+  module Scenario
+    class ClassProjectMapper < BaselineMapper
+      def create_osw(scenario, features, feature_names)
+        osw = super(scenario, features, feature_names)
+
+        feature = features[0]
+        building_type = feature.building_type
+    
+        # Energy Efficiency Measures
+
+        OpenStudio::Extension.set_measure_argument(osw, 'AddOverhangsByProjectionFactor', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'AddOverhangsByProjectionFactor', 'projection_factor', 0.5)
+
+        OpenStudio::Extension.set_measure_argument(osw, 'EnableDemandControlledVentilation', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'EnableDemandControlledVentilation', 'dcv_type', 'EnableDCV')
+
+        OpenStudio::Extension.set_measure_argument(osw, 'EnableEconomizerControl', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'EnableEconomizerControl', 'economizer_type', 'FixedDryBulb')
+
+        OpenStudio::Extension.set_measure_argument(osw, 'ImproveFanBeltEfficiency', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'ImproveFanBeltEfficiency', 'motor_eff', 3.0)
+
+        OpenStudio::Extension.set_measure_argument(osw, 'ImproveMotorEfficiency', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'ImproveMotorEfficiency', 'motor_eff', 96.0)
+
+        OpenStudio::Extension.set_measure_argument(osw, 'IncreaseInsulationRValueForExteriorWalls', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'IncreaseInsulationRValueForExteriorWalls', 'r_value', 13.0)
+
+        OpenStudio::Extension.set_measure_argument(osw, 'IncreaseInsulationRValueForRoofs', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'IncreaseInsulationRValueForRoofs', 'r_value', 30.0)
+
+        OpenStudio::Extension.set_measure_argument(osw, 'ReduceElectricEquipmentLoadsByPercentage', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'ReduceElectricEquipmentLoadsByPercentage', 'elecequip_power_reduction_percent', 30.0)
+
+        OpenStudio::Extension.set_measure_argument(osw, 'ReduceLightingLoadsByPercentage', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'ReduceLightingLoadsByPercentage', 'lighting_power_reduction_percent', 30.0)
+
+        OpenStudio::Extension.set_measure_argument(osw, 'ReduceSpaceInfiltrationByPercentage', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'ReduceSpaceInfiltrationByPercentage', 'space_infiltration_reduction_percent', 30.0)
+
+        # Demand Flexibility Measures
+
+        OpenStudio::Extension.set_measure_argument(osw, 'add_ev_load', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'add_ev_load', 'delay_type', 'Min Delay')
+
+        OpenStudio::Extension.set_measure_argument(osw, 'add_ems_to_control_ev_charging', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'add_ems_to_control_ev_charging', 'curtailment_frac', 0.95)
+
+        OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'vol', 2)
+        OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'max_temp', 185)
+        OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'min_temp', 125)
+        OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'flex0', 'Charge - Heat Pump')
+        OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'flex_hrs0', '02:00-08:00')
+        OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'flex1', 'Float')
+        OpenStudio::Extension.set_measure_argument(osw, 'add_hpwh', 'flex_hrs1', '08:01-20:00')
+
+        OpenStudio::Extension.set_measure_argument(osw,'add_packaged_ice_storage', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw,'add_packaged_ice_storage', 'ice_cap', 'AutoSize')
+
+        OpenStudio::Extension.set_measure_argument(osw, 'ShiftScheduleByType', '__SKIP__', true)
+        OpenStudio::Extension.set_measure_argument(osw, 'ShiftScheduleByType', 'shift_value', -2)
+        OpenStudio::Extension.set_measure_argument(osw, 'ShiftScheduleByType', 'schedchoice', 'CoolHeat')
+
+        return osw
+      end
+    end
+  end
+end

data/example_files/mappers/CreateBar.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2023, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -33,6 +33,7 @@ require 'openstudio/common_measures'
 require 'openstudio/model_articulation'
 require 'openstudio/ee_measures'
 require 'openstudio/calibration'
+require 'openstudio/geb'
 
 require 'json'
 

data/example_files/mappers/EvCharging.rb

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

data/example_files/mappers/FlexibleHotWater.rb

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

data/example_files/mappers/Floorspace.rb

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

data/example_files/mappers/HighEfficiency.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2023, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -58,17 +58,19 @@ module URBANopt
           end
 
           args[:wall_assembly_r] = Float(args[:wall_assembly_r]) * 1.2 # 20% increase
-          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
-          args[:refrigerator_usage_multiplier] = Float(args[:refrigerator_usage_multiplier]) * 0.9 # 10% reduction
-          args[:cooking_range_oven_usage_multiplier] = Float(args[:cooking_range_oven_usage_multiplier]) * 0.9 # 10% reduction
-          args[:water_fixtures_usage_multiplier] = Float(args[:water_fixtures_usage_multiplier]) * 0.9 # 10% reduction
+          # the following are no longer required in HPXML v1.5.0
+          # if this isn't set, set to 90% (0.9), else reduce to 90% of set value
+          args[:misc_plug_loads_television_usage_multiplier] = args[:misc_plug_loads_television_usage_multiplier].nil? ? 0.9 : Float(args[:misc_plug_loads_television_usage_multiplier]) * 0.9 # 10% reduction
+          args[:misc_plug_loads_other_usage_multiplier] = args[:misc_plug_loads_other_usage_multiplier].nil? ? 0.9 : Float(args[:misc_plug_loads_other_usage_multiplier]) * 0.9 # 10% reduction
+          args[:lighting_interior_usage_multiplier] = args[:lighting_interior_usage_multiplier].nil? ? 0.9 : Float(args[:lighting_interior_usage_multiplier]) * 0.9 # 10% reduction
+          args[:lighting_exterior_usage_multiplier] = args[:lighting_exterior_usage_multiplier].nil? ? 0.9 : Float(args[:lighting_exterior_usage_multiplier]) * 0.9 # 10% reduction
+          args[:lighting_garage_usage_multiplier] = args[:lighting_garage_usage_multiplier].nil? ? 0.9 : Float(args[:lighting_garage_usage_multiplier]) * 0.9 # 10% reduction
+          args[:clothes_washer_usage_multiplier] = args[:clothes_washer_usage_multiplier].nil? ? 0.9 : Float(args[:clothes_washer_usage_multiplier]) * 0.9 # 10% reduction
+          args[:clothes_dryer_usage_multiplier] = args[:clothes_dryer_usage_multiplier].nil? ? 0.9 : Float(args[:clothes_dryer_usage_multiplier]) * 0.9 # 10% reduction
+          args[:dishwasher_usage_multiplier] = args[:dishwasher_usage_multiplier].nil? ? 0.9 : Float(args[:dishwasher_usage_multiplier]) * 0.9 # 10% reduction
+          args[:refrigerator_usage_multiplier] = args[:refrigerator_usage_multiplier].nil? ? 0.9 : Float(args[:refrigerator_usage_multiplier]) * 0.9 # 10% reduction
+          args[:cooking_range_oven_usage_multiplier] = args[:cooking_range_oven_usage_multiplier].nil? ? 0.9 : Float(args[:cooking_range_oven_usage_multiplier]) * 0.9 # 10% reduction
+          args[:water_fixtures_usage_multiplier] = args[:water_fixtures_usage_multiplier].nil? ? 0.9 : Float(args[:water_fixtures_usage_multiplier]) * 0.9 # 10% reduction
 
           args.each do |arg_name, arg_val|
             OpenStudio::Extension.set_measure_argument(osw, 'BuildResidentialModel', arg_name, arg_val)

data/example_files/mappers/HighEfficiencyCreateBar.rb

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

data/example_files/mappers/HighEfficiencyFloorspace.rb

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

data/example_files/mappers/PeakHoursMelsShedding.rb

@@ -0,0 +1,72 @@
+# *********************************************************************************
+# URBANopt™, Copyright (c) 2019-2023, 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.
+# *********************************************************************************
+# Mapper created by LBNL using the measure from openstudio-geb gem
+# (https://github.com/LBNL-ETA/Openstudio-GEB-gem)
+# *********************************************************************************
+
+require 'urbanopt/reporting'
+
+require_relative 'Baseline'
+
+require 'json'
+
+module URBANopt
+  module Scenario
+    class PeakHoursMelsSheddingMapper < BaselineMapper
+      # The measure reduces electric equipment loads by a user-specified percentage for a user-specified time period (usually the peak hours).
+      # The reduction can be applied to at most three periods throughout out the year specified by the user.
+      # This is applied throughout the entire building.
+      def create_osw(scenario, features, feature_names)
+        osw = super(scenario, features, feature_names)
+        OpenStudio::Extension.set_measure_argument(osw, 'reduce_epd_by_percentage_for_peak_hours', '__SKIP__', false)
+        # Percentage Reduction of Electric Equipment Power (%). Enter a value between 0 and 100
+        OpenStudio::Extension.set_measure_argument(osw, 'reduce_epd_by_percentage_for_peak_hours', 'epd_reduce_percent', 50.0)
+        # Starting Time for the Reduction in HH:MM:SS format
+        OpenStudio::Extension.set_measure_argument(osw, 'reduce_epd_by_percentage_for_peak_hours', 'start_time', '17:00:00')
+        # End Time for the Reduction in HH:MM:SS format
+        OpenStudio::Extension.set_measure_argument(osw, 'reduce_epd_by_percentage_for_peak_hours', 'end_time', '21:00:00')
+
+        # First Starting Date for the Reduction in MM-DD format
+        OpenStudio::Extension.set_measure_argument(osw, 'reduce_epd_by_percentage_for_peak_hours', 'start_date1', '07-01')
+        # First End Date for the Reduction in MM-DD format
+        OpenStudio::Extension.set_measure_argument(osw, 'reduce_epd_by_percentage_for_peak_hours', 'end_date1', '08-31')
+        # Second Starting Date for the Reduction in MM-DD format. Leave it blank if not needed
+        # OpenStudio::Extension.set_measure_argument(osw, 'reduce_epd_by_percentage_for_peak_hours', 'start_date2', '')
+        # Second End Date for the Reduction in MM-DD format. Leave it blank if not needed
+        # OpenStudio::Extension.set_measure_argument(osw, 'reduce_epd_by_percentage_for_peak_hours', 'end_date2', '')
+        # Third Starting Date for the Reduction in MM-DD format. Leave it blank if not needed
+        # OpenStudio::Extension.set_measure_argument(osw, 'reduce_epd_by_percentage_for_peak_hours', 'start_date3', '')
+        # Third End Date for the Reduction in MM-DD format. Leave it blank if not needed
+        # OpenStudio::Extension.set_measure_argument(osw, 'reduce_epd_by_percentage_for_peak_hours', 'end_date3', '')
+        return osw
+      end
+    end
+  end
+end

data/example_files/mappers/PeakHoursThermostatAdjust.rb

@@ -0,0 +1,78 @@
+# *********************************************************************************
+# URBANopt™, Copyright (c) 2019-2023, 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.
+# *********************************************************************************
+# Mapper created by LBNL using the measure from openstudio-geb gem
+# (https://github.com/LBNL-ETA/Openstudio-GEB-gem)
+# *********************************************************************************
+
+require 'urbanopt/reporting'
+
+require_relative 'Baseline'
+
+require 'json'
+
+module URBANopt
+  module Scenario
+    class PeakHoursThermostatAdjustMapper < BaselineMapper
+      # The measure adjusts heating and cooling setpoints by a user-specified number of degrees and a user-specified time period.
+      # This is applied throughout the entire building.
+      def create_osw(scenario, features, feature_names)
+        osw = super(scenario, features, feature_names)
+        OpenStudio::Extension.set_measure_argument(osw, 'AdjustThermostatSetpointsByDegreesForPeakHours', '__SKIP__', false)
+        # Degrees Fahrenheit to Adjust Cooling Setpoint By
+        OpenStudio::Extension.set_measure_argument(osw, 'AdjustThermostatSetpointsByDegreesForPeakHours', 'cooling_adjustment', 2.0)
+        # Daily Start Time for Cooling Adjustment. Use 24 hour format HH:MM:SS
+        OpenStudio::Extension.set_measure_argument(osw, 'AdjustThermostatSetpointsByDegreesForPeakHours', 'cooling_daily_starttime', '16:01:00')
+        # Daily End Time for Cooling Adjustment. Use 24 hour format HH:MM:SS
+        OpenStudio::Extension.set_measure_argument(osw, 'AdjustThermostatSetpointsByDegreesForPeakHours', 'cooling_daily_endtime', '20:00:00')
+        # Start Date for Cooling Adjustment in MM-DD format
+        OpenStudio::Extension.set_measure_argument(osw, 'AdjustThermostatSetpointsByDegreesForPeakHours', 'cooling_startdate', '06-01')
+        # End Date for Cooling Adjustment in MM-DD format
+        OpenStudio::Extension.set_measure_argument(osw, 'AdjustThermostatSetpointsByDegreesForPeakHours', 'cooling_enddate', '09-30')
+
+        # Degrees Fahrenheit to Adjust Heating Setpoint By
+        OpenStudio::Extension.set_measure_argument(osw, 'AdjustThermostatSetpointsByDegreesForPeakHours', 'heating_adjustment', -2.0)
+        # Daily Start Time for Heating Adjustment. Use 24 hour format HH:MM:SS
+        OpenStudio::Extension.set_measure_argument(osw, 'AdjustThermostatSetpointsByDegreesForPeakHours', 'heating_daily_starttime', '18:01:00')
+        # Daily End Time for Heating Adjustment. Use 24 hour format HH:MM:SS
+        OpenStudio::Extension.set_measure_argument(osw, 'AdjustThermostatSetpointsByDegreesForPeakHours', 'heating_daily_endtime', '22:00:00')
+        # Start Date for Heating Adjustment Period 1 in MM-DD format
+        OpenStudio::Extension.set_measure_argument(osw, 'AdjustThermostatSetpointsByDegreesForPeakHours', 'heating_startdate_1', '01-01')
+        # End Date for Heating Adjustment Period 1 in MM-DD format
+        OpenStudio::Extension.set_measure_argument(osw, 'AdjustThermostatSetpointsByDegreesForPeakHours', 'heating_enddate_1', '05-31')
+        # Start Date for Heating Adjustment Period 2 in MM-DD format
+        OpenStudio::Extension.set_measure_argument(osw, 'AdjustThermostatSetpointsByDegreesForPeakHours', 'heating_startdate_2', '10-01')
+        # End Date for Heating Adjustment Period 2 in MM-DD format
+        OpenStudio::Extension.set_measure_argument(osw, 'AdjustThermostatSetpointsByDegreesForPeakHours', 'heating_enddate_2', '12-31')
+
+        return osw
+      end
+    end
+  end
+end

data/example_files/mappers/ThermalStorage.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2023, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -32,6 +32,7 @@ require 'urbanopt/reporting'
 require 'openstudio/common_measures'
 require 'openstudio/model_articulation'
 require 'openstudio/load_flexibility_measures'
+require 'openstudio/geb'
 
 require_relative 'HighEfficiency'
 

data/example_files/mappers/base_workflow.osw

@@ -103,6 +103,20 @@
         "add_hvac": true,
         "use_upstream_args": false
       }
+    },{
+      "measure_dir_name": "add_chilled_water_storage_tank",
+      "arguments": {
+        "__SKIP__": true,
+        "objective": "Partial Storage",
+        "primary_loop_sp": 6.7,
+        "secondary_loop_sp": 6.7,
+        "primary_delta_t": "Use Existing Loop Value",
+        "discharge_start": "08:00",
+        "discharge_end": "21:00",
+        "charge_start": "23:00",
+        "charge_end": "07:00",
+        "run_output_path": "."
+      }
     },{
       "measure_dir_name": "add_ems_emissions_reporting",
       "arguments": {
@@ -123,6 +137,34 @@
         "clothingSchedule":"Clothing Schedule",
         "airVelocitySchedule":"Air Velocity Schedule"
       }
+    },{
+      "measure_dir_name": "reduce_epd_by_percentage_for_peak_hours",
+      "arguments": {
+        "__SKIP__": true,
+        "epd_reduce_percent": 50,
+        "start_time": "17:00:00",
+        "end_time": "21:00:00",
+        "start_date1": "07-01",
+        "end_date1": "08-31"
+      }
+    },
+    {
+      "measure_dir_name": "AdjustThermostatSetpointsByDegreesForPeakHours",
+      "arguments": {
+        "__SKIP__": true,
+        "cooling_adjustment": 2,
+        "cooling_daily_starttime": "16:01:00",
+        "cooling_daily_endtime": "20:00:00",
+        "cooling_startdate": "06-01",
+        "cooling_enddate": "09-30",
+        "heating_adjustment": 2,
+        "heating_daily_starttime": "16:01:00",
+        "heating_daily_endtime": "20:00:00",
+        "heating_startdate_1": "01-01",
+        "heating_enddate_1": "05-31",
+        "heating_startdate_2": "10-01",
+        "heating_enddate_2": "12-31"
+      }
     },{
       "measure_dir_name": "IncreaseInsulationRValueForExteriorWalls",
       "arguments": {
@@ -174,20 +216,6 @@
         "__SKIP__":false
       }
     },{
-      "measure_dir_name": "default_feature_reports",
-      "arguments": {
-        "feature_id": null,
-        "feature_name": null,
-        "feature_type": null,
-        "feature_location": null
-      }
-    },{
-      "measure_dir_name": "openstudio_results",
-      "arguments": {
-        "__SKIP__": true
-      }
-    },
-    {
       "measure_dir_name": "envelope_and_internal_load_breakdown",
       "arguments": {
         "__SKIP__": true
@@ -221,6 +249,19 @@
         "check_supply_air_and_thermostat_temp_difference_tol": 4.0,
         "__SKIP__": true
       }
+    },{
+      "measure_dir_name": "default_feature_reports",
+      "arguments": {
+        "feature_id": null,
+        "feature_name": null,
+        "feature_type": null,
+        "feature_location": null
+      }
+    },{
+      "measure_dir_name": "openstudio_results",
+      "arguments": {
+        "__SKIP__": true
+      }
     }
   ],
   "name": null,