openstudio-standards 0.2.12.rc4 → 0.2.13.rc3

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

@@ -4,24 +4,21 @@ require_relative '../../openstudio-standards/btap/fileio'
 
 puts "\nenter osm file name (without file extension):\n"
 # osm_infile_name = gets.chomp
-osm_infile_name = "NECB2011Hospital"
+osm_infile_name = 'NECB2011Hospital'
 osm_outfile_name = osm_infile_name.to_s + '_updated.osm'
 
 model = BTAP::FileIO.safe_load_model("#{osm_infile_name}.osm")
 
-spaces =  model.getSpaces()
-
-spaces.each {|space|
-	surfaces = space.surfaces()
-	surfaces.each_with_index{ |surface, index|
-		name = "#{space.nameString}-#{index}-#{surface.surfaceType()}"
-		puts name
-		surface.setName(name)
-	}
-	
-}
+spaces = model.getSpaces
 
+spaces.each do |space|
+  surfaces = space.surfaces()
+  surfaces.each_with_index do |surface, index|
+    name = "#{space.nameString}-#{index}-#{surface.surfaceType}"
+    puts name
+    surface.setName(name)
+  end
+end
 
 osm_path = OpenStudio::Path.new(osm_outfile_name.to_s)
 model.save(osm_path, true)
-

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

@@ -8,27 +8,25 @@ osm_outfile_name = osm_infile_name.to_s + '_updated.osm'
 
 model = BTAP::FileIO.safe_load_model("#{osm_infile_name}.osm")
 
-surfaces =  model.getSurfaces()
-
-surfaces.each {|surface|
-	# rem_surf = ['Surface 14', 'Surface 16', 'Surface 75', 'Surface 46']
-	#if rem_surf.include?(surface.name.to_s)
-	#	surface.remove()
-	#	next
-	#end
-	vertex_hash = []
-	surface.vertices.each_with_index{ |vertex,index|
-		old = vertex
-		vertex_hash << OpenStudio::Point3d.new( sprintf('%.4f', old.x).to_f , sprintf('%.4f', old.y).to_f , sprintf('%.4f', old.z).to_f )
-		# sprintf('%.4f', old.x.round(4))
-		# puts new_vertex
-	}
-	#puts vertex_hash.join()
-	surface.setVertices(vertex_hash)
-	#puts "\n\n\n\n"
-}
+surfaces = model.getSurfaces
 
+surfaces.each do |surface|
+  # rem_surf = ['Surface 14', 'Surface 16', 'Surface 75', 'Surface 46']
+  # if rem_surf.include?(surface.name.to_s)
+  #  surface.remove()
+  #  next
+  # end
+  vertex_hash = []
+  surface.vertices.each_with_index do |vertex, index|
+    old = vertex
+    vertex_hash << OpenStudio::Point3d.new(format('%.4f', old.x).to_f, format('%.4f', old.y).to_f, format('%.4f', old.z).to_f)
+    # sprintf('%.4f', old.x.round(4))
+    # puts new_vertex
+  end
+  # puts vertex_hash.join()
+  surface.setVertices(vertex_hash)
+  # puts "\n\n\n\n"
+end
 
 osm_path = OpenStudio::Path.new(osm_outfile_name.to_s)
 model.save(osm_path, true)
-

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

@@ -5,29 +5,28 @@ require 'rubyXL'
 require 'json'
 
 class Sched_create
-
   # Set a bunch of variables which generally remain static and are added to the new schedulesNECB2015.json file because
   # that was how they were in the NECB2011 schedules.json file.
 
-  template = "NECB2015"
-  name = "NECB-"
-  name_pre_mod = [ '', '', '-Electric', '', '', '', '' ]
-  name_post_mod = [ '', '', '', '', '-Cooling', '-Heating', '' ]
-  category = [ 'Occupancy', 'Lighting', 'Equipment', 'Fan', 'Thermostat Setpoint', 'Thermostat Setpoint', 'Service Water Heating' ]
-  units = [ 'FRACTION', 'FRACTION', 'FRACTION', 'ON_OFF', 'TEMPERATURE', 'TEMPERATURE', 'FRACTION' ]
-  day_types = [ 'Default|Wkdy', 'Sat', 'Sun|Hol' ]
-  start_date = "2014-01-01T00:00:00+00:00"
-  end_date = "2014-12-31T00:00:00+00:00"
-  type = "Hourly"
+  template = 'NECB2015'
+  name = 'NECB-'
+  name_pre_mod = ['', '', '-Electric', '', '', '', '']
+  name_post_mod = ['', '', '', '', '-Cooling', '-Heating', '']
+  category = ['Occupancy', 'Lighting', 'Equipment', 'Fan', 'Thermostat Setpoint', 'Thermostat Setpoint', 'Service Water Heating']
+  units = ['FRACTION', 'FRACTION', 'FRACTION', 'ON_OFF', 'TEMPERATURE', 'TEMPERATURE', 'FRACTION']
+  day_types = ['Default|Wkdy', 'Sat', 'Sun|Hol']
+  start_date = '2014-01-01T00:00:00+00:00'
+  end_date = '2014-12-31T00:00:00+00:00'
+  type = 'Hourly'
   notes = nil
   table_array = []
   entry_array = []
   json_array = []
-  refs = [ "assumption" ]
+  refs = ['assumption']
 
   # Open Excel file containing schdeules and look for the schedlues worksheet.
 
-  workbook = RubyXL::Parser.parse("./NECB2015_tables-171121.xlsx")
+  workbook = RubyXL::Parser.parse('./NECB2015_tables-171121.xlsx')
   worksheet = workbook['A-8.4.3.2.(1)']
 
   # Determine how many rows are used in the schedules worksheet.  Had to do this because there were some nil lines
@@ -40,18 +39,17 @@ class Sched_create
   # the worksheet.  The -32 is there to make sure that there is actually another schedule (or enough room for one) in
   # the worksheet thus preventing errors due to manipulating nulls.
 
-  while table_index < (sheetlength -32)
+  while table_index < (sheetlength - 32)
     curr_loc = 5
     cat_index = 0
 
     # Loop through each category defined above (order of categories should match how they are presented in the worksheet).
 
     category.each_with_index do |cat, cat_index|
-
       # Build the schedule name using the category and some prefixes and suffixes because the nomenclature was not
       # consistent.  Mostly trying to match what is in the NECB2011 schedules.json file.
 
-      table_name = name + worksheet[table_index+1][0].value.to_s[-1] + name_pre_mod[cat_index] + "-" + cat + name_post_mod[cat_index]
+      table_name = name + worksheet[table_index + 1][0].value.to_s[-1] + name_pre_mod[cat_index] + '-' + cat + name_post_mod[cat_index]
 
       # Loop through each day type: Weekdays/default, Saturdays, and Sundays/holidays.
 
@@ -63,24 +61,24 @@ class Sched_create
         # Also need to handle when cooling is "off" in the workbook but which BTAP represents as setting the setpoint
         # really high.  The normal case (just a fraction) is at the end
 
-        if cat == "Fan"
-          worksheet[table_index+curr_loc].cells.drop(1).each do |fan_val|
-            if fan_val.value == "On"
+        if cat == 'Fan'
+          worksheet[table_index + curr_loc].cells.drop(1).each do |fan_val|
+            if fan_val.value == 'On'
               line_values << 1.0
             else
               line_values << 0.0
             end
           end
-        elsif name_post_mod[cat_index] == "-Cooling"
-          worksheet[table_index+curr_loc].cells.drop(1).each do |cool_val|
-            if cool_val.value == "Off"
+        elsif name_post_mod[cat_index] == '-Cooling'
+          worksheet[table_index + curr_loc].cells.drop(1).each do |cool_val|
+            if cool_val.value == 'Off'
               line_values << 35
             else
               line_values << cool_val.value
             end
           end
         else
-          worksheet[table_index+curr_loc].cells.drop(1).each { |col_ref| line_values << col_ref.value }
+          worksheet[table_index + curr_loc].cells.drop(1).each { |col_ref| line_values << col_ref.value }
         end
 
         # The workbook lists the schedules started at 1:00 am and ending at 12:00 am (not sure why).  OpenStudio
@@ -95,16 +93,16 @@ class Sched_create
         # Put everything for this day in a hash (the order according to the original NECB2011 schedules.json file).
 
         entry_array = {
-            "template" => template,
-            "name" => table_name,
-            "category" => cat,
-            "units" => units[cat_index],
-            "day_types" => day_type,
-            "start_date" => start_date,
-            "end_date" => end_date,
-            "type" => type,
-            "notes" => notes,
-            "values" => values
+          'template' => template,
+          'name' => table_name,
+          'category' => cat,
+          'units' => units[cat_index],
+          'day_types' => day_type,
+          'start_date' => start_date,
+          'end_date' => end_date,
+          'type' => type,
+          'notes' => notes,
+          'values' => values
         }
 
         # Add this day's hash to all of the others (I was calling them arrays but they were hashes).
@@ -123,25 +121,25 @@ class Sched_create
 
     # End of the table set the location of the next table (which starts immediately after the preceding one)
 
-    table_index += curr_loc-1
+    table_index += curr_loc - 1
   end
 
   # Add a few hashes to the hash containing all of the schedules in the worksheet.  This is to match the formatting
   # found in the original NECB2011 schedules.json file.
 
   table_array = {
-      "tables" => [
-        "name" => "schedules",
-        "data_type" => "table",
-        "refs" => refs,
-        "table" => json_array
-      ]
+    'tables' => [
+      'name' => 'schedules',
+      'data_type' => 'table',
+      'refs' => refs,
+      'table' => json_array
+    ]
   }
 
   # Turn the big hash in memory into a .json format and save it to file.  The pretty part is so the json file is nicely
   # ordered and relatively easy to follow.
 
-  File.open("./schedulesNECB2015.json","w") do |each_file|
+  File.open('./schedulesNECB2015.json', 'w') do |each_file|
     each_file.write(JSON.pretty_generate(table_array))
   end
 end

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

@@ -9,42 +9,42 @@ model = model.get
 spaces = model.getSpaces
 converted = []
 # loop through space
-spaces.each{|space|
-	# check for multiplier
-	if space.multiplier > 1
+spaces.each do |space|
+  # check for multiplier
+  if space.multiplier > 1
     puts space.name
-		surfaces = space.surfaces
-		# get surfaces of a space
-		surfaces.each{|surface|
-			puts "\t#{surface.name}\n\t\t#{surface.outsideBoundaryCondition}"
-			# convert all surfaces except outdoors BC, and make it adabatic. if that 
-			# surface has an adjacent surface, then also convert it to adiabatic
-			if surface.outsideBoundaryCondition.to_s == "Surface"
-				if !surface.adjacentSurface.nil?
-					adj_surface = surface.adjacentSurface.get
-					adj_surface.setOutsideBoundaryCondition('Adiabatic')
-					converted << adj_surface.name
-				end
-				surface.setOutsideBoundaryCondition('Adiabatic')
-				converted << surface.name
-			# if the surface is already not adiabatic or outdoors, set the BC to adiabatic
-			elsif surface.outsideBoundaryCondition.to_s != "Outdoors" and  surface.outsideBoundaryCondition.to_s != "Adiabatic"
-				surface.setOutsideBoundaryCondition('Adiabatic')
-				converted << surface.name
-			end
-		}
-	end
-}
+    surfaces = space.surfaces
+    # get surfaces of a space
+    surfaces.each do |surface|
+      puts "\t#{surface.name}\n\t\t#{surface.outsideBoundaryCondition}"
+      # convert all surfaces except outdoors BC, and make it adabatic. if that
+      # surface has an adjacent surface, then also convert it to adiabatic
+      if surface.outsideBoundaryCondition.to_s == 'Surface'
+        if !surface.adjacentSurface.nil?
+          adj_surface = surface.adjacentSurface.get
+          adj_surface.setOutsideBoundaryCondition('Adiabatic')
+          converted << adj_surface.name
+        end
+        surface.setOutsideBoundaryCondition('Adiabatic')
+        converted << surface.name
+      # if the surface is already not adiabatic or outdoors, set the BC to adiabatic
+      elsif (surface.outsideBoundaryCondition.to_s != 'Outdoors') && (surface.outsideBoundaryCondition.to_s != 'Adiabatic')
+        surface.setOutsideBoundaryCondition('Adiabatic')
+        converted << surface.name
+      end
+    end
+  end
+end
 
 # ASSUMING THAT ALL ADIABATIC SURFACES ARE NOT SUPPOSED TO BE EXPOSED TO THE WIND AND SUN
 # set adiabatic surface's sun and wind exposure to none
-model.getSurfaces.each{|surface|
-  if surface.outsideBoundaryCondition.to_s == "Adiabatic"
-	surface.setWindExposure("NoWind")
-	surface.setSunExposure("NoSun")
-	converted << "#{surface.name} -- NoSun NoWind"
+model.getSurfaces.each  do |surface|
+  if surface.outsideBoundaryCondition.to_s == 'Adiabatic'
+    surface.setWindExposure('NoWind')
+    surface.setSunExposure('NoSun')
+    converted << "#{surface.name} -- NoSun NoWind"
   end
-}
+end
 
 puts "\n\n"
 puts converted

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

@@ -25,6 +25,7 @@ Standard.class_eval do
     if epw_path.empty?
       return false
     end
+
     epw_path = epw_path.get
 
     # close current sql file
@@ -84,7 +85,7 @@ Standard.class_eval do
       epw_name = 'in.epw'
       begin
         FileUtils.copy(epw_path.to_s, "#{run_dir}/#{epw_name}")
-      rescue
+      rescue StandardError
         OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "Due to limitations on Windows file path lengths, this measure won't work unless your project is located in a directory whose filepath is less than 90 characters long, including slashes.")
         return false
       end
@@ -95,7 +96,7 @@ Standard.class_eval do
 
       cli_path = OpenStudio.getOpenStudioCLI
       cmd = "\"#{cli_path}\" run -w \"#{osw_path}\""
-      #cmd = "\"#{cli_path}\" --verbose run -w \"#{osw_path}\""
+      # cmd = "\"#{cli_path}\" --verbose run -w \"#{osw_path}\""
       puts cmd
 
       # Run the sizing run
@@ -139,7 +140,7 @@ Standard.class_eval do
       end
     end
 
-    # Report severe errors in the run
+    # Report severe or fatal errors in the run
     error_query = "SELECT ErrorMessage
         FROM Errors
         WHERE ErrorType in(1,2)"
@@ -148,26 +149,16 @@ Standard.class_eval do
       errs = errs.get
     end
 
-    # Check that the run completed
-    completed_query = 'SELECT Completed FROM Simulations'
-    completed = model.sqlFile.get.execAndReturnFirstDouble(completed_query)
-    if completed.is_initialized
-      completed = completed.get
-      if completed.zero?
-        OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "The run did not finish and had following errors: #{errs.join('\n')}")
-        return false
-      end
+    # Check that the run completed successfully
+    end_file_stringpath = "#{run_dir}/run/eplusout.end"
+    end_file_path = OpenStudio::Path.new(end_file_stringpath)
+    if OpenStudio.exists(end_file_path)
+      endstring = File.read(end_file_stringpath)
     end
 
-    # Check that the run completed with no severe errors
-    completed_successfully_query = 'SELECT CompletedSuccessfully FROM Simulations'
-    completed_successfully = model.sqlFile.get.execAndReturnFirstDouble(completed_successfully_query)
-    if completed_successfully.is_initialized
-      completed_successfully = completed_successfully.get
-      if completed_successfully.zero?
-        OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "The run failed with the following severe or fatal errors: #{errs.join('\n')}")
-        return false
-      end
+    if !endstring.include?('EnergyPlus Completed Successfully')
+      OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "The run did not finish and had following errors: #{errs.join('\n')}")
+      return false
     end
 
     # Log any severe errors that did not cause simulation to fail
@@ -192,6 +183,7 @@ Standard.class_eval do
 
     # check that all zones have surfaces.
     raise 'Error: Sizing Run Failed. Thermal Zones with no surfaces exist.' unless model_do_all_zones_have_surfaces?(model)
+
     # Run the sizing run
     success = model_run_simulation_and_log_errors(model, sizing_run_dir)
 

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

@@ -1,16 +1,15 @@
 require 'json'
 map = []
-File.open("../../../lib/openstudio-standards/standards/necb/NECB2015/data/space_type_upgrade_map.csv").each do |line|
-  necb2011_building_type, necb2011_space_type, necb2015_building_type, necb2015_space_type = line.split(",")
-  next if necb2011_building_type.nil? or necb2011_building_type.strip == ''
+File.open('../../../lib/openstudio-standards/standards/necb/NECB2015/data/space_type_upgrade_map.csv').each do |line|
+  necb2011_building_type, necb2011_space_type, necb2015_building_type, necb2015_space_type = line.split(',')
+  next if necb2011_building_type.nil? || (necb2011_building_type.strip == '')
 
-
-  map << {'NECB2011_building_type' => necb2011_building_type.strip,
-          'NECB2011_space_type' => necb2011_space_type.strip,
-          'NECB2015_building_type' => necb2015_building_type.strip,
-          'NECB2015_space_type' => necb2015_space_type.strip,
-          'NECB2017_building_type' => necb2015_building_type.strip,
-          'NECB2017_space_type' => necb2015_space_type.strip }
+  map << { 'NECB2011_building_type' => necb2011_building_type.strip,
+           'NECB2011_space_type' => necb2011_space_type.strip,
+           'NECB2015_building_type' => necb2015_building_type.strip,
+           'NECB2015_space_type' => necb2015_space_type.strip,
+           'NECB2017_building_type' => necb2015_building_type.strip,
+           'NECB2017_space_type' => necb2015_space_type.strip }
 end
 
-puts JSON.pretty_generate(map)
+puts JSON.pretty_generate(map)

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

@@ -1,5 +1,4 @@
 Standard.class_eval do
-
   # Gets the sql file for the model, erroring if not found
   # @todo candidate for C++
   def model_sql_file(model)
@@ -26,6 +25,7 @@ Standard.class_eval do
     sql.availableEnvPeriods.each do |env_pd|
       env_type = sql.environmentType(env_pd)
       next unless env_type.is_initialized
+
       if env_type.get == OpenStudio::EnvironmentType.new('WeatherRunPeriod')
         ann_env_pd = env_pd
       end
@@ -362,7 +362,6 @@ Standard.class_eval do
 
   # Gets the annual occupied unmet hours from the sql file
   def model_annual_occupied_unmet_hours(model)
-
     heating_setpoint_unmet = model_annual_occupied_unmet_heating_hours(model)
     cooling_setpoint_unmet = model_annual_occupied_unmet_cooling_hours(model)
 
@@ -487,7 +486,7 @@ Standard.class_eval do
     fuel_types = ['Electricity', 'Natural Gas', 'Additional Fuel', 'District Cooling', 'District Heating', 'Water']
 
     # List of all end uses
-    end_uses = ['Heating', 'Cooling', 'Interior Lighting', 'Exterior Lighting', 'Interior Equipment', 'Exterior Equipment', 'Fans', 'Pumps', 'Heat Rejection','Humidification', 'Heat Recovery', 'Water Systems', 'Refrigeration', 'Generators']
+    end_uses = ['Heating', 'Cooling', 'Interior Lighting', 'Exterior Lighting', 'Interior Equipment', 'Exterior Equipment', 'Fans', 'Pumps', 'Heat Rejection', 'Humidification', 'Heat Recovery', 'Water Systems', 'Refrigeration', 'Generators']
 
     # Get the value for each end use/ fuel type combination
     end_uses.each do |end_use|
@@ -498,17 +497,17 @@ Standard.class_eval do
 
     return energy_values
   end
-  
+
   def model_dd_results_by_end_use_and_fuel_type(model)
     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']
+                  'DistrictHeating', 'ElectricityPurchased', 'ElectricitySurplusSold', 'ElectricityNet']
 
     # 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', 
-    'HeatRecovery', 'DHW', 'Cogeneration', 'Refrigeration', 'WaterSystems']
+    end_uses = ['InteriorLights', 'ExteriorLights', 'InteriorEquipment', 'ExteriorEquipment', 'Fans', 'Pumps', 'Heating', 'Cooling', 'HeatRejection', 'Humidifier',
+                'HeatRecovery', 'DHW', 'Cogeneration', 'Refrigeration', 'WaterSystems']
 
     # Get the value for each end use/ fuel type combination
     end_uses.each do |end_use|
@@ -522,7 +521,6 @@ Standard.class_eval do
 
   # Gets annual eui by fuel and end use from the sql file
   def model_annual_eui_kbtu_per_ft2_by_fuel_and_enduse(model, fuel_type, end_use)
-
     energy_gj = model_annual_energy_by_fuel_and_enduse(model, fuel_type, end_use)
     energy_kbtu = OpenStudio.convert(energy_gj, 'GJ', 'kBtu').get