openstudio-extension 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7199026e992efc5a48c8c164cc26ff9a30b78266
-  data.tar.gz: 8e609b0ab15f84fbbf05e15255eb8a38a031695f
+  metadata.gz: c4e2f50a7956aab9ba887ed122f081f9d1a593e9
+  data.tar.gz: 9883f17cccdb73a1f70ca70806c4a529f4d5837a
 SHA512:
-  metadata.gz: 7e6c4367cd3d0b03a463e799461e1705ef9710b4974ee8d0638d369914369fe629e8dfa560e18312179cb133396a0a70730e7de2357c08a9fc7f9a60f8b2f724
-  data.tar.gz: 0c7ad841664b252c48090e6b04b9efd44abe27d02defd91c383e351c1b334a1bbca40570e46e10efa6dd238db79e9d5e1b49398841997f1d6b46a387780f8c1a
+  metadata.gz: f41334de4ba12a02b02ba8c8963f912793c0885d922532f1b21af10656a368ab84baee8cdca6d9e75ec96cfd8d2dac35ccbf008201c2043c10717f5824058251
+  data.tar.gz: 78bd29c60ef04bef8e792095e4c919435e35f5f41fa3f9cd7a4dd64ed85c7d2184dbafaa367ea54bb4b8e5f57c06d0d7e5ed2f20e4519a24de9b9146d47d7739

data/README.md

@@ -36,7 +36,7 @@ To use this and other extension gems, you will need Ruby 2.2.4 and OpenStudio 2.
 ### Windows Installation
 Install Ruby using the [RubyInstaller](https://rubyinstaller.org/downloads/archives/) for [Ruby 2.2.4 (x64)](https://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.2.4-x64.exe).
 
-Install Dekit using the [mingw64](https://dl.bintray.com/oneclick/rubyinstaller/DevKit-mingw64-64-4.7.2-20130224-1432-sfx.exe) installer.
+Install Devkit using the [mingw64](https://dl.bintray.com/oneclick/rubyinstaller/DevKit-mingw64-64-4.7.2-20130224-1432-sfx.exe) installer.
 
 Check the ruby installation returns the correct Ruby version (2.2.4):
 ```
@@ -61,23 +61,23 @@ ruby -e "require 'openstudio'" -e "puts OpenStudio::Model::Model.new"
 
 ### Mac Installation
 It is recommended that you install [rbenv](https://github.com/rbenv/rbenv) to easily manage difference versions of Ruby.
-rbenv can be installed view Homebrew:
-```ruby
+rbenv can be installed via [Homebrew](https://brew.sh/):
+```
 brew install rbenv
 rbenv init
 rbenv install 2.2.4
 ```
 
 Also install bundler
-```ruby
+```
 gem install bundler -v 1.17
 ```
 
 Install [OpenStudio](https://www.openstudio.net/downloads).
 
-Add the RUBYLIB environment variable to your bash_profile file. It should point to the Ruby folder within the OpenStudio Application you just downloaded:
-```ruby
-export RUBYLIB=“/Applications/OpenStudio-2.7.2/Ruby”
+Add the RUBYLIB environment variable to your `bash_profile` (or similar) file. It should point to the Ruby folder within the OpenStudio Application you just downloaded (replace 2.7.2 with the version you are using):
+```
+export RUBYLIB=/Applications/OpenStudio-2.7.2/Ruby
 ```
 
 
@@ -180,7 +180,7 @@ The OpenStudio-extension gem can be used to easily initialize a new derivative e
 
 * First, call the rake task:
     ```ruby
-    bundle exec rake init-new-gem
+    bundle exec rake init_new_gem
     ```
     * Enter the name of the gem repository (use dashes between words and the repo name should end with '-gem')
     * Enter the location of the directory where the gem directory should be created

data/lib/openstudio/extension/core/CreateResults.rb

@@ -388,14 +388,22 @@ module OsLib_CreateResults
         end
       end
 
+      # Get the electricity timeseries to determine the year used
+      elec = @sql.timeSeries(ann_env_pd, 'Zone Timestep', 'Electricity:Facility', '')
+      timeseries_yr = nil
+      if elec.is_initialized
+        timeseries_yr = elec.get.dateTimes[0].date.year
+      else
+        @runner.registerError('Peak Demand timeseries (Electricity:Facility at zone timestep) could not be found, cannot determine the informatino needed to calculate savings or incentives.')
+      end
       # Setup the peak demand time window based on input arguments.
       # Note that holidays and weekends are not excluded because
       # of a bug in EnergyPlus dates.
       # This will only impact corner-case buildings that have
       # peak demand on weekends or holidays, which is unusual.
       @runner.registerInfo("Peak Demand window is #{start_mo} #{start_day} to #{end_mo} #{end_day} from #{start_hr}:00 to #{end_hr}:00.")
-      start_date = OpenStudio::DateTime.new(OpenStudio::Date.new(OpenStudio::MonthOfYear.new(start_mo), start_day), OpenStudio::Time.new(0, 0, 0, 0))
-      end_date = OpenStudio::DateTime.new(OpenStudio::Date.new(OpenStudio::MonthOfYear.new(end_mo), end_day), OpenStudio::Time.new(0, 24, 0, 0))
+      start_date = OpenStudio::DateTime.new(OpenStudio::Date.new(OpenStudio::MonthOfYear.new(start_mo), start_day, timeseries_yr), OpenStudio::Time.new(0, 0, 0, 0))
+      end_date = OpenStudio::DateTime.new(OpenStudio::Date.new(OpenStudio::MonthOfYear.new(end_mo), end_day, timeseries_yr), OpenStudio::Time.new(0, 24, 0, 0))
       start_time = OpenStudio::Time.new(0, start_hr, 0, 0)
       end_time = OpenStudio::Time.new(0, end_hr, 0, 0)
 
@@ -416,7 +424,6 @@ module OsLib_CreateResults
       # electricity_peak_demand
       electricity_peak_demand = -1.0
       electricity_peak_demand_time = nil
-      elec = @sql.timeSeries(ann_env_pd, 'Zone Timestep', 'Electricity:Facility', '')
       # deduce the timestep based on the hours simulated and the number of datapoints in the timeseries
       if elec.is_initialized && day_types
         elec = elec.get

data/lib/openstudio/extension/core/os_lib_reporting.rb

@@ -1001,7 +1001,7 @@ module OsLib_Reporting
       data_arrays << [setpoint.iddObject.name, 'Reset', desc, '', '']
 
     when 'OS:SetpointManager:Warmest'
-      setpoint = component.to_SetpointManagerWarmest
+      setpoint = component.to_SetpointManagerWarmest.get
       source_units = 'C'
       if is_ip_units
         target_units = 'F'
@@ -1009,12 +1009,12 @@ module OsLib_Reporting
         target_units = source_units
       end
       min_sat_f = OpenStudio.convert(setpoint.minimumSetpointTemperature, source_units, target_units).get.round(1)
-      max_sat_f = OpenStudio.convert(setpoint.minimumSetpointTemperature, source_units, target_units).get.round(1)
+      max_sat_f = OpenStudio.convert(setpoint.maximumSetpointTemperature, source_units, target_units).get.round(1)
       desc = "#{min_sat_f} #{target_units} to #{max_sat_f.round} #{target_units}"
       data_arrays << [setpoint.iddObject.name, 'Reset SAT per Worst Zone', desc, '', '']
 
     when 'OS:SetpointManager:WarmestTemperatureFlow'
-      setpoint = component.to_SetpointManagerWarmestTemperatureFlow
+      setpoint = component.to_SetpointManagerWarmestTemperatureFlow.get
       source_units = 'C'
       if is_ip_units
         target_units = 'F'
@@ -1022,7 +1022,7 @@ module OsLib_Reporting
         target_units = source_units
       end
       min_sat_f = OpenStudio.convert(setpoint.minimumSetpointTemperature, source_units, target_units).get.round(1)
-      max_sat_f = OpenStudio.convert(setpoint.minimumSetpointTemperature, source_units, target_units).get.round(1)
+      max_sat_f = OpenStudio.convert(setpoint.maximumSetpointTemperature, source_units, target_units).get.round(1)
       desc = "#{min_sat_f} #{target_units} to #{max_sat_f.round} #{target_units}, #{setpoint.strategy}"
       data_arrays << [setpoint.iddObject.name, 'Reset SAT & Flow per Worst Zone', desc, '', '']
     end
@@ -1899,7 +1899,7 @@ module OsLib_Reporting
     table = {}
     table[:title] = 'Exterior Lighting'
     table[:header] = columns
-    table[:source_units] = ['', 'W', '', '', 'kWh'] # used for conversion, not needed for rendering.
+    table[:source_units] = ['', 'W', '', '', 'GJ'] # used for conversion, not needed for rendering.
     table[:units] = ['', 'W', '', '', 'kWh']
     table[:data] = []
 
@@ -3383,17 +3383,17 @@ module OsLib_Reporting
             if is_ip_units
               ee_power = elec_equip.powerPerFloorArea.to_f * 0.092903 # IP
               ee_power = "#{ee_power.round(2)} (W/ft^2)"
-              ee_total_power = ((elec_equip.powerPerFloorArea.to_f * space.floorArea) * 0.092903) * elec_equip.multiplier
+              ee_total_power = ((elec_equip.powerPerFloorArea.to_f * space.floorArea))
             else
               ee_power = elec_equip.powerPerFloorArea.to_f
               ee_power = "#{ee_power.round(2)} (W/m^2)"
-              ee_total_power = ((elec_equip.powerPerFloorArea.to_f * space.floorArea)) * elec_equip.multiplier
+              ee_total_power = ((elec_equip.powerPerFloorArea.to_f * space.floorArea))
             end
           end
 
           if elec_equip.electricEquipmentDefinition.designLevelCalculationMethod == 'Watts/Person'
             ee_power = "#{elec_equip.powerPerPerson.to_f.round(2)} (W/person)"
-            ee_total_power = (elec_equip.powerPerPerson.to_f * space.numberOfPeople) * elec_equip.multiplier
+            ee_total_power = (elec_equip.powerPerPerson.to_f * space.numberOfPeople)
           end
 
           if elec_equip.electricEquipmentDefinition.designLevelCalculationMethod == 'EquipmentLevel'

data/lib/openstudio/extension/version.rb

@@ -35,6 +35,6 @@
 
 module OpenStudio
   module Extension
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.1.2'.freeze
   end
 end

data/lib/openstudio/extension.rb

@@ -163,10 +163,7 @@ module OpenStudio
       end
 
       if !conflicts.empty?
-        conflicts.each do |conflict|
-          puts conflict
-        end
-        raise 'Conflicting file names found'
+        raise "Conflicting file names found: #{conflicts.join(', ')}"
       end
 
       return false
@@ -194,24 +191,36 @@ module OpenStudio
     end
 
     ##
-    # Module method used to set the measure argument for measure_dir_name to argument_value
-    # argument_name must appear in the OSW or exception will be raised
+    # Module method used to set the measure argument for measure_dir_name to argument_value,
+    # argument_name must appear in the OSW or exception will be raised.  If step_name is nil
+    # then all workflow steps matching measure_dir_name will be affected.  If step_name is 
+    # not nil, then only workflow steps matching measure_dir_name and step_name will be affected.
     ##
     #  @param [Hash] in_osw Initial OSW object as a Hash, keys should be symbolized
+    #  @param [String] measure_dir_name Directory name of measure to set argument on
+    #  @param [String] argument_name Name of the argument to set
+    #  @param [String] argument_value Value to set the argument name to
+    #  @param [String] step_name Optional argument, if present used to select workflow step to modify
     #
-    #  @return [Hash] Output OSW with measure argument set
+    #  @return [Hash] Output OSW with measure argument set to argument value
     #
-    def self.set_measure_argument(osw, measure_dir_name, argument_name, argument_value)
+    def self.set_measure_argument(osw, measure_dir_name, argument_name, argument_value, step_name = nil)
       result = false
       osw[:steps].each do |step|
         if step[:measure_dir_name] == measure_dir_name
-          step[:arguments][argument_name.to_sym] = argument_value
-          result = true
+          if step_name.nil? || step[:name] == step_name
+            step[:arguments][argument_name.to_sym] = argument_value
+            result = true
+          end
         end
       end
 
       if !result
-        raise "Could not set '#{argument_name}' to '#{argument_value}' for measure '#{measure_dir_name}'"
+        if step_name
+          raise "Could not set '#{argument_name}' to '#{argument_value}' for measure '#{measure_dir_name}' in step '#{step_name}'"
+        else
+          raise "Could not set '#{argument_name}' to '#{argument_value}' for measure '#{measure_dir_name}'"
+        end
       end
 
       return osw

data/lib/openstudio-extension.rb

@@ -0,0 +1 @@
+require_relative 'openstudio/extension'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-extension
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Katherine Fleming
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2019-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -166,6 +166,7 @@ files:
 - lib/measures/openstudio_extension_test_measure/measure.xml
 - lib/measures/openstudio_extension_test_measure/resources/os_lib_helper_methods.rb
 - lib/measures/openstudio_extension_test_measure/tests/OpenStudioExtensionTestMeasure_Test.rb
+- lib/openstudio-extension.rb
 - lib/openstudio/extension.rb
 - lib/openstudio/extension/core/CreateResults.rb
 - lib/openstudio/extension/core/check_air_sys_temps.rb