openstudio-standards 0.4.0 → 0.5.0.rc1

data/lib/openstudio-standards/standards/necb/NECB2020/service_water_heating.rb

@@ -5,13 +5,13 @@ class NECB2020
   # Per PNNL http://www.energycodes.gov/sites/default/files/documents/PrototypeModelEnhancements_2014_0.pdf
   # Appendix A: Service Water Heating
   #
-  # @return [Bool] true if successful, false if not
+  # @return [Boolean] true if successful, false if not
   #
   # NECB2020 uses a different procedure calculate gas water heater efficiencies (compared to previous NECB)
   #
   def water_heater_mixed_apply_efficiency(water_heater_mixed)
     # Get the capacity of the water heater
-    # TODO add capability to pull autosized water heater capacity
+    # @todo add capability to pull autosized water heater capacity
     # if the Sizing:WaterHeater object is ever implemented in OpenStudio.
     capacity_w = water_heater_mixed.heaterMaximumCapacity
     if capacity_w.empty?
@@ -24,7 +24,7 @@ class NECB2020
     capacity_kbtu_per_hr = OpenStudio.convert(capacity_w, 'W', 'kBtu/hr').get
 
     # Get the volume of the water heater
-    # TODO add capability to pull autosized water heater volume
+    # @todo add capability to pull autosized water heater volume
     # if the Sizing:WaterHeater object is ever implemented in OpenStudio.
     volume_m3 = water_heater_mixed.tankVolume
     if volume_m3.empty?
@@ -202,7 +202,7 @@ class NECB2020
     # Skin loss
     water_heater_mixed.setOffCycleLossCoefficienttoAmbientTemperature(ua_w_per_k)
     water_heater_mixed.setOnCycleLossCoefficienttoAmbientTemperature(ua_w_per_k)
-    # TODO: Parasitic loss (pilot light)
+    # @todo Parasitic loss (pilot light)
     # PNNL document says pilot lights were removed, but IDFs
     # still have the on/off cycle parasitic fuel consumptions filled in
     water_heater_mixed.setOnCycleParasiticFuelType(fuel_type)

data/lib/openstudio-standards/standards/necb/common/btap_data.rb

@@ -158,6 +158,7 @@ class BTAPData
     building_data['cost_rs_means_prov'] = cost_result['rs_means_prov']
     building_data['cost_rs_means_city'] = cost_result['rs_means_city']
     building_data['cost_equipment_envelope_total_cost_per_m_sq'] = (cost_result['totals']['envelope']) / @conditioned_floor_area_m_sq
+    building_data['cost_equipment_thermal_bridging_total_cost_per_m_sq'] = (cost_result['totals']['thermal_bridging']) / @conditioned_floor_area_m_sq
     building_data['cost_equipment_lighting_total_cost_per_m_sq'] = (cost_result['totals']['lighting']) / @conditioned_floor_area_m_sq
     building_data['cost_equipment_heating_and_cooling_total_cost_per_m_sq'] = (cost_result['totals']['heating_and_cooling']) / @conditioned_floor_area_m_sq
     building_data['cost_equipment_shw_total_cost_per_m_sq'] = (cost_result['totals']['shw']) / @conditioned_floor_area_m_sq
@@ -1352,7 +1353,7 @@ class BTAPData
     data['energy_peak_electric_w_per_m_sq'] = electric_peak.empty? ? 0.0 : electric_peak.get / @conditioned_floor_area_m_sq
     data['energy_peak_natural_gas_w_per_m_sq'] = natural_gas_peak.empty? ? 0.0 : natural_gas_peak.get / @conditioned_floor_area_m_sq
 
-    # Peak heating load  #TODO: IMPORTANT NOTE: Peak heating load must be updated if a combination of fuel types is used in a building model.
+    # Peak heating load  # @todo IMPORTANT NOTE: Peak heating load must be updated if a combination of fuel types is used in a building model.
     command = "SELECT Value
                FROM TabularDataWithStrings
                WHERE ReportName='EnergyMeters'
@@ -1367,14 +1368,14 @@ class BTAPData
               WHERE ReportName='EnergyMeters'
               AND ReportForString='Entire Facility'
               AND TableName='Annual and Peak Values - Natural Gas'
-              AND RowName='Heating:Gas'
+              AND RowName='Heating:NaturalGas'
               AND ColumnName='Natural Gas Maximum Value'
               AND Units='W'"
     heating_peak_w_gas = @sqlite_file.get.execAndReturnFirstDouble(command)
     heating_peak_w = [heating_peak_w_electricity.to_f, heating_peak_w_gas.to_f].max
     data['heating_peak_w_per_m_sq'] = heating_peak_w / @conditioned_floor_area_m_sq
 
-    # Peak cooling load    #TODO: IMPORTANT NOTE: Peak cooling load must be updated if a combination of fuel types is used in a building model.
+    # Peak cooling load    # @todo IMPORTANT NOTE: Peak cooling load must be updated if a combination of fuel types is used in a building model.
     command = "SELECT Value
                FROM TabularDataWithStrings
                WHERE ReportName='EnergyMeters'
@@ -1422,10 +1423,14 @@ class BTAPData
       data["energy_eui_#{row['name'].downcase}_gj_per_m_sq"] = energy_columns.inject(0) { |sum, tuple| sum += tuple[1] } / @conditioned_floor_area_m_sq
     end
     data['energy_eui_total_gj_per_m_sq'] = 0.0
-    ['natural_gas_GJ', 'electricity_GJ', 'district_cooling_GJ', 'district_heating_GJ', 'additional_fuel_GJ'].each do |column|
+    ['natural_gas_GJ', 'electricity_GJ', 'additional_fuel_GJ'].each do |column|
       data["energy_eui_#{column.downcase}_per_m_sq"] = table.inject(0) { |sum, row| sum + (row[column].nil? ? 0.0 : row[column]) } / @conditioned_floor_area_m_sq
       data['energy_eui_total_gj_per_m_sq'] += data["energy_eui_#{column.downcase}_per_m_sq"] unless data["energy_eui_#{column.downcase}_per_m_sq"].nil?
     end
+    ['district_cooling_GJ', 'district_heating_GJ'].each do |column|
+      data["energy_eui_#{column.downcase}_per_m_sq"] = table.inject(0) { |sum, row| sum + (row[column].nil? ? 0.0 : row[column]) } / @conditioned_floor_area_m_sq
+    end
+
     # Get total and net site energy use intensity
     # Note: 'Total Site Energy' is the "gross" energy used by a building.
     # Note: 'Net Site Energy' is the final energy used by the building after considering any on-site energy generation (e.g. PV).
@@ -1793,7 +1798,7 @@ class BTAPData
     return var.get
   end
 
-  # TODO: SQL command units may have been converted wrong.
+  # @todo SQL command units may have been converted wrong.
 
   def get_actual_child_object(object)
     # monkey patch class to have a decendants static method to return all possible subclasses of the object.

data/lib/openstudio-standards/standards/necb/common/btap_datapoint.rb

@@ -226,7 +226,7 @@ class BTAPDatapoint
         model.setSqlFile(sql)
 
         @cost_result = nil
-        if @options[:enable_costing] == true
+        if defined?(BTAPCosting)
           # Perform costing
           costing = BTAPCosting.new
           costing.load_database

data/lib/openstudio-standards/utilities/assertion.rb

@@ -0,0 +1,128 @@
+# PRM generation custom Error
+class PRMError < StandardError
+end
+
+# PRM assertion method
+# Raise assertion if the test (bool) is failed
+#
+# Before raise the exception, the method will generate the prm.log for debugging
+# @param bool [Boolean, Object] an object for truthy evaluation
+# @param log_dir [String] log file directory
+# @param err_msg [String] message raise the exception
+def prm_raise(bool, log_dir, err_msg)
+  unless bool
+    # OpenStudio.logFree(OpenStudio::Debug, 'prm.log', log_msg)
+    log_messages_to_file_prm("#{log_dir}/prm.log", true)
+    raise PRMError, "#{err_msg} - Check debug log at #{log_dir}/prm.log for more information"
+  end
+end
+
+# PRM reading function reads user data from a hash map.
+# Handles key existence, value is nil and value string is empty
+# @param user_data [Hash] a hash contains a user data
+# @param key [String] key string
+# @param default [Object] values assigned if the data is not available.
+# @return [String] a string
+def prm_read_user_data(user_data, key, default = nil)
+  return user_data.key?(key) && !user_data[key].nil? && !user_data[key].to_s.empty? ? user_data[key] : default
+end
+
+# This is a PRM handler function handles the .get from an optional object
+# The handler will try to access the OpenStudio Object data key
+# And do it recursively until all the keys have been checked and final object get or raise exception
+# for non_initialized objects.
+# @param component [OpenStudio::Model::Component] an OpenStudio object
+# @param log_dir [string] directory to save the log
+# @param data_key [string] The data key to retrieve the data from the OpenStudio object
+# @param remaining_keys [str] Any additional keys in the path
+# @return [OpenStudio::Model::Component] the OpenStudio Object or exception raise
+def prm_get_optional_handler(component, log_dir, data_key, *remaining_keys)
+  target_data = component.send(data_key)
+  prm_raise(target_data.is_initialized,
+            log_dir,
+            "Failed to retrieve data: #{data_key} from #{prm_get_component_name(component)}"
+            )
+  target_data_get = target_data.get
+  return remaining_keys.length == 0 ? target_data_get : prm_get_optional_handler(target_data_get, log_dir, remaining_keys[0], *remaining_keys[1...])
+end
+
+# This is a PRM handler to get a name from an OpenStudio object instance
+# If the object instance does not have a name, then it will return the object name.
+#
+# @param component [OpenStudio::Model:Component] an OpenStudio object
+# @return [String] the name of the instance or object name
+def prm_get_component_name(component)
+  return 'Model' if component.is_a?(OpenStudio::Model::Model)
+
+  name = component.iddObjectType.valueName.to_s
+  if component.name.is_initialized
+    name = component.name.get
+  end
+  return name
+end
+
+
+# PRM get an additional property from an OpenStudio object as a boolean,
+# if no such additional property, then return default value.
+# @param component [OpenStudio::Model:Component] the component to get the additional property from
+# @param key [String] key string
+# @param default [Boolean] the default to return when there is no matching key
+# @return [Boolean] boolean value
+def get_additional_property_as_boolean(component, key, default = false)
+  value = default
+  if component.additionalProperties.getFeatureAsBoolean(key).is_initialized
+    value = component.additionalProperties.getFeatureAsBoolean(key).get
+  else
+    OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.utilities', "Cannot find the #{key} in component: #{component.name.get}, default value #{default} is used.")
+  end
+  return value
+end
+
+# PRM get an additional property from an OpenStudio object as a double,
+# if no such additional property, then return default value.
+# @param component [OpenStudio::Model::Component] the component to get the additional property from
+# @param key [String] key string
+# @param default [Integer] the default to return when there is no matching key
+# @return [Integer] Integer value
+def get_additional_property_as_integer(component, key, default = 0.0)
+  value = default
+  if component.additionalProperties.getFeatureAsInteger(key).is_initialized
+    value = component.additionalProperties.getFeatureAsInteger(key).get
+  else
+    OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.utilities', "Cannot find the #{key} in component: #{component.name.get}, default value #{default} is used.")
+  end
+  return value
+end
+
+# PRM get an additional property from an OpenStudio object as a double,
+# if no such additional property, then return default value.
+# @param component [OpenStudio::Model::Component] the component to get the additional property from
+# @param key [String] key string
+# @param default [Double] the default to return when there is no matching key
+# @return [Double] Double value
+def get_additional_property_as_double(component, key, default = 0.0)
+  value = default
+  if component.additionalProperties.getFeatureAsDouble(key).is_initialized
+    value = component.additionalProperties.getFeatureAsDouble(key).get
+  else
+    OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.utilities', "Cannot find the #{key} in component: #{component.name.get}, default value #{default} is used.")
+  end
+  return value
+end
+
+# PRM get an additional property from an OpenStudio object as a string,
+# if no such additional property, then return default value.
+# @param component [OpenStudio::Model::Component] the component to get the additional property from
+# @param key [String] key string
+# @param default [String] the default to return when there is no matching key
+# @return [String] String value
+def get_additional_property_as_string(component, key, default = "")
+  value = default
+  if component.additionalProperties.getFeatureAsString(key).is_initialized
+    value = component.additionalProperties.getFeatureAsString(key).get
+  else
+    OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.utilities', "Cannot find the #{key} in component: #{component.name.get}, default value #{default} is used.")
+  end
+  return value
+end
+

data/lib/openstudio-standards/utilities/logging.rb

@@ -39,11 +39,10 @@ end
 # A function that writes error message to log file and stop the execution.
 #
 # @param msg [String] error message
-# @param log_level [OpenStudio::LogLevel] log level, eg. OpenStudio::Info
 # @param log_path [String] the log file directory
 # @param debug [Boolean] debug mode
 def terminate_prm_write_log(msg, log_path, debug = false)
-  OpenStudio.logFree(OpenStudio::ERROR, 'prm.log', msg)
+  OpenStudio.logFree(OpenStudio::Error, 'prm.log', msg)
   log_messages_to_file_prm("#{log_path}/prm.log", debug)
   raise msg
 end
@@ -52,7 +51,7 @@ end
 #
 # @param file_path [String] the file path to the log file
 # @param debug [Boolean] debug mode
-# @return message [Array] array of message strings
+# @return [Array] array of message strings
 def log_messages_to_file_prm(file_path, debug = false)
   messages = []
 

data/lib/openstudio-standards/utilities/object_info.rb

@@ -1,20 +1,41 @@
-#
-# Get hash of object field names and values
-# @author: Xuechen (Jerry) Lei, PNNL
-# @param  obj [object]
-#
-# @return [Hash<String>] FieldName:Value
-#
-def getObjectHash(obj)
-  fields_array = obj.to_s.split(/\n/)
-  output_hash = { 'object type' => fields_array.shift.split(/,/)[0] }
-  right = nil
-  fields_array.each do |ori_field|
-    left, right = ori_field.split(/[,;]/)
-    left = left.strip
-    right.slice!('!-')
-    right = right.strip
-    output_hash[right] = left
+Standard.class_eval do
+  # A set of method to manipulate objects
+
+  # Get hash of object field names and values
+  # @author: Xuechen (Jerry) Lei, PNNL
+  # @param  obj [object]
+  #
+  # @return [Hash<String>] FieldName:Value
+  #
+  def model_get_object_hash(obj)
+    fields_array = obj.to_s.split(/\n/)
+    output_hash = { 'object type' => fields_array.shift.split(/,/)[0] }
+    right = nil
+    fields_array.each do |ori_field|
+      left, right = ori_field.split(/[,;]/)
+      left = left.strip
+      right.slice!('!-')
+      right = right.strip
+      output_hash[right] = left
+    end
+    return output_hash
+  end
+
+  # This method is used to automatically cast a model
+  # object based on its IDD object type
+  #
+  # @param [OpenStudio::Model::ModelObject]
+  # @return Casted OpenStudio object or nil if the cast was not possible
+  def model_cast_model_object(model_object)
+    model_object_type = model_object.iddObjectType.valueName.to_s.sub('OS_', '').strip.sub('_', '')
+    casting_method_name = "to_#{model_object_type}"
+    casted_object = nil
+
+    # Make sure that the the casting method can be applied
+    if model_object.respond_to?(casting_method_name)
+      casted_object = model_object.public_send(casting_method_name).get
+    end
+
+    return casted_object
   end
-  return output_hash
 end

data/lib/openstudio-standards/utilities/schedule_translator.rb

@@ -54,12 +54,14 @@ class ScheduleTranslator
   end
 
   # Convert from scheduleCompact to scheduleRuleset
-  # @Author Nicholas Long and Andrew Parker, NREL
-  # @Return ScheduleRuleset object
+  # @author Nicholas Long and Andrew Parker, NREL
+  # @return [OpenStudio::Model::ScheduleRuleset] OpenStudio ScheduleRuleset object
+  # @todo will fail if no limits set in source schedule
   def convert_schedule_compact_to_schedule_ruleset
     @sched_name = @os_schedule.getString(1).get
     @sched_name = "#{@name_prefix} #{@sched_name}" unless @name_prefix.nil?
-    @sched_type = @os_schedule.scheduleTypeLimits.get # TODO: - will fail if no limits set in source schedule
+    # @todo will fail if no limits set in source schedule
+    @sched_type = @os_schedule.scheduleTypeLimits.get
 
     # puts "Translating #{@sched_name}"
 
@@ -115,9 +117,9 @@ class ScheduleTranslator
         next
       end
 
-      dVal = @os_schedule.getDouble(i).get
+      d_val = @os_schedule.getDouble(i).get
       # puts "thru: #{i_thru} for: #{i_for} until #{i_until}"
-      @schedule[i_thru][:for][i_for][:until] << { timestamp: sUntil, value: dVal }
+      @schedule[i_thru][:for][i_for][:until] << { timestamp: sUntil, value: d_val }
     end
 
     # DEBUG spit out the schedule for quick check\
@@ -169,7 +171,7 @@ class ScheduleTranslator
         os_schedule_rule.setEndDate(osdate_end)
 
         # create os day model
-        # TODO break this out as a method
+        # @todo break this out as a method
         if fr[:daytype].include?('monday') || fr[:daytype].include?('alldays') || fr[:daytype].include?('weekdays')
           os_schedule_rule.setApplyMonday(true)
           coverage[:mon] = true

data/lib/openstudio-standards/utilities/simulation.rb

@@ -5,7 +5,7 @@ Standard.class_eval do
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param run_dir [String] file path location for the annual run, defaults to 'Run' in the current directory
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def model_run_simulation_and_log_errors(model, run_dir = "#{Dir.pwd}/Run")
     # Make the directory if it doesn't exist
     unless Dir.exist?(run_dir)
@@ -17,7 +17,7 @@ Standard.class_eval do
     osm_name = 'in.osm'
     osw_name = 'in.osw'
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.model.Model', "Starting simulation here: #{run_dir}.")
-    OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "Running simulation #{run_dir}.")
+    OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "Started simulation #{run_dir} at #{Time.now.strftime('%T.%L')}")
     forward_translator = OpenStudio::EnergyPlus::ForwardTranslator.new
     idf = forward_translator.translateModel(model)
     idf_path = OpenStudio::Path.new("#{run_dir}/#{idf_name}")
@@ -82,7 +82,7 @@ Standard.class_eval do
 
       sql_path = OpenStudio::Path.new("#{run_dir}/EnergyPlus/eplusout.sql")
 
-      OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Finished run.')
+      OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "Finished simulation #{run_dir} at #{Time.now.strftime('%T.%L')}")
 
     else # method to running simulation within measure using OpenStudio 2.x WorkflowJSON
 
@@ -103,7 +103,7 @@ Standard.class_eval do
 
       # 'touch' the weather file - for some odd reason this fixes the simulation not running issue we had on openstudio-server.
       # Removed for until further investigation completed.
-      #FileUtils.touch("#{run_dir}/#{epw_name}")
+      # FileUtils.touch("#{run_dir}/#{epw_name}")
 
       cli_path = OpenStudio.getOpenStudioCLI
       cmd = "\"#{cli_path}\" run -w \"#{osw_path}\""
@@ -113,7 +113,7 @@ Standard.class_eval do
       # Run the sizing run
       OpenstudioStandards.run_command(cmd)
 
-      OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Finished run.')
+      OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "Finished simulation #{run_dir} at #{Time.now.strftime('%T.%L')}")
 
       sql_path = OpenStudio::Path.new("#{run_dir}/run/eplusout.sql")
 
@@ -183,7 +183,7 @@ Standard.class_eval do
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param sizing_run_dir [String] file path location for the sizing run, defaults to 'SR' in the current directory
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def model_run_sizing_run(model, sizing_run_dir = "#{Dir.pwd}/SR")
     # Change the simulation to only run the sizing days
     sim_control = model.getSimulationControl
@@ -213,14 +213,12 @@ Standard.class_eval do
   # Method to check if all zones have surfaces. This is required to run a simulation.
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def model_do_all_zones_have_surfaces?(model)
     # Check to see if all zones have surfaces.
     model.getThermalZones.each do |zone|
       if BTAP::Geometry::Surfaces.get_surfaces_from_thermal_zones([zone]).empty?
-        error_string = "Error: Thermal zone #{zone.name} does not contain surfaces.\n"
-        puts error_string
-        OpenStudio.logFree(OpenStudio::Error, 'openstudio.Siz.Model', error_string)
+        OpenStudio.logFree(OpenStudio::Error, 'openstudio.simulation', "Thermal zone #{zone.name} does not contain surfaces.\n")
         return false
       end
     end
@@ -283,7 +281,22 @@ Standard.class_eval do
     model_run_sizing_run(model, sizing_run_dir)
     model.getSpaces.each do |space|
       unless space.thermalZone.empty?
-        space_load_array << { 'space_name' => space.name, 'CoolingDesignLoad' => space.thermalZone.get.coolingDesignLoad, 'HeatingDesignLoad' => space.thermalZone.get.heatingDesignLoad }
+        # error if zone design load methods are not available
+        if space.model.version < OpenStudio::VersionString.new('3.6.0')
+          OpenStudio.logFree(OpenStudio::Error, 'openstudio.simulation', 'Required ThermalZone methods .autosizedHeatingDesignLoad and .autosizedCoolingDesignLoad are not available in pre-OpenStudio 3.6.0 versions. Use a more recent version of OpenStudio.')
+        end
+
+        space_cooling_load = 0.0
+        if space.thermalZone.get.autosizedCoolingDesignLoad.is_initialized
+          space_cooling_load = space.thermalZone.get.autosizedCoolingDesignLoad.get
+        end
+
+        space_heating_load = 0.0
+        if space.thermalZone.get.autosizedHeatingDesignLoad.is_initialized
+          space_heating_load = space.thermalZone.get.autosizedHeatingDesignLoad.get
+        end
+
+        space_load_array << { 'space_name' => space.name, 'CoolingDesignLoad' => space_cooling_load, 'HeatingDesignLoad' => space_heating_load }
       end
     end
     puts space_load_array

data/lib/openstudio-standards/utilities/sqlfile.rb

@@ -412,10 +412,10 @@ Standard.class_eval do
     return heating_or_cooling_setpoint_unmet
   end
 
-   # Get the total unmet load hours during occupancy of a model that has been simulated
+  # Get the total unmet load hours during occupancy of a model that has been simulated
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
-  # @return [Float] returns the number of total unmet load hours during occupancy in a simulated model
+  # @return [Double] returns the number of total unmet load hours during occupancy in a simulated model
   def model_get_unmet_load_hours(model)
     result = OpenStudio::OptionalDouble.new
     sql = model.sqlFile
@@ -451,7 +451,7 @@ Standard.class_eval do
 
     return result
   end
- 
+
   # Gets the model annual energy consumption by fuel and enduse in GJ from the sql file
   #
   # @param model [OpenStudio::Model::Model] OpenStudio model object
@@ -556,8 +556,13 @@ Standard.class_eval do
     energy_values = {}
 
     # List of all fuel types, based on Table 5.1 of EnergyPlus' Input Output Reference manual
-    fuel_types = ['Electricity', 'Gas', 'Gasoline', 'Diesel', 'Coal', 'FuelOilNo1', 'FuelOilNo2', 'Propane', 'OtherFuel1', 'OtherFuel2', 'Water', 'Steam', 'DistrictCooling',
-                  'DistrictHeating', 'ElectricityPurchased', 'ElectricitySurplusSold', 'ElectricityNet']
+    if model.version < OpenStudio::VersionString.new('3.7.0')
+      fuel_types = ['Electricity', 'Gas', 'Gasoline', 'Diesel', 'Coal', 'FuelOilNo1', 'FuelOilNo2', 'Propane', 'OtherFuel1', 'OtherFuel2', 'Water', 'Steam', 'DistrictCooling',
+                    'DistrictHeating', 'ElectricityPurchased', 'ElectricitySurplusSold', 'ElectricityNet']
+    else
+      fuel_types = ['Electricity', 'Gas', 'Gasoline', 'Diesel', 'Coal', 'FuelOilNo1', 'FuelOilNo2', 'Propane', 'OtherFuel1', 'OtherFuel2', 'Water', 'DistrictCooling',
+                    'DistrictHeatingWater', 'DistrictHeatingSteam', 'ElectricityPurchased', 'ElectricitySurplusSold', 'ElectricityNet']
+    end
 
     # List of all end uses, based on Table 5.3 of EnergyPlus' Input Output Reference manual
     end_uses = ['InteriorLights', 'ExteriorLights', 'InteriorEquipment', 'ExteriorEquipment', 'Fans', 'Pumps', 'Heating', 'Cooling', 'HeatRejection', 'Humidifier',

data/lib/openstudio-standards/version.rb

@@ -13,5 +13,5 @@ module OpenstudioStandards
     end
     return 'git-not-found-on-this-system'
   end
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0.rc1'.freeze
 end

data/lib/openstudio-standards/weather/Weather.Model.rb

@@ -127,7 +127,7 @@ class Standard
   # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param climate_zone [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
   # @param epw_file [String] the name of the epw file; if blank will default to epw file for the ASHRAE climate zone
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def model_add_design_days_and_weather_file(model, climate_zone, epw_file = '', weather_dir = nil)
     success = true
     require_relative 'Weather.stat_file'
@@ -217,7 +217,7 @@ class Standard
   # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param [String] openstudio-standards building type
   # @param [String] ASHRAE climate zone, e.g. 'ASHRAE 169-2013-4A'
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def model_add_ground_temperatures(model, building_type, climate_zone)
     # Define the weather file for each climate zone
     climate_zone_weather_file_map = model_get_climate_zone_weather_file_map
@@ -636,7 +636,7 @@ module BTAP
 
       # This method will set the weather file and returns a log string.
       # @author phylroy.lopez@nrcan.gc.ca
-      # @param model [OpenStudio::model::Model] A model object
+      # @param model [OpenStudio::Model::Model] A model object
       # @return [String] log
       def set_weather_file(model, runner = nil)
         BTAP.runner_register('Info', 'BTAP::Environment::WeatherFile::set_weather', runner)
@@ -915,7 +915,7 @@ module BTAP
           end
         end
         return heating_design_day_number, cooling_design_day_number
-      end # def get_heating_design_day_number
+      end
 
       # This method calculates dehumidification degree days (DDD)
       # @author sara.gilani@canada.ca
@@ -991,11 +991,10 @@ module BTAP
 
             ddd += line[CALCULATED_HUMIDITY_RATIO_AVG_DAILY_DIFF_BASE].to_f
 
-          end # unless line.first =~ /\D(.*)/
-        end # @filearray.each do |line|
-        # puts @filearray
+          end
+        end
         return ddd
-      end # def calculate_humidity_ratio
-    end # Environment
+      end
+    end
   end
 end

data/lib/openstudio-standards/weather/Weather.stat_file.rb

@@ -317,7 +317,7 @@ module EnergyPlus
         # use regex to get the temperatures
         regex = /Daily Avg(.*)\n/
         match_data = text.match(regex)
-       if match_data.nil?
+        if match_data.nil?
           puts "Can't find outdoor air temps"
           raise
         else
@@ -332,8 +332,8 @@ module EnergyPlus
 
           # insert as numbers
           monthly_temps.each { |temp| @monthly_dry_bulb << temp.to_f }
-          # puts "#{@monthly_dry_bulb}"
-        end
+           # puts "#{@monthly_dry_bulb}"
+         end
 
         # use regex to get undisturbed ground temps at 0.5 m depth
         regex = /Monthly.*Calculated.*undisturbed*.*Ground.*Temperatures.*\n.*Jan.*Feb.*Mar.*Apr.*May.*Jun.*Jul.*Aug.*Sep.*Oct.*Nov.*Dec.*\n(.*)\n(.*)\n(.*)/

data/lib/openstudio-standards/weather/information.rb

@@ -0,0 +1,35 @@
+# Methods to create Schedule objects
+module OpenstudioStandards
+  module Weather
+    # @!group Information
+
+    # get the ASHRAE climate zone number
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @return [Integer] ASHRAE climate zone number, 0-8
+    def self.model_get_ashrae_climate_zone_number(model)
+      # get ashrae climate zone from model
+      ashrae_climate_zone = ''
+      model.getClimateZones.climateZones.each do |climate_zone|
+        if climate_zone.institution == 'ASHRAE'
+          ashrae_climate_zone = climate_zone.value
+        end
+      end
+
+      if ashrae_climate_zone == ''
+        OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Weather', 'Please assign an ASHRAE Climate Zone to your model.')
+        return false
+      else
+        cz_number = ashrae_climate_zone.split(//).first.to_i
+      end
+
+      # expected climate zone number should be 0 through 8
+      if ![0, 1, 2, 3, 4, 5, 6, 7, 8].include? cz_number
+        OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Weather', 'ASHRAE climate zone number is not within expected range of 1 to 8.')
+        return false
+      end
+
+      return cz_number
+    end
+  end
+end