openstudio-ee 0.12.0 → 0.12.4

data/lib/measures/ReduceElectricEquipmentLoadsByPercentage/measure.rb

@@ -9,18 +9,18 @@
 class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasure
   # define the name that a user will see
   def name
-    return 'Reduce Electric Equipment Loads by Percentage'
+    'Reduce Electric Equipment Loads by Percentage'
   end
 
   # human readable description
   def description
-    return 'Reduce Electric Equipment Loads by Percentage</display_name>
+    'Reduce Electric Equipment Loads by Percentage</display_name>
   <description>Reduce electric equipment loads. This will affect equipment that have a, power, power per area (LPD), or power per person value. This can be applied to the entire building or a specific space type. A positive percentage represents an increase electric equipment power, while a negative percentage can be used for an increase in electric equipment power.'
   end
 
   # human readable description of modeling approach
   def modeler_description
-    return 'Loop through all electric equipment objects in the specified space type or the entire building. Clone the definition if it has not already been cloned, rename and adjust the power based on the specified percentage. Link the new definition to the existing electric equipment instance. Loop through objects first in space types and then in spaces, but only for spaces that are in the specified space type, unless entire building has been chosen.'
+    'Loop through all electric equipment objects in the specified space type or the entire building. Clone the definition if it has not already been cloned, rename and adjust the power based on the specified percentage. Link the new definition to the existing electric equipment instance. Loop through objects first in space types and then in spaces, but only for spaces that are in the specified space type, unless entire building has been chosen.'
   end
 
   # define the arguments that the user will input
@@ -41,7 +41,7 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
     # looping through sorted hash of model objects
     space_type_args_hash.sort.map do |key, value|
       # only include if space type is used in the model
-      if !value.spaces.empty?
+      unless value.spaces.empty?
         space_type_handles << value.handle.to_s
         space_type_display_names << key
       end
@@ -53,20 +53,25 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
     space_type_display_names << '*Entire Building*'
 
     # make a choice argument for space type
-    space_type = OpenStudio::Measure::OSArgument.makeChoiceArgument('space_type', space_type_handles, space_type_display_names)
+    space_type = OpenStudio::Measure::OSArgument.makeChoiceArgument('space_type', space_type_handles,
+                                                                    space_type_display_names)
     space_type.setDisplayName('Apply the Measure to a Specific Space Type or to the Entire Model')
     space_type.setDefaultValue('*Entire Building*') # if no space type is chosen this will run on the entire building
     args << space_type
 
     # make an argument for reduction percentage
-    elecequip_power_reduction_percent = OpenStudio::Measure::OSArgument.makeDoubleArgument('elecequip_power_reduction_percent', true)
+    elecequip_power_reduction_percent = OpenStudio::Measure::OSArgument.makeDoubleArgument(
+      'elecequip_power_reduction_percent', true
+    )
     elecequip_power_reduction_percent.setDisplayName('Electric Equipment Power Reduction')
     elecequip_power_reduction_percent.setDefaultValue(30.0)
     elecequip_power_reduction_percent.setUnits('%')
     args << elecequip_power_reduction_percent
 
     # make an argument for material and installation cost
-    material_and_installation_cost = OpenStudio::Measure::OSArgument.makeDoubleArgument('material_and_installation_cost', true)
+    material_and_installation_cost = OpenStudio::Measure::OSArgument.makeDoubleArgument(
+      'material_and_installation_cost', true
+    )
     material_and_installation_cost.setDisplayName('Increase in Material and Installation Cost for Electric Equipment per Floor Area')
     material_and_installation_cost.setDefaultValue(0.0)
     material_and_installation_cost.setUnits('%')
@@ -113,7 +118,7 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
     om_frequency.setUnits('whole years')
     args << om_frequency
 
-    return args
+    args
   end
 
   # define what happens when the measure is run
@@ -121,13 +126,12 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
     super(model, runner, user_arguments)
 
     # use the built-in error checking
-    if !runner.validateUserArguments(arguments(model), user_arguments)
-      return false
-    end
+    return false unless runner.validateUserArguments(arguments(model), user_arguments)
 
     # assign the user inputs to variables
     object = runner.getOptionalWorkspaceObjectChoiceValue('space_type', user_arguments, model)
-    elecequip_power_reduction_percent = runner.getDoubleArgumentValue('elecequip_power_reduction_percent', user_arguments)
+    elecequip_power_reduction_percent = runner.getDoubleArgumentValue('elecequip_power_reduction_percent',
+                                                                      user_arguments)
     material_and_installation_cost = runner.getDoubleArgumentValue('material_and_installation_cost', user_arguments)
     demolition_cost = runner.getDoubleArgumentValue('demolition_cost', user_arguments)
     years_until_costs_start = runner.getIntegerArgumentValue('years_until_costs_start', user_arguments)
@@ -147,15 +151,13 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
         runner.registerError("The selected space type with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
       end
       return false
+    elsif !object.get.to_SpaceType.empty?
+      space_type = object.get.to_SpaceType.get
+    elsif !object.get.to_Building.empty?
+      apply_to_building = true
     else
-      if !object.get.to_SpaceType.empty?
-        space_type = object.get.to_SpaceType.get
-      elsif !object.get.to_Building.empty?
-        apply_to_building = true
-      else
-        runner.registerError('Script Error - argument not showing up as space type or building.')
-        return false
-      end
+      runner.registerError('Script Error - argument not showing up as space type or building.')
+      return false
     end
 
     # check the elecequip_power_reduction_percent and for reasonableness
@@ -198,24 +200,25 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
       return false
     end
 
-    if om_frequency < 1
-      runner.registerError('Choose an integer greater than 0 for O & M Frequency.')
-    end
+    runner.registerError('Choose an integer greater than 0 for O & M Frequency.') if om_frequency < 1
 
     # helper to make numbers pretty (converts 4125001.25641 to 4,125,001.26 or 4,125,001). The definition be called through this measure.
     def neat_numbers(number, roundto = 2) # round to 0 or 2)
-      if roundto == 2
-        number = format '%.2f', number
-      else
-        number = number.round
-      end
+      number = if roundto == 2
+                 format '%.2f', number
+               else
+                 number.round
+               end
       # regex to add commas
       number.to_s.reverse.gsub(/([0-9]{3}(?=([0-9])))/, '\\1,').reverse
     end
 
     # helper to make it easier to do unit conversions on the fly.  The definition be called through this measure.
     def unit_helper(number, from_unit_string, to_unit_string)
-      converted_number = OpenStudio.convert(OpenStudio::Quantity.new(number, OpenStudio.createUnit(from_unit_string).get), OpenStudio.createUnit(to_unit_string).get).get.value
+      converted_number = OpenStudio.convert(
+        OpenStudio::Quantity.new(number,
+                                 OpenStudio.createUnit(from_unit_string).get), OpenStudio.createUnit(to_unit_string).get
+      ).get.value
     end
 
     # helper that loops through lifecycle costs getting total costs under "Construction" or "Salvage" category and add to counter if occurs during year 0
@@ -224,14 +227,12 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
       objects.each do |object|
         object_LCCs = object.lifeCycleCosts
         object_LCCs.each do |object_LCC|
-          if (object_LCC.category == 'Construction') || (object_LCC.category == 'Salvage')
-            if object_LCC.yearsFromStart == 0
-              counter += object_LCC.totalCost
-            end
-          end
+          next unless (object_LCC.category == 'Construction') || (object_LCC.category == 'Salvage')
+
+          counter += object_LCC.totalCost if object_LCC.yearsFromStart == 0
         end
       end
-      return counter
+      counter
     end
 
     # counter for demo cost of baseline objects
@@ -247,7 +248,9 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
     building = model.getBuilding
     building_equip_power = building.electricEquipmentPower
     building_EPD = unit_helper(building.electricEquipmentPowerPerFloorArea, 'W/m^2', 'W/ft^2')
-    runner.registerInitialCondition("The model's initial building electric equipment power was  #{neat_numbers(building_equip_power, 0)} watts, an electric equipment power density of #{neat_numbers(building_EPD)} w/ft^2.")
+    runner.registerInitialCondition("The model's initial building electric equipment power was  #{neat_numbers(
+      building_equip_power, 0
+    )} watts, an electric equipment power density of #{neat_numbers(building_EPD)} w/ft^2.")
 
     # get space types in model
     if apply_to_building
@@ -264,24 +267,23 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
       if demo_cost_initial_const == true
         baseline_object_LCCs = baseline_object.lifeCycleCosts
         baseline_object_LCCs.each do |baseline_object_LCC|
-          if baseline_object_LCC.category == 'Salvage'
-            counter += baseline_object_LCC.totalCost
-          end
+          counter += baseline_object_LCC.totalCost if baseline_object_LCC.category == 'Salvage'
         end
       end
-      return counter
+      counter
     end
 
     # def to alter performance and life cycle costs of objects
-    def alter_performance_and_lcc(object, elecequip_power_reduction_percent, material_and_installation_cost, demolition_cost, om_cost, years_until_costs_start, expected_life, om_frequency, runner)
+    def alter_performance_and_lcc(object, elecequip_power_reduction_percent, material_and_installation_cost,
+                                  demolition_cost, om_cost, years_until_costs_start, expected_life, om_frequency, runner)
       # edit clone based on percentage reduction
       new_def = object
       if !new_def.designLevel.empty?
-        new_electric_equipment_level = new_def.setDesignLevel(new_def.designLevel.get - new_def.designLevel.get * elecequip_power_reduction_percent * 0.01)
+        new_electric_equipment_level = new_def.setDesignLevel(new_def.designLevel.get - (new_def.designLevel.get * elecequip_power_reduction_percent * 0.01))
       elsif !new_def.wattsperSpaceFloorArea.empty?
-        new_electric_equipment_per_area = new_def.setWattsperSpaceFloorArea(new_def.wattsperSpaceFloorArea.get - new_def.wattsperSpaceFloorArea.get * elecequip_power_reduction_percent * 0.01)
+        new_electric_equipment_per_area = new_def.setWattsperSpaceFloorArea(new_def.wattsperSpaceFloorArea.get - (new_def.wattsperSpaceFloorArea.get * elecequip_power_reduction_percent * 0.01))
       elsif !new_def.wattsperPerson.empty?
-        new_electric_equipment_per_person = new_def.setWattsperPerson(new_def.wattsperPerson.get - new_def.wattsperPerson.get * elecequip_power_reduction_percent * 0.01)
+        new_electric_equipment_per_person = new_def.setWattsperPerson(new_def.wattsperPerson.get - (new_def.wattsperPerson.get * elecequip_power_reduction_percent * 0.01))
       else
         runner.registerWarning("'#{new_def.name}' is used by one or more instances and has no load values. Its performance was not altered.")
       end
@@ -294,15 +296,15 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
       else
         new_def_LCCs.each do |new_def_LCC|
           if new_def_LCC.category == 'Construction'
-            new_def_LCC.setCost(new_def_LCC.cost * (1 + material_and_installation_cost / 100))
+            new_def_LCC.setCost(new_def_LCC.cost * (1 + (material_and_installation_cost / 100)))
             new_def_LCC.setYearsFromStart(years_until_costs_start) # just uses argument value, does not need existing value
             new_def_LCC.setRepeatPeriodYears(expected_life) # just uses argument value, does not need existing value
           elsif new_def_LCC.category == 'Salvage'
-            new_def_LCC.setCost(new_def_LCC.cost * (1 + demolition_cost / 100))
+            new_def_LCC.setCost(new_def_LCC.cost * (1 + (demolition_cost / 100)))
             new_def_LCC.setYearsFromStart(years_until_costs_start + expected_life) # just uses argument value, does not need existing value
             new_def_LCC.setRepeatPeriodYears(expected_life) # just uses argument value, does not need existing value
           elsif new_def_LCC.category == 'Maintenance'
-            new_def_LCC.setCost(new_def_LCC.cost * (1 + om_cost / 100))
+            new_def_LCC.setCost(new_def_LCC.cost * (1 + (om_cost / 100)))
             new_def_LCC.setRepeatPeriodYears(om_frequency) # just uses argument value, does not need existing value
           end
 
@@ -320,15 +322,14 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
     # loop through space types
     space_types.each do |space_type|
       next if space_type.spaces.size <= 0
+
       space_type_equipments = space_type.electricEquipment
       space_type_equipments.each do |space_type_equipment|
         new_def = nil
 
         # clone def if it has not already been cloned
         exist_def = space_type_equipment.electricEquipmentDefinition
-        if !cloned_elecequip_defs[exist_def.name.get.to_s].nil?
-          new_def = cloned_elecequip_defs[exist_def.name.get.to_s]
-        else
+        if cloned_elecequip_defs[exist_def.name.get.to_s].nil?
           # clone rename and add to hash
           new_def = exist_def.clone(model)
           new_def_name = new_def.setName("#{exist_def.name.get} - #{elecequip_power_reduction_percent} percent reduction")
@@ -339,8 +340,11 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
           demo_costs_of_baseline_objects += add_to_baseline_demo_cost_counter(exist_def, demo_cost_initial_const)
 
           # call def to alter performance and life cycle costs
-          alter_performance_and_lcc(new_def, elecequip_power_reduction_percent, material_and_installation_cost, demolition_cost, om_cost, years_until_costs_start, expected_life, om_frequency, runner)
+          alter_performance_and_lcc(new_def, elecequip_power_reduction_percent, material_and_installation_cost,
+                                    demolition_cost, om_cost, years_until_costs_start, expected_life, om_frequency, runner)
 
+        else
+          new_def = cloned_elecequip_defs[exist_def.name.get.to_s]
         end
 
         # link instance with clone and rename
@@ -355,10 +359,8 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
     # get space types in model
     if apply_to_building
       spaces = model.getSpaces
-    else
-      if !space_type.spaces.empty?
-        spaces = space_type.spaces # only run on a single space type
-      end
+    elsif !space_type.spaces.empty?
+      spaces = space_type.spaces
     end
 
     spaces.each do |space|
@@ -366,7 +368,7 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
       space_equipments.each do |space_equipment|
         # clone def if it has not already been cloned
         exist_def = space_equipment.electricEquipmentDefinition
-        if cloned_elecequip_defs.any? { |k, v| k.to_s == exist_def.name.get.to_s }
+        if cloned_elecequip_defs.any? { |k, _v| k.to_s == exist_def.name.get.to_s }
           new_def = cloned_elecequip_defs[exist_def.name.get.to_s]
         else
           # clone rename and add to hash
@@ -379,7 +381,8 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
           demo_costs_of_baseline_objects += add_to_baseline_demo_cost_counter(exist_def, demo_cost_initial_const)
 
           # call def to alter performance and life cycle costs
-          alter_performance_and_lcc(new_def, elecequip_power_reduction_percent, material_and_installation_cost, demolition_cost, om_cost, years_until_costs_start, expected_life, om_frequency, runner)
+          alter_performance_and_lcc(new_def, elecequip_power_reduction_percent, material_and_installation_cost,
+                                    demolition_cost, om_cost, years_until_costs_start, expected_life, om_frequency, runner)
 
         end
 
@@ -400,21 +403,24 @@ class ReduceElectricEquipmentLoadsByPercentage < OpenStudio::Measure::ModelMeasu
     if demo_cost_initial_const == true
       building = model.getBuilding
       lcc_baseline_demo = OpenStudio::Model::LifeCycleCost.createLifeCycleCost('LCC_baseline_demo', building, demo_costs_of_baseline_objects, 'CostPerEach', 'Salvage', 0, years_until_costs_start).get # using 0 for repeat period since one time cost.
-      runner.registerInfo("Adding one time cost of $#{neat_numbers(lcc_baseline_demo.totalCost, 0)} related to demolition of baseline objects.")
+      runner.registerInfo("Adding one time cost of $#{neat_numbers(lcc_baseline_demo.totalCost,
+                                                                   0)} related to demolition of baseline objects.")
 
       # if demo occurs on year 0 then add to initial capital cost counter
-      if lcc_baseline_demo.yearsFromStart == 0
-        yr0_capital_totalCosts += lcc_baseline_demo.totalCost
-      end
+      yr0_capital_totalCosts += lcc_baseline_demo.totalCost if lcc_baseline_demo.yearsFromStart == 0
     end
 
     # report final condition
     final_building = model.getBuilding
     final_building_equip_power = final_building.electricEquipmentPower
     final_building_EPD = unit_helper(final_building.electricEquipmentPowerPerFloorArea, 'W/m^2', 'W/ft^2')
-    runner.registerFinalCondition("The model's final building electric equipment power was  #{neat_numbers(final_building_equip_power, 0)} watts, an electric equipment power density of #{neat_numbers(final_building_EPD)} w/ft^2. Initial capital costs associated with the improvements are $#{neat_numbers(yr0_capital_totalCosts, 0)}.")
+    runner.registerFinalCondition("The model's final building electric equipment power was  #{neat_numbers(
+      final_building_equip_power, 0
+    )} watts, an electric equipment power density of #{neat_numbers(final_building_EPD)} w/ft^2. Initial capital costs associated with the improvements are $#{neat_numbers(
+      yr0_capital_totalCosts, 0
+    )}.")
 
-    return true
+    true
   end
 end
 

data/lib/measures/ReduceElectricEquipmentLoadsByPercentage/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>reduce_electric_equipment_loads_by_percentage</name>
   <uid>0902e302-70db-4339-99b0-17f08bc93629</uid>
-  <version_id>5ea57f23-d4f2-464c-92d5-b982ad8f9d04</version_id>
-  <version_modified>2024-11-16T23:47:46Z</version_modified>
+  <version_id>8784867d-d76a-45cd-b157-dd3ae319cc8d</version_id>
+  <version_modified>2025-09-25T15:33:44Z</version_modified>
   <xml_checksum>F9A5B8F0</xml_checksum>
   <class_name>ReduceElectricEquipmentLoadsByPercentage</class_name>
   <display_name>Reduce Electric Equipment Loads by Percentage</display_name>
@@ -18,10 +18,10 @@
       <type>Choice</type>
       <required>true</required>
       <model_dependent>false</model_dependent>
-      <default_value>{a7d74ea1-85ff-4df3-b01d-8a918a8cc5a7}</default_value>
+      <default_value>{dac39ef0-d1a3-4bb2-b9ee-ebbdc6652e53}</default_value>
       <choices>
         <choice>
-          <value>{a7d74ea1-85ff-4df3-b01d-8a918a8cc5a7}</value>
+          <value>{dac39ef0-d1a3-4bb2-b9ee-ebbdc6652e53}</value>
           <display_name>*Entire Building*</display_name>
         </choice>
       </choices>
@@ -140,7 +140,7 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>8C5A8023</checksum>
+      <checksum>FFCBFF29</checksum>
     </file>
     <file>
       <filename>README.md</filename>
@@ -163,7 +163,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>2052422C</checksum>
+      <checksum>59BF0D78</checksum>
     </file>
     <file>
       <filename>EnvelopeAndLoadTestModel_01.osm</filename>
@@ -181,7 +181,7 @@
       <filename>ReduceElectricEquipmentLoadsByPercentage_Test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>807BDF94</checksum>
+      <checksum>854E8902</checksum>
     </file>
   </files>
 </measure>