urbanopt-cli 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09f500e2347c85052bd7493fcf4fcf2aeb519bec6912f46e28d9602700a8aaaf'
-  data.tar.gz: 024ccfe7a5e88bdb54ffd01a16d216e2c9cded1b3cff52b29d3476753fee8656
+  metadata.gz: 3efcf79adfbe7f95d6924f8beec36886999f7d5b695ab58e76d7cc4fea24d57e
+  data.tar.gz: 5bffff58a1805adcc3da24c2e9714daaa827e8929548c32a0397e7ef178e2a24
 SHA512:
-  metadata.gz: f6d8b46860126b1f74d970822458581efcb45fcc4ee868446b6fd0df8adea79c43c749eb70d1f05ca24991e72171979b9b17b6cf9accfefcd4e0e2f8f0bf556b
-  data.tar.gz: 2e3981a13ece23e674d60ff43172b6828141c8bf4e4f165d19f069a18666647cc62fdd862afaacb502195ad131fad90d4eef17bb5445d7ac65b9a6d1c084694d
+  metadata.gz: 285801c4e6d887e7c563dfb6f734900717d9a9d550a8f9ff7c04962cdceaaffc2f04b9889398ba750d2a6d3b082bb556e9ac94cf77851bfed9e5579fc491a972
+  data.tar.gz: 9c5311eda246ffdf565ecf87f16107b50fd9f54a5a02997e123d251553737dd25410016506bb5f3cb0b1295bd9dae4767167a6a9f0fd51d7f829f8d823dffd67

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## Version 0.6.0
+
+Date Range 3/31/21 - 4/30/21
+
+- Fixed [#179]( https://github.com/urbanopt/urbanopt-cli/issues/179 ), Visualization : Annual End Use graphs, updating end-use tags
+- Fixed [#185]( https://github.com/urbanopt/urbanopt-cli/issues/185 ), Add additional fuels used by the residential workflow to the first chart (when they exist)
+- Updated dependencies for OpenStudio 3.2.0 / Ruby 2.7
+
 ## Version 0.5.2
 
 Date Range 3/9/21 - 3/31/21

data/Gemfile

@@ -36,19 +36,19 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # if allow_local && File.exist?('../urbanopt-scenario-gem')
 #  gem 'urbanopt-scenario', path: '../urbanopt-scenario-gem'
 # elsif allow_local
-  #  gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
+# gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
 # end
 
 # if allow_local && File.exist?('../urbanopt-geojson-gem')
 #   gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
 # elsif allow_local
-#   gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
+# gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
 # end
 
 # if allow_local && File.exist?('../urbanopt-reopt-gem')
 #   gem 'urbanopt-reopt', path: '../urbanopt-reopt-gem'
 # elsif allow_local
-#   gem 'urbanopt-reopt', github: 'URBANopt/urbanopt-reopt-gem', branch: 'develop'
+# gem 'urbanopt-reopt', github: 'URBANopt/urbanopt-reopt-gem', branch: 'develop'
 # end
 
 # if allow_local && File.exist?('../openstudio-load-flexibility-measures')
@@ -60,5 +60,5 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # if allow_local && File.exist?('../urbanopt-reporting-gem')
   # gem 'urbanopt-reporting', path: '../urbanopt-reporting-gem'
 # elsif allow_local
-  # gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
+# gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
 # end

data/example_files/Gemfile

@@ -1,6 +1,6 @@
 source 'http://rubygems.org'
 
-ruby '~> 2.5.0'
+ruby '~> 2.7.0'
 
 # Local gems are useful when developing and integrating the various dependencies.
 # To favor the use of local gems, set the following environment variable:
@@ -31,7 +31,7 @@ if allow_local && File.exist?('../openstudio-common-measures-gem')
 elsif allow_local
   gem 'openstudio-common-measures', github: 'NREL/openstudio-common-measures-gem', branch: 'develop'
 else
-  gem 'openstudio-common-measures', '~> 0.3.2'
+  gem 'openstudio-common-measures', '~> 0.4.0'
 end
 
 if allow_local && File.exist?('../openstudio-model-articulation-gem')
@@ -39,7 +39,7 @@ if allow_local && File.exist?('../openstudio-model-articulation-gem')
 elsif allow_local
   gem 'openstudio-model-articulation', github: 'NREL/openstudio-model-articulation-gem', branch: 'develop'
 else
-  gem 'openstudio-model-articulation', '~> 0.3.1'
+  gem 'openstudio-model-articulation', '~> 0.4.0'
 end
 
 if allow_local && File.exist?('../openstudio-load-flexibility-measures-gem')
@@ -47,7 +47,7 @@ if allow_local && File.exist?('../openstudio-load-flexibility-measures-gem')
 elsif allow_local
   gem 'openstudio-load-flexibility-measures', github: 'NREL/openstudio-load-flexibility-measures-gem', branch: 'master'
 else
-  gem 'openstudio-load-flexibility-measures', '~> 0.2.1'
+  gem 'openstudio-load-flexibility-measures', '~> 0.3.1'
 end
 
 if allow_local && File.exist?('../openstudio-ee-gem')
@@ -55,7 +55,7 @@ if allow_local && File.exist?('../openstudio-ee-gem')
 elsif allow_local
   gem 'openstudio-ee', github: 'NREL/openstudio-ee-gem', branch: 'develop'
 else
-  gem 'openstudio-ee', '~> 0.3.2'
+  gem 'openstudio-ee', '~> 0.4.0'
 end
 
 if allow_local && File.exist?('../openstudio-calibration-gem')
@@ -63,7 +63,7 @@ if allow_local && File.exist?('../openstudio-calibration-gem')
 elsif allow_local
   gem 'openstudio-calibration', github: 'NREL/openstudio-calibration-gem', branch: 'develop'
 else
-  gem 'openstudio-calibration', '~> 0.3.1'
+  gem 'openstudio-calibration', '~> 0.4.0'
 end
 
 if allow_local && File.exists?('../urbanopt-geojson-gem')
@@ -71,7 +71,7 @@ if allow_local && File.exists?('../urbanopt-geojson-gem')
 elsif allow_local
   gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
 else
-  gem 'urbanopt-geojson', '~> 0.5.0'
+  gem 'urbanopt-geojson', '~> 0.6.1'
 end
 
 if allow_local && File.exists?('../urbanopt-reporting-gem')
@@ -79,5 +79,5 @@ if allow_local && File.exists?('../urbanopt-reporting-gem')
 elsif allow_local
   gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
 else
-  gem 'urbanopt-reporting', '~> 0.3.6'
+  gem 'urbanopt-reporting', '~> 0.4.0'
 end

data/example_files/mappers/Baseline.rb

@@ -443,48 +443,48 @@ module URBANopt
             args[:geometry_building_num_units] = 1
             case building_type
             when 'Single-Family Detached'
-              args[:geometry_unit_type] = "single-family detached"
+              args[:geometry_unit_type] = 'single-family detached'
             when 'Single-Family Attached'
               args[:geometry_building_num_units] = feature.number_of_residential_units
-              args[:geometry_unit_type] = "single-family attached"
+              args[:geometry_unit_type] = 'single-family attached'
             when 'Multifamily'
               args[:geometry_building_num_units] = feature.number_of_residential_units
-              args[:geometry_unit_type] = "apartment unit"
+              args[:geometry_unit_type] = 'apartment unit'
               args[:geometry_corridor_position] = 'Double Exterior' # if we had an interior corridor, we'd have to subtract its area from the footprint area
             end
 
-            args[:geometry_foundation_type] = "SlabOnGrade"
+            args[:geometry_foundation_type] = 'SlabOnGrade'
             args[:geometry_foundation_height] = 0.0
             case feature.foundation_type
             when 'crawlspace - vented'
-              args[:geometry_foundation_type] = "VentedCrawlspace"
+              args[:geometry_foundation_type] = 'VentedCrawlspace'
               args[:geometry_foundation_height] = 3.0
             when 'crawlspace - unvented'
-              args[:geometry_foundation_type] = "UnventedCrawlspace"
+              args[:geometry_foundation_type] = 'UnventedCrawlspace'
               args[:geometry_foundation_height] = 3.0
             when 'basement - unconditioned'
-              args[:geometry_foundation_type] = "UnconditionedBasement"
+              args[:geometry_foundation_type] = 'UnconditionedBasement'
               args[:geometry_foundation_height] = 8.0
             when 'basement - conditioned'
-              args[:geometry_foundation_type] = "ConditionedBasement"
+              args[:geometry_foundation_type] = 'ConditionedBasement'
               args[:geometry_foundation_height] = 8.0
             when 'ambient'
-              args[:geometry_foundation_type] = "Ambient"
+              args[:geometry_foundation_type] = 'Ambient'
               args[:geometry_foundation_height] = 8.0
             end
 
-            args[:geometry_attic_type] = "VentedAttic"
-            args[:geometry_roof_type] = "flat"
+            args[:geometry_attic_type] = 'VentedAttic'
+            args[:geometry_roof_type] = 'flat'
             begin
               case feature.attic_type
               when 'attic - vented'
-                args[:geometry_roof_type] = "gable"
+                args[:geometry_roof_type] = 'gable'
               when 'attic - unvented'
-                args[:geometry_attic_type] = "UnventedAttic"
-                args[:geometry_roof_type] = "gable"
+                args[:geometry_attic_type] = 'UnventedAttic'
+                args[:geometry_roof_type] = 'gable'
               when 'attic - conditioned'
-                args[:geometry_attic_type] = "ConditionedAttic"
-                args[:geometry_roof_type] = "gable"
+                args[:geometry_attic_type] = 'ConditionedAttic'
+                args[:geometry_roof_type] = 'gable'
               end
             rescue
             end
@@ -522,50 +522,51 @@ module URBANopt
 
             args[:schedules_type] = 'stochastic'
             args[:feature_id] = feature_id.hex
+            args[:schedules_variation] = 'building' # building or unit
 
             # HVAC
 
-            system_type = "Residential - furnace and central air conditioner"
+            system_type = 'Residential - furnace and central air conditioner'
             begin
               system_type = feature.system_type
             rescue
             end
 
-            args[:heating_system_type] = "none"
+            args[:heating_system_type] = 'none'
             if system_type.include?('electric resistance')
-              args[:heating_system_type] = "ElectricResistance"
+              args[:heating_system_type] = 'ElectricResistance'
             elsif system_type.include?('furnace')
-              args[:heating_system_type] = "Furnace"
+              args[:heating_system_type] = 'Furnace'
             elsif system_type.include?('boiler')
-              args[:heating_system_type] = "Boiler"
+              args[:heating_system_type] = 'Boiler'
             end
 
-            args[:cooling_system_type] = "none"
+            args[:cooling_system_type] = 'none'
             if system_type.include?('central air conditioner')
-              args[:cooling_system_type] = "central air conditioner"
+              args[:cooling_system_type] = 'central air conditioner'
             elsif system_type.include?('room air conditioner')
-              args[:cooling_system_type] = "room air conditioner"
+              args[:cooling_system_type] = 'room air conditioner'
             elsif system_type.include?('evaporative cooler')
-              args[:cooling_system_type] = "evaporative cooler"
+              args[:cooling_system_type] = 'evaporative cooler'
             end
 
-            args[:heat_pump_type] = "none"
+            args[:heat_pump_type] = 'none'
             if system_type.include?('air-to-air')
-              args[:heat_pump_type] = "air-to-air"
+              args[:heat_pump_type] = 'air-to-air'
             elsif system_type.include?('mini-split')
-              args[:heat_pump_type] = "mini-split"
+              args[:heat_pump_type] = 'mini-split'
             elsif system_type.include?('ground-to-air')
-              args[:heat_pump_type] = "ground-to-air"
+              args[:heat_pump_type] = 'ground-to-air'
             end
 
-            args[:heating_system_fuel] = "natural gas"
+            args[:heating_system_fuel] = 'natural gas'
             begin
               args[:heating_system_fuel] = feature.heating_system_fuel_type
             rescue
             end
 
-            if args[:heating_system_type] == "ElectricResistance"
-              args[:heating_system_fuel] = "electricity"
+            if args[:heating_system_type] == 'ElectricResistance'
+              args[:heating_system_fuel] = 'electricity'
             end
 
             # APPLIANCES
@@ -618,21 +619,21 @@ module URBANopt
 
                 # HVAC
 
-                if args[:heating_system_type] != "none"
+                if args[:heating_system_type] != 'none'
                   heating_system_filepath = File.join(File.dirname(__FILE__), 'residential/heating_system.tsv')
                   heating_system = get_lookup_tsv(args, heating_system_filepath)
                   row = get_lookup_row(args, heating_system, template_vals)
                   args.update(row) unless row.nil?
                 end
 
-                if args[:cooling_system_type] != "none"
+                if args[:cooling_system_type] != 'none'
                   cooling_system_filepath = File.join(File.dirname(__FILE__), 'residential/cooling_system.tsv')
                   cooling_system = get_lookup_tsv(args, cooling_system_filepath)
                   row = get_lookup_row(args, cooling_system, template_vals)
                   args.update(row) unless row.nil?
                 end
 
-                if args[:heat_pump_type] != "none"
+                if args[:heat_pump_type] != 'none'
                   heat_pump_filepath = File.join(File.dirname(__FILE__), 'residential/heat_pump.tsv')
                   heat_pump = get_lookup_tsv(args, heat_pump_filepath)
                   row = get_lookup_row(args, heat_pump, template_vals)
@@ -690,7 +691,7 @@ module URBANopt
 
             args.keys.each do |arg_name|
               unless default_args.keys.include? arg_name
-                next if arg_name == 'feature_id'
+                next if [:feature_id, :schedules_variation].include?(arg_name)
 
                 puts "Argument '#{arg_name}' is unknown."
               end

data/example_files/measures/BuildResidentialModel/measure.rb

@@ -39,6 +39,15 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
     arg.setDescription('The feature ID passed from Baseline.rb.')
     args << arg
 
+    schedules_variation_choices = OpenStudio::StringVector.new
+    schedules_variation_choices << 'building'
+    schedules_variation_choices << 'unit'
+
+    arg = OpenStudio::Ruleset::OSArgument.makeChoiceArgument('schedules_variation', schedules_variation_choices, true)
+    arg.setDisplayName('Schedules: Variation')
+    arg.setDescription('How the schedules vary.')
+    args << arg
+
     measures_dir = File.absolute_path(File.join(File.dirname(__FILE__), '../../resources/hpxml-measures'))
     measure_subdir = 'BuildResidentialHPXML'
     full_measure_path = File.join(measures_dir, measure_subdir, 'measure.rb')
@@ -111,10 +120,15 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
       # fill the measure args hash with default values
       measure_args = args.clone
       measure_args.delete('feature_id')
+      measure_args.delete('schedules_variation')
 
       measures = {}
       measures[measure_subdir] = []
+
+      # hpxml path
       measure_args['hpxml_path'] = hpxml_path
+
+      # software program
       begin
         measure_args['software_program_used'] = File.basename(File.absolute_path(File.join(File.dirname(__FILE__), '../../..')))
       rescue
@@ -125,7 +139,16 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
         measure_args['software_program_version'] = URBANopt::CLI::VERSION
       rescue
       end
+
+      # schedules
       measure_args['schedules_random_seed'] = args['feature_id'] * (unit_num + 1) # variation across units, but deterministic
+      if args['schedules_variation'] == 'building' && unit_num != 0 # variation by building, use already generated schedules
+        measure_args['schedules_type'] = 'user-specified'
+        measure_args['schedules_path'] = File.expand_path('../unit 1_schedules.csv')
+        measure_args.delete('schedules_random_seed')
+      end
+
+      # geometry
       if unit.keys.include?('geometry_level')
         measure_args['geometry_level'] = unit['geometry_level']
       end
@@ -135,6 +158,7 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
       if unit.keys.include?('geometry_orientation')
         measure_args['geometry_orientation'] = unit['geometry_orientation']
       end
+
       measures[measure_subdir] << measure_args
 
       # HPXMLtoOpenStudio
@@ -205,37 +229,7 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
         end
 
         # prefix all objects with name using unit number. May be cleaner if source models are setup with unique names
-        sensors_and_actuators_map = {}
-        unit_model.getEnergyManagementSystemSensors.each do |sensor|
-          sensors_and_actuators_map[sensor.name.to_s] = "#{unit['name'].gsub(' ', '_')}_#{sensor.name}"
-          sensor.setKeyName("#{unit['name']} #{sensor.keyName}") unless sensor.keyName.empty?
-        end
-        unit_model.getEnergyManagementSystemActuators.each do |actuator|
-          sensors_and_actuators_map[actuator.name.to_s] = "#{unit['name'].gsub(' ', '_')}_#{actuator.name}"
-        end
-
-        # variables in program lines don't get updated automatically
-        unit_model.getEnergyManagementSystemPrograms.each do |program|
-          new_lines = []
-          program.lines.each_with_index do |line, i|
-            sensors_and_actuators_map.each do |old_name, new_name|
-              line = line.gsub(" #{old_name}", " #{new_name}") if line.include?(" #{old_name}")
-              line = line.gsub("(#{old_name} ", "(#{new_name} ") if line.include?("(#{old_name} ")
-              line = line.gsub(" #{old_name})", " #{new_name})") if line.include?(" #{old_name})")
-              line = line.gsub("-#{old_name})", "-#{new_name})") if line.include?("-#{old_name})")
-              line = line.gsub("+#{old_name})", "+#{new_name})") if line.include?("+#{old_name})")
-              line = line.gsub("*#{old_name})", "*#{new_name})") if line.include?("*#{old_name})")
-            end
-            new_lines << line
-          end
-          program.setLines(new_lines)
-        end
-
-        unit_model.objects.each do |model_object|
-          next if model_object.name.nil?
-
-          model_object.setName("#{unit['name']} #{model_object.name.to_s}")
-        end
+        prefix_all_unit_model_objects(unit_model, unit)
 
         # we already have the following unique objects from the first building unit
         unit_model.getConvergenceLimits.remove
@@ -256,6 +250,7 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
         end
 
         model.addObjects(unit_model_objects, true)
+
       end
     end
 
@@ -269,7 +264,7 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
   def get_unit_positions(runner, args)
     units = []
     if args['geometry_unit_type'] == 'single-family detached'
-      units << {'name' => "unit 1"}
+      units << {'name' => 'unit 1'}
     elsif args['geometry_unit_type'] == 'single-family attached'
       (1..args['geometry_building_num_units']).to_a.each do |unit_num|
         if unit_num == 1
@@ -342,19 +337,57 @@ class BuildResidentialModel < OpenStudio::Measure::ModelMeasure
       next unless arg.hasDefaultValue
 
       case arg.type.valueName.downcase
-      when "boolean"
+      when 'boolean'
         args[arg.name] = arg.defaultValueAsBool
-      when "double"
+      when 'double'
         args[arg.name] = arg.defaultValueAsDouble
-      when "integer"
+      when 'integer'
         args[arg.name] = arg.defaultValueAsInteger
-      when "string"
+      when 'string'
         args[arg.name] = arg.defaultValueAsString
-      when "choice"
+      when 'choice'
         args[arg.name] = arg.defaultValueAsString
       end
     end
   end
+
+  def prefix_all_unit_model_objects(unit_model, unit)
+    ems_map = {}
+    unit_model.getEnergyManagementSystemSensors.each do |sensor|
+      ems_map["#{sensor.name}"] = "#{unit['name'].gsub(' ', '_')}_#{sensor.name}"
+      sensor.setKeyName("#{unit['name']} #{sensor.keyName}") unless sensor.keyName.empty?
+    end
+    unit_model.getEnergyManagementSystemActuators.each do |actuator|
+      ems_map["#{actuator.name}"] = "#{unit['name'].gsub(' ', '_')}_#{actuator.name}"
+    end
+    unit_model.getEnergyManagementSystemOutputVariables.each do |output_variable|
+      ems_map["#{output_variable.emsVariableName}"] = "#{unit['name'].gsub(' ', '_')}_#{output_variable.emsVariableName}"
+      output_variable.setEMSVariableName("#{unit['name'].gsub(' ', '_')}_#{output_variable.emsVariableName}")
+    end
+
+    # variables in program lines don't get updated automatically
+    unit_model.getEnergyManagementSystemPrograms.each do |program|
+      new_lines = []
+      program.lines.each_with_index do |line, i|
+        ems_map.each do |old_name, new_name|
+          line = line.gsub(" #{old_name}", " #{new_name}") if line.include?(" #{old_name}")
+          line = line.gsub("(#{old_name} ", "(#{new_name} ") if line.include?("(#{old_name} ")
+          line = line.gsub(" #{old_name})", " #{new_name})") if line.include?(" #{old_name})")
+          line = line.gsub("-#{old_name})", "-#{new_name})") if line.include?("-#{old_name})")
+          line = line.gsub("+#{old_name})", "+#{new_name})") if line.include?("+#{old_name})")
+          line = line.gsub("*#{old_name})", "*#{new_name})") if line.include?("*#{old_name})")
+        end
+        new_lines << line
+      end
+      program.setLines(new_lines)
+    end
+
+    unit_model.objects.each do |model_object|
+      next if model_object.name.nil?
+
+      model_object.setName("#{unit['name']} #{model_object.name.to_s}")
+    end
+  end
 end
 
 # register the measure to be used by the application