urbanopt-cli 0.5.1 → 0.6.2

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/lighting.rb

@@ -8,7 +8,6 @@ class Lighting
     end
 
     if fractions[[HPXML::LocationInterior, HPXML::LightingTypeCFL]].nil? # Not the lighting group(s) we're interested in
-      runner.registerWarning('No lighting specified, the model will not include lighting energy use.')
       return
     end
 
@@ -120,6 +119,7 @@ class Lighting
       ltg_def = OpenStudio::Model::ExteriorLightsDefinition.new(model)
       ltg = OpenStudio::Model::ExteriorLights.new(ltg_def)
       ltg.setName(Constants.ObjectNameExteriorLighting)
+      ltg.setEndUseSubcategory(Constants.ObjectNameExteriorLighting)
       ltg_def.setName(Constants.ObjectNameExteriorLighting)
       ltg_def.setDesignLevel(design_level)
       ltg.setSchedule(exterior_sch)
@@ -139,6 +139,7 @@ class Lighting
       ltg_def = OpenStudio::Model::ExteriorLightsDefinition.new(model)
       ltg = OpenStudio::Model::ExteriorLights.new(ltg_def)
       ltg.setName(Constants.ObjectNameLightingExteriorHoliday)
+      ltg.setEndUseSubcategory(Constants.ObjectNameLightingExteriorHoliday)
       ltg_def.setName(Constants.ObjectNameLightingExteriorHoliday)
       ltg_def.setDesignLevel(design_level)
       ltg.setSchedule(exterior_holiday_sch)

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/location.rb

@@ -78,21 +78,34 @@ class Location
     dgts.setAllMonthlyTemperatures([UnitConversions.convert(weather.data.AnnualAvgDrybulb, 'F', 'C')] * 12)
   end
 
-  def self.get_climate_zone_ba(wmo)
-    ba_zone = nil
+  def self.get_climate_zones
     zones_csv = File.join(File.dirname(__FILE__), 'data_climate_zones.csv')
     if not File.exist?(zones_csv)
       fail 'Could not find data_climate_zones.csv'
     end
 
+    return zones_csv
+  end
+
+  def self.get_climate_zone_iecc(wmo)
+    zones_csv = get_climate_zones
+
+    require 'csv'
+    CSV.foreach(zones_csv) do |row|
+      return row[6].to_s if row[0].to_s == wmo.to_s
+    end
+
+    return
+  end
+
+  def self.get_climate_zone_ba(wmo)
+    zones_csv = get_climate_zones
+
     require 'csv'
     CSV.foreach(zones_csv) do |row|
-      if row[0].to_s == wmo.to_s
-        ba_zone = row[5].to_s
-        break
-      end
+      return row[5].to_s if row[0].to_s == wmo.to_s
     end
 
-    return ba_zone
+    return
   end
 end

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/meta_measure.rb

@@ -2,8 +2,9 @@
 
 require 'fileutils'
 
-def run_hpxml_workflow(rundir, hpxml, measures, measures_dir, debug: false, output_vars: [],
-                       output_meters: [], run_measures_only: false, print_prefix: '')
+def run_hpxml_workflow(rundir, measures, measures_dir, debug: false, output_vars: [],
+                       output_meters: [], run_measures_only: false, print_prefix: '',
+                       ep_input_format: 'idf')
   rm_path(rundir)
   FileUtils.mkdir_p(rundir)
 
@@ -47,23 +48,38 @@ def run_hpxml_workflow(rundir, hpxml, measures, measures_dir, debug: false, outp
     om.setReportingFrequency(output_meter[1])
   end
 
-  # Translate model to IDF
+  # Translate model to workspace
   forward_translator = OpenStudio::EnergyPlus::ForwardTranslator.new
   forward_translator.setExcludeLCCObjects(true)
-  model_idf = forward_translator.translateModel(model)
-  report_ft_errors_warnings(forward_translator, rundir)
+  workspace = forward_translator.translateModel(model)
+  success = report_ft_errors_warnings(forward_translator, rundir)
 
-  # Apply reporting measure output requests
-  apply_energyplus_output_requests(measures_dir, measures, runner, model, model_idf)
+  if not success
+    print "#{print_prefix}Creating input unsuccessful.\n"
+    print "#{print_prefix}See #{File.join(rundir, 'run.log')} for details.\n"
+    return { success: false, runner: runner }
+  end
 
-  # Write IDF to file
-  File.open(File.join(rundir, 'in.idf'), 'w') { |f| f << model_idf.to_s }
+  # Apply reporting measure output requests
+  apply_energyplus_output_requests(measures_dir, measures, runner, model, workspace)
+
+  # Write to file
+  if ep_input_format == 'idf'
+    ep_input_filename = 'in.idf'
+    File.open(File.join(rundir, ep_input_filename), 'w') { |f| f << workspace.to_s }
+  elsif ep_input_format == 'epjson'
+    ep_input_filename = 'in.epJSON'
+    json = OpenStudio::EPJSON::toJSONString(workspace.toIdfFile)
+    File.open(File.join(rundir, ep_input_filename), 'w') { |f| f << json.to_s }
+  else
+    fail "Unexpected ep_input_format: #{ep_input_format}."
+  end
 
   # Run simulation
   print "#{print_prefix}Running simulation...\n"
   ep_path = File.absolute_path(File.join(OpenStudio.getOpenStudioCLI.to_s, '..', '..', 'EnergyPlus', 'energyplus')) # getEnergyPlusDirectory can be unreliable, using getOpenStudioCLI instead
   simulation_start = Time.now
-  command = "\"#{ep_path}\" -w \"#{model.getWeatherFile.path.get}\" in.idf"
+  command = "\"#{ep_path}\" -w \"#{model.getWeatherFile.path.get}\" #{ep_input_filename}"
   if debug
     File.open(File.join(rundir, 'run.log'), 'a') do |f|
       f << "Executing command '#{command}' from working directory '#{rundir}'.\n"
@@ -153,7 +169,7 @@ def apply_measures(measures_dir, measures, runner, model, show_measure_calls = t
   return true
 end
 
-def apply_energyplus_output_requests(measures_dir, measures, runner, model, model_idf)
+def apply_energyplus_output_requests(measures_dir, measures, runner, model, workspace)
   # Call each measure in the specified order
   measures.keys.each do |measure_subdir|
     # Gather measure arguments and call measure
@@ -167,7 +183,7 @@ def apply_energyplus_output_requests(measures_dir, measures, runner, model, mode
       runner.setLastOpenStudioModel(model)
       idf_objects = measure.energyPlusOutputRequests(runner, argument_map)
       idf_objects.each do |idf_object|
-        model_idf.addObject(idf_object)
+        workspace.addObject(idf_object)
       end
     end
   end
@@ -274,6 +290,19 @@ def get_argument_map(model, measure, provided_args, lookup_file, measure_name, r
   return argument_map
 end
 
+def get_value_from_workflow_step_value(step_value)
+  variant_type = step_value.variantType
+  if variant_type == 'Boolean'.to_VariantType
+    return step_value.valueAsBoolean
+  elsif variant_type == 'Double'.to_VariantType
+    return step_value.valueAsDouble
+  elsif variant_type == 'Integer'.to_VariantType
+    return step_value.valueAsInteger
+  elsif variant_type == 'String'.to_VariantType
+    return step_value.valueAsString
+  end
+end
+
 def run_measure(model, measure, argument_map, runner)
   begin
     # run the measure
@@ -298,6 +327,11 @@ def run_measure(model, measure, argument_map, runner)
       runner.registerFinalCondition(result_child.finalCondition.get.logMessage)
     end
 
+    # re-register runner child registered values on the parent runner
+    result_child.stepValues.each do |step_value|
+      runner.registerValue(step_value.name, get_value_from_workflow_step_value(step_value))
+    end
+
     # log messages
     result_child.warnings.each do |warning|
       runner.registerWarning(warning.logMessage)
@@ -338,7 +372,7 @@ end
 def register_error(msg, runner = nil)
   if not runner.nil?
     runner.registerError(msg)
-    fail msg # OS 2.0 will handle this more gracefully
+    fail msg
   else
     raise "ERROR: #{msg}"
   end
@@ -388,14 +422,17 @@ end
 
 def report_ft_errors_warnings(forward_translator, rundir)
   # Report warnings/errors
+  success = true
   File.open(File.join(rundir, 'run.log'), 'a') do |f|
     forward_translator.warnings.each do |s|
       f << "FT Warning: #{s.logMessage}\n"
     end
     forward_translator.errors.each do |s|
       f << "FT Error: #{s.logMessage}\n"
+      success = false
     end
   end
+  return success
 end
 
 def report_os_warnings(os_log, rundir)
@@ -406,6 +443,7 @@ def report_os_warnings(os_log, rundir)
       next if s.logMessage.include? 'WorkflowStepResult value called with undefined stepResult'
       next if s.logMessage.include?("Object of type 'Schedule:Constant' and named 'Always") && s.logMessage.include?('points to an object named') && s.logMessage.include?('but that object cannot be located')
       next if s.logMessage.include? 'Appears there are no design condition fields in the EPW file'
+      next if s.logMessage.include?('Using EnergyPlusVersion version') && s.logMessage.include?("which should have 'Year' field, but it's always zero")
 
       f << "OS Message: #{s.logMessage}\n"
     end
@@ -440,3 +478,37 @@ class String
     return true
   end
 end
+
+def get_argument_values(runner, arguments, user_arguments)
+  args = {}
+  arguments.each do |argument|
+    if argument.required
+      case argument.type
+      when 'Choice'.to_OSArgumentType
+        args[argument.name] = runner.getStringArgumentValue(argument.name, user_arguments)
+      when 'Boolean'.to_OSArgumentType
+        args[argument.name] = runner.getBoolArgumentValue(argument.name, user_arguments)
+      when 'Double'.to_OSArgumentType
+        args[argument.name] = runner.getDoubleArgumentValue(argument.name, user_arguments)
+      when 'Integer'.to_OSArgumentType
+        args[argument.name] = runner.getIntegerArgumentValue(argument.name, user_arguments)
+      when 'String'.to_OSArgumentType
+        args[argument.name] = runner.getStringArgumentValue(argument.name, user_arguments)
+      end
+    else
+      case argument.type
+      when 'Choice'.to_OSArgumentType
+        args[argument.name] = runner.getOptionalStringArgumentValue(argument.name, user_arguments)
+      when 'Boolean'.to_OSArgumentType
+        args[argument.name] = runner.getOptionalStringArgumentValue(argument.name, user_arguments)
+      when 'Double'.to_OSArgumentType
+        args[argument.name] = runner.getOptionalDoubleArgumentValue(argument.name, user_arguments)
+      when 'Integer'.to_OSArgumentType
+        args[argument.name] = runner.getOptionalIntegerArgumentValue(argument.name, user_arguments)
+      when 'String'.to_OSArgumentType
+        args[argument.name] = runner.getOptionalStringArgumentValue(argument.name, user_arguments)
+      end
+    end
+  end
+  return args
+end

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/minitest_helper.rb

@@ -1,30 +1,8 @@
 # frozen_string_literal: true
 
-called_from_cli = true
-begin
-  OpenStudio.getOpenStudioCLI
-rescue
-  called_from_cli = false
-end
+require 'minitest/autorun'
 
-if not called_from_cli # cli can't load codecov gem
-  require 'simplecov'
-  require 'codecov'
+require 'minitest/reporters'
+require 'minitest/reporters/spec_reporter' # Needed when run via OS CLI
 
-  # save to CircleCI's artifacts directory if we're on CircleCI
-  if ENV['CI']
-    if ENV['CIRCLE_ARTIFACTS']
-      dir = File.join(ENV['CIRCLE_ARTIFACTS'], 'coverage')
-      SimpleCov.coverage_dir(dir)
-    end
-    SimpleCov.formatter = SimpleCov::Formatter::Codecov
-  else
-    SimpleCov.coverage_dir('coverage')
-  end
-  SimpleCov.start
-
-  require 'minitest/autorun'
-  require 'minitest/reporters'
-
-  Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new # spec-like progress
-end
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new # spec-like progress

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/misc_loads.rb

@@ -30,17 +30,6 @@ class MiscLoads
     sens_frac = plug_load.frac_sensible
     lat_frac = plug_load.frac_latent
 
-    # check for valid inputs
-    if (sens_frac < 0) || (sens_frac > 1)
-      fail 'Sensible fraction must be greater than or equal to 0 and less than or equal to 1.'
-    end
-    if (lat_frac < 0) || (lat_frac > 1)
-      fail 'Latent fraction must be greater than or equal to 0 and less than or equal to 1.'
-    end
-    if lat_frac + sens_frac > 1
-      fail 'Sum of sensible and latent fractions must be less than or equal to 1.'
-    end
-
     if apply_ashrae140_assumptions
       # ASHRAE 140, Table 7-9. Sensible loads are 70% radiative and 30% convective.
       rad_frac = 0.7 * sens_frac
@@ -89,17 +78,6 @@ class MiscLoads
     sens_frac = fuel_load.frac_sensible
     lat_frac = fuel_load.frac_latent
 
-    # check for valid inputs
-    if (sens_frac < 0) || (sens_frac > 1)
-      fail 'Sensible fraction must be greater than or equal to 0 and less than or equal to 1.'
-    end
-    if (lat_frac < 0) || (lat_frac > 1)
-      fail 'Latent fraction must be greater than or equal to 0 and less than or equal to 1.'
-    end
-    if lat_frac + sens_frac > 1
-      fail 'Sum of sensible and latent fractions must be less than or equal to 1.'
-    end
-
     # Add other equipment for the mfl
     mfl_def = OpenStudio::Model::OtherEquipmentDefinition.new(model)
     mfl = OpenStudio::Model::OtherEquipment.new(mfl_def)
@@ -116,6 +94,8 @@ class MiscLoads
   end
 
   def self.apply_pool_or_hot_tub_heater(model, pool_or_hot_tub, obj_name, living_space, schedules_file)
+    return if pool_or_hot_tub.heater_type == HPXML::TypeNone
+
     heater_kwh = 0
     heater_therm = 0
 
@@ -165,17 +145,18 @@ class MiscLoads
         heater_sch = heater_sch.schedule
       end
 
-      mel_def = OpenStudio::Model::GasEquipmentDefinition.new(model)
-      mel = OpenStudio::Model::GasEquipment.new(mel_def)
-      mel.setName(obj_name)
-      mel.setEndUseSubcategory(obj_name)
-      mel.setSpace(living_space)
-      mel_def.setName(obj_name)
-      mel_def.setDesignLevel(space_design_level)
-      mel_def.setFractionRadiant(0)
-      mel_def.setFractionLatent(0)
-      mel_def.setFractionLost(1)
-      mel.setSchedule(heater_sch)
+      mfl_def = OpenStudio::Model::OtherEquipmentDefinition.new(model)
+      mfl = OpenStudio::Model::OtherEquipment.new(mfl_def)
+      mfl.setName(obj_name)
+      mfl.setEndUseSubcategory(obj_name)
+      mfl.setFuelType(EPlus.fuel_type(HPXML::FuelTypeNaturalGas))
+      mfl.setSpace(living_space)
+      mfl_def.setName(obj_name)
+      mfl_def.setDesignLevel(space_design_level)
+      mfl_def.setFractionRadiant(0)
+      mfl_def.setFractionLatent(0)
+      mfl_def.setFractionLost(1)
+      mfl.setSchedule(heater_sch)
     end
   end
 

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/pv.rb

@@ -8,9 +8,8 @@ class PV
       max_power = pv_system.max_power_output
     else
       # Apportion to single dwelling unit by # bedrooms
-      if pv_system.number_of_bedrooms_served.to_f <= nbeds.to_f
-        fail "Shared PV system number of bedrooms served (#{pv_system.number_of_bedrooms_served}) must be greater than the number of bedrooms in the dwelling unit (#{nbeds})."
-      end
+      fail if pv_system.number_of_bedrooms_served.to_f <= nbeds.to_f # EPvalidator.xml should prevent this
+
       max_power = pv_system.max_power_output * nbeds.to_f / pv_system.number_of_bedrooms_served.to_f
     end
 
@@ -42,7 +41,7 @@ class PV
     ipvwatts.setName("#{obj_name} inverter")
     ipvwatts.setInverterEfficiency(pv_system.inverter_efficiency)
 
-    elcd = gpvwatts.electricLoadCenterDistribution.get
+    elcd = OpenStudio::Model::ElectricLoadCenterDistribution.new(model)
     elcd.setName("#{obj_name} elec load center dist")
     elcd.addGenerator(gpvwatts)
     elcd.setInverter(ipvwatts)

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/schedules.rb

@@ -1086,7 +1086,7 @@ class SchedulesFile
     schedule_file.setColumnNumber(col_index + 1)
     schedule_file.setRowstoSkipatTop(rows_to_skip)
     schedule_file.setNumberofHoursofData(num_hrs_in_year.to_i)
-    schedule_file.setMinutesperItem("#{min_per_item.to_i}")
+    schedule_file.setMinutesperItem(min_per_item.to_i)
 
     return schedule_file
   end
@@ -1203,17 +1203,48 @@ class SchedulesFile
     return external_file
   end
 
-  def set_vacancy(col_names:)
+  def set_vacancy
     return unless @schedules.keys.include? 'vacancy'
     return if @schedules['vacancy'].all? { |i| i == 0 }
 
-    @schedules[col_names[0]].each_with_index do |ts, i|
-      col_names.each do |col_name|
+    col_names = ScheduleGenerator.col_names
+
+    @schedules[col_names.keys[0]].each_with_index do |ts, i|
+      col_names.keys.each do |col_name|
+        next unless col_names[col_name] # skip those unaffected by vacancy
+
         @schedules[col_name][i] *= (1.0 - @schedules['vacancy'][i])
       end
     end
 
-    update(col_names: col_names)
+    update(col_names: col_names.keys)
+  end
+
+  def set_outage(outage_start_date:,
+                 outage_end_date:)
+
+    minutes_per_step = 60
+    if @model.getSimulationControl.timestep.is_initialized
+      minutes_per_step = 60 / @model.getSimulationControl.timestep.get.numberOfTimestepsPerHour
+    end
+
+    col_names = ScheduleGenerator.col_names
+
+    sec_per_step = minutes_per_step * 60.0
+    col_names.each do |col_name, val|
+      next if col_name == 'occupants'
+      next if val.nil?
+
+      ts = Time.new(outage_start_date.year, 'Jan', 1)
+      @schedules[col_name].each_with_index do |step, i|
+        if outage_start_date <= ts && ts < outage_end_date # in the outage period
+          @schedules[col_name][i] = 0.0
+        end
+        ts += sec_per_step
+      end
+    end
+
+    update(col_names: col_names.keys)
   end
 
   def import(col_names:)
@@ -1248,9 +1279,14 @@ class SchedulesFile
     return false if @schedules_path.nil?
 
     # need to update schedules csv in generated_files folder (alongside run folder) since this is what the simulation points to
-    schedules_path = File.expand_path(File.join(File.dirname(@schedules_path), '../generated_files', File.basename(@schedules_path)))
+    begin
+      schedules_path = File.expand_path(File.join(File.dirname(@schedules_path), '../generated_files', File.basename(@schedules_path))) # called from cli
+      columns = CSV.read(schedules_path).transpose
+    rescue
+      schedules_path = File.expand_path(File.join(File.dirname(@schedules_path), '../../../files', File.basename(@schedules_path))) # testing
+      columns = CSV.read(schedules_path).transpose
+    end
 
-    columns = CSV.read(schedules_path).transpose
     col_names.each do |col_name|
       col_num = get_col_index(col_name: col_name)
       columns.each_with_index do |col, i|