openstudio-extension 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d0b42ef4c9c5ee88e2e750956e7147ec1971614d9bc46b0f8926332937aabbb
-  data.tar.gz: 2177f877389dcc3587c575f361d10d0228269d875c59f22ba7f03bd5fa829d06
+  metadata.gz: 1cc5634df3c8c1a9c8a711707cd6b6a9d07b4a0f0f01aed1726576e244a0c5b2
+  data.tar.gz: 8e433cbc4b7cc8b6737544771bb5273d8a7a267b8153ea936a2af3dccb61b486
 SHA512:
-  metadata.gz: a6796c88ae5bdd6a269377c4d9845421aa36318f60297dc55bba600f4ebc83143f0ed21fbae5d6ea0c1c05be3363dfdc97f4109866959070fb86dcbe27174dbe
-  data.tar.gz: a96dd4fc093da1528f39b4401b0cab6a0ca195877dd979ace7e285fdb83674b19885a901f5df8d18c77a3a37a19f40a4683bbdf82e3181df4e575bb92dec97b5
+  metadata.gz: 455200a3b2e03ae2b5ef3d15f67690297c04f7886ce31a5f358f02a907a394a5cc0f0ba57b7b44efa96633443f4d23316e391716548cbcaf70af11881389fe44
+  data.tar.gz: 9f478fb250845c5e99b9d1d12ba4261b5b7c82fb2f69bffcd594c5ec1f8a5463d76c4de51202cac29b2f875d07bfffd35cc6fa53ae4e8d4baa3732a0d0c57e22

data/CHANGELOG.md

@@ -1,11 +1,26 @@
 # OpenStudio Extension Gem
 
+## Version 0.2.1
+
+* Changes from 0.1.5 (runner.conf bug)
+* Changes from 0.1.6 (update core library)
+* Update measure tester to 0.2.2 (with Rubocop 0.54)
+
 ## Version 0.2.0
 
 * Upgrade Bundler to 2.1.x
 * Restrict to Ruby ~> 2.5.0
 * Remove json_pure gem
 * Update measure tester to 0.2.0 (removes need for github checkout)
+* Note that this version does not include the changes from Version 0.1.5
+
+## Version 0.1.6
+
+* Update core library methods with what was in OpenStudio-measures
+
+## Version 0.1.5
+
+* Fix bug to respect the runner.conf file when using Extension::Runner with no options
 
 ## Version 0.1.4
 

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 # Specify your gem's dependencies in openstudio-extension.gemspec

data/Jenkinsfile

@@ -1,10 +1,10 @@
-//Jenkins pipelines are stored in shared libaries. Please see: https://github.com/tijcolem/nrel_cbci_jenkins_libs 
+//Jenkins pipelines are stored in shared libaries. Please see: https://github.com/NREL/cbci_jenkins_libs
  
 @Library('cbci_shared_libs') _
 
 // Build for PR to develop branch only. 
 if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) { // check if set
 
-  openstudio_extension_gems_3_x()
+  openstudio_extension_gems()
     
 }

data/README.md

@@ -31,27 +31,27 @@ Each OpenStudio extension gem should define its own module name to ensure that t
 
 ## Installation
 
-To use this and other extension gems, you will need Ruby 2.2.4 and OpenStudio 2.7.1 or greater.  
+To use this and other extension gems, you will need Ruby 2.5.x and OpenStudio 3.0.0 or greater.  
 
 ### 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 Ruby using the [RubyInstaller](https://rubyinstaller.org/downloads/archives/) for [Ruby 2.5.5 (x64)](https://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.5.5-x64.exe).
 
 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):
+Check the ruby installation returns the correct Ruby version (2.5.x):
 ```
 ruby -v
 ```
 
 Install bundler from the command line
 ```
-gem install bundler -v 1.17
+gem install bundler -v 2.1
 ```
 
-Install OpenStudio.  Create a file ```C:\ruby-2.2.4-x64-mingw32\lib\ruby\site_ruby\openstudio.rb``` and point it to your OpenStudio installation by editing the contents.  E.g.:
+Install OpenStudio.  Create a file ```C:\ruby-2.5.5-x64-mingw32\lib\ruby\site_ruby\openstudio.rb``` and point it to your OpenStudio installation by editing the contents.  E.g.:
 
 ```ruby
-require 'C:\openstudio-2.7.1\Ruby\openstudio.rb'
+require 'C:\openstudio-3.0.0\Ruby\openstudio.rb'
 ```
 
 Verify your OpenStudio and Ruby configuration:
@@ -65,19 +65,20 @@ rbenv can be installed via [Homebrew](https://brew.sh/):
 ```
 brew install rbenv
 rbenv init
-rbenv install 2.2.4
+rbenv install 2.5.5
 ```
 
 Also install bundler
 ```
-gem install bundler -v 1.17
+gem install bundler -v 2.1
 ```
 
 Install [OpenStudio](https://www.openstudio.net/downloads).
 
-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):
+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 3.0.0 with the version you are using):
 ```
-export RUBYLIB=/Applications/OpenStudio-2.7.2/Ruby
+export RUBYLIB=/Applications/OpenStudio-3.0.0/Ruby
 ```
 
 
@@ -150,7 +151,7 @@ Common Rake Tasks that are available to derivative extension gems include:
 | openstudio:measures:add_readme       | Add README.md.erb file if it and the README markdown file do not already exist for a measure |
 | openstudio:measures:copy_resources   | Copy the resources files to individual measures in the calling gem |
 | openstudio:measures:update_copyright | Update copyright on measure files in the calling gem |
-| openstudio`:runner:`init          | Create a runner.conf file running simulations |
+| openstudio`:runner:`init             | Create a runner.conf file running simulations |
 | openstudio:stage_bcl                 | Copy the measures to a location that can be uploaded to BCL |
 | openstudio:push_bcl                  | Upload measures from the specified location to the BCL |
 | openstudio:test_with_docker          | Use openstudio docker image to run tests |
@@ -235,22 +236,10 @@ Or install it yourself as:
 
 # TODO
 
-- [X] Finalize documentation on naming conventions, etc
-- [X] Add test measure
-- [X] Rake task ```openstudio:update_measures```
-- [X] Rake task ```openstudio:test_with_openstudio```
 - [ ] Rake task ```stage_bcl``` _DLM: BCL gem should be a development dependency only until we can reduce its dependencies and remove native dependencies? should probably put it into a special group so we can bundle without it in openstudio-gems._
 - [ ] Rake task ```push_bcl``` _DLM: how do we want to test this?
-- [X] Get all rake tasks working on Travis
 - [ ] Capture useful output from Travis (measure dashboard results, log files, zip of build products, etc) and put it somewhere (s3?  naming convention?)
-- [X] ```Extension::openstudio_extension_version``` _DLM: should we rename? should people overwrite this in their class?_
-- [X] ```Extension::measures_dir``` _DLM: I think this can have a default implementation, right? If something does not need to be overridden should it be a module method rather than a class one?  KAF: this is in rake task for now
-- [X] ```Extension::list_measures``` _DLM: I think this can have a default implementation, right?_KAF: In Rake task for now
 - [ ] ```Extension::files_dir``` _DLM: I think this can have a default implementation, right?_
 - [ ] ```Extension::minimum_openstudio_version``` _DLM: should we rename? should people overwrite this in their class?_
-- [X] ```Runner::initialize``` _DLM: should say that the path argument should be for a dir with a Gemfile right?_
-- [X] ```Runner::configure_osw``` _DLM: should take in an OSW, add paths to all measure and file dirs for loaded OpenStudio Extensions, write out configured OSW_
-- [ ] Run rubocop on all of the core files and remove exclusion from .rubocop.yml file.
 - [ ] Cleanup task after running tests (may need to be in the OpenStudio Measure Tester)
-- [X] Add a `rake init new_ext_gem` to Rakefile
 - [ ] Add tests to the extension/core

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ########################################################################################################################
 #  openstudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
 #

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'openstudio/extension'

data/lib/change_log.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'github_api'
 require 'date'
@@ -14,9 +15,9 @@ require 'optparse/date'
 
 options = {}
 OptionParser.new do |opts|
-  opts.banner = "Usage: change_log.rb [options]\n" +
-  "Prints New, Open, Closed Issues, and number of accepted PRs"
-  opts.separator ""
+  opts.banner = "Usage: change_log.rb [options]\n" \
+                'Prints New, Open, Closed Issues, and number of accepted PRs'
+  opts.separator ''
 
   # defaults, go back 90 days
   options[:start_date] = Date.today - 90

data/lib/measures/openstudio_extension_test_measure/measure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

data/lib/measures/openstudio_extension_test_measure/tests/openstudio_extension_test_measure_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

data/lib/openstudio-extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

data/lib/openstudio/extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
@@ -101,11 +103,9 @@ module OpenStudio
     def self.all_measure_dirs
       result = []
       all_extensions.each do |obj|
-        begin
-          dir = obj.new.measures_dir
-          result << dir if dir
-        rescue StandardError
-        end
+        dir = obj.new.measures_dir
+        result << dir if dir
+      rescue StandardError
       end
       return result.uniq
     end
@@ -117,11 +117,9 @@ module OpenStudio
     def self.all_file_dirs
       result = []
       all_extensions.each do |obj|
-        begin
-          dir = obj.new.files_dir
-          result << dir if dir
-        rescue StandardError
-        end
+        dir = obj.new.files_dir
+        result << dir if dir
+      rescue StandardError
       end
       return result.uniq
     end

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

@@ -45,6 +45,23 @@ module OsLib_CreateResults
   # @param end_mo [String] the end month for the peak demand window
   # @param end_day [Integer] the end day for the peak demand window
   # @param end_hr [Integer] the end hour for the peak demand window, using 24-hr clock
+  # @param electricity_consumption_tou_periods [Array<Hash>] optional array of hashes to add
+  # time-of-use electricity consumption values to the annual consumption information.
+  # Periods may overlap, but should be listed in the order in which they must be checked,
+  # where the value will be assigned to the first encountered period it falls into.
+  # An example hash looks like this:
+  #       {
+  #         'tou_name' => 'system_peak',
+  #         'tou_id' => 1,
+  #         'skip_weekends' => true,
+  #         'skip_holidays' => true,
+  #         'start_mo' => 'July',
+  #         'start_day' => 1,
+  #         'start_hr' => 14,
+  #         'end_mo' => 'August',
+  #         'end_day' => 31,
+  #         'end_hr' => 18
+  #       }
   # @return [OpenStudio::AttributeVector] a vector of results needed by EDAPT
   def create_results(skip_weekends = true,
                      skip_holidays = true,
@@ -53,7 +70,8 @@ module OsLib_CreateResults
                      start_hr = 14,
                      end_mo = 'September',
                      end_day = 30,
-                     end_hr = 18)
+                     end_hr = 18,
+                     electricity_consumption_tou_periods = [])
 
     # get the current version of OS being used to determine if sql query
     # changes are needed (for when E+ changes).
@@ -497,6 +515,83 @@ module OsLib_CreateResults
         @runner.registerValue('annual_demand_electricity_peak_demand', 0.0, 'kW')
       end
 
+      # Describe the TOU periods
+      electricity_consumption_tou_periods.each do |tou_pd|
+        @runner.registerInfo("TOU period #{tou_pd['tou_id']} represents #{tou_pd['tou_name']} and covers #{tou_pd['start_mo']}-#{tou_pd['start_day']} to #{tou_pd['end_mo']}-#{tou_pd['end_day']} from #{tou_pd['start_hr']} to #{tou_pd['end_hr']}, skip weekends = #{tou_pd['skip_weekends']}, skip holidays = #{tou_pd['skip_holidays']}")
+      end
+
+      # electricity time-of-use periods
+      elec = @sql.timeSeries(ann_env_pd, 'Zone Timestep', 'Electricity:Facility', '')
+      if elec.is_initialized && day_types
+        elec = elec.get
+        # Put timeseries into array
+        elec_vals = []
+        ann_elec_vals = elec.values
+        for i in 0..(ann_elec_vals.size - 1)
+          elec_vals << ann_elec_vals[i]
+        end
+
+        # Put values into array
+        elec_times = []
+        ann_elec_times = elec.dateTimes
+        for i in 0..(ann_elec_times.size - 1)
+          elec_times << ann_elec_times[i]
+        end
+
+        # Loop through the time/value pairs and find the peak
+        # excluding the times outside of the Xcel peak demand window
+        electricity_tou_vals = Hash.new(0)
+        elec_times.zip(elec_vals).each_with_index do |vs, ind|
+          date_time = vs[0]
+          joules = vs[1]
+          day_type = day_types[ind]
+          time = date_time.time
+          date = date_time.date
+
+          # puts("#{val_kW}kW; #{date}; #{time}; #{day_of_week.valueName}")
+
+          # Determine which TOU period this hour falls into
+          tou_period_assigned = false
+          electricity_consumption_tou_periods.each do |tou_pd|
+            pd_start_date = OpenStudio::DateTime.new(OpenStudio::Date.new(OpenStudio::MonthOfYear.new(tou_pd['start_mo']), tou_pd['start_day'], timeseries_yr), OpenStudio::Time.new(0, 0, 0, 0))
+            pd_end_date = OpenStudio::DateTime.new(OpenStudio::Date.new(OpenStudio::MonthOfYear.new(tou_pd['end_mo']), tou_pd['end_day'], timeseries_yr), OpenStudio::Time.new(0, 24, 0, 0))
+            pd_start_time = OpenStudio::Time.new(0, tou_pd['start_hr'], 0, 0)
+            pd_end_time = OpenStudio::Time.new(0, tou_pd['end_hr'], 0, 0)
+            # Skip times outside of the correct months
+            next if date_time < pd_start_date || date_time > pd_end_date
+            # Skip times before some time and after another time
+            next if time < pd_start_time || time > pd_end_time
+            # Skip weekends if asked
+            if tou_pd['skip_weekends']
+              # Sunday = 1, Saturday = 7
+              next if day_type == 1 || day_type == 7
+            end
+            # Skip holidays if asked
+            if tou_pd['skip_holidays']
+              # Holiday = 8
+              next if day_type == 8
+            end
+            # If here, this hour falls into the specified period
+            tou_period_assigned = true
+            electricity_tou_vals[tou_pd['tou_id']] += joules
+            break
+          end
+          # Ensure that the value fell into a period
+          unless tou_period_assigned
+            @runner.registerError("Did not find a TOU period covering #{time} on #{date}, kWh will not be included in any TOU period.")
+          end
+        end
+        # Register values for any time-of-use period with kWh
+        electricity_tou_vals.each do |tou_pd_id, joules_in_pd|
+          gj_in_pd = OpenStudio.convert(joules_in_pd, 'J', 'GJ').get
+          kwh_in_pd = OpenStudio.convert(joules_in_pd, 'J', 'kWh').get
+          @runner.registerValue("annual_consumption_electricity_tou_#{tou_pd_id}", gj_in_pd, 'GJ')
+          @runner.registerInfo("TOU period #{tou_pd_id} annual electricity consumption = #{kwh_in_pd} kWh.")
+        end
+      else
+        @runner.registerError('Electricity timeseries (Electricity:Facility at zone timestep) could not be found, cannot determine the information needed to calculate savings or incentives.')
+      end
+
       # electricity_annual_avg_peak_demand
       val = @sql.electricityTotalEndUses
       if val.is_initialized
@@ -587,6 +682,88 @@ module OsLib_CreateResults
         @runner.registerValue('annual_demand_district_cooling_peak_demand', 0.0, 'kW')
       end
 
+      # district cooling time-of-use periods
+      dist_clg = @sql.timeSeries(ann_env_pd, 'Zone Timestep', 'DistrictCooling:Facility', '')
+      if dist_clg.is_initialized && day_types
+        dist_clg = dist_clg.get
+        # Put timeseries into array
+        dist_clg_vals = []
+        ann_dist_clg_vals = dist_clg.values
+        for i in 0..(ann_dist_clg_vals.size - 1)
+          dist_clg_vals << ann_dist_clg_vals[i]
+        end
+
+        # Put values into array
+        dist_clg_times = []
+        ann_dist_clg_times = dist_clg.dateTimes
+        for i in 0..(ann_dist_clg_times.size - 1)
+          dist_clg_times << ann_dist_clg_times[i]
+        end
+
+        # Loop through the time/value pairs and find the peak
+        # excluding the times outside of the Xcel peak demand window
+        dist_clg_tou_vals = Hash.new(0)
+        dist_clg_times.zip(dist_clg_vals).each_with_index do |vs, ind|
+          date_time = vs[0]
+          joules = vs[1]
+          day_type = day_types[ind]
+          time = date_time.time
+          date = date_time.date
+
+          # puts("#{val_kW}kW; #{date}; #{time}; #{day_of_week.valueName}")
+
+          # Determine which TOU period this hour falls into
+          tou_period_assigned = false
+          electricity_consumption_tou_periods.each do |tou_pd|
+            pd_start_date = OpenStudio::DateTime.new(OpenStudio::Date.new(OpenStudio::MonthOfYear.new(tou_pd['start_mo']), tou_pd['start_day'], timeseries_yr), OpenStudio::Time.new(0, 0, 0, 0))
+            pd_end_date = OpenStudio::DateTime.new(OpenStudio::Date.new(OpenStudio::MonthOfYear.new(tou_pd['end_mo']), tou_pd['end_day'], timeseries_yr), OpenStudio::Time.new(0, 24, 0, 0))
+            pd_start_time = OpenStudio::Time.new(0, tou_pd['start_hr'], 0, 0)
+            pd_end_time = OpenStudio::Time.new(0, tou_pd['end_hr'], 0, 0)
+            # Skip times outside of the correct months
+            next if date_time < pd_start_date || date_time > pd_end_date
+            # Skip times before some time and after another time
+            next if time < pd_start_time || time > pd_end_time
+            # Skip weekends if asked
+            if tou_pd['skip_weekends']
+              # Sunday = 1, Saturday = 7
+              next if day_type == 1 || day_type == 7
+            end
+            # Skip holidays if asked
+            if tou_pd['skip_holidays']
+              # Holiday = 8
+              next if day_type == 8
+            end
+            # If here, this hour falls into the specified period
+            tou_period_assigned = true
+            dist_clg_tou_vals[tou_pd['tou_id']] += joules
+            break
+          end
+          # Ensure that the value fell into a period
+          unless tou_period_assigned
+            @runner.registerError("Did not find a TOU period covering #{time} on #{date}, kWh will not be included in any TOU period.")
+          end
+        end
+        # Register values for any time-of-use period with kWh
+        dist_clg_tou_vals.each do |tou_pd_id, joules_in_pd|
+          gj_in_pd = OpenStudio.convert(joules_in_pd, 'J', 'GJ').get
+          kwh_in_pd = OpenStudio.convert(joules_in_pd, 'J', 'kWh').get
+          @runner.registerValue("annual_consumption_district_cooling_tou_#{tou_pd_id}", gj_in_pd, 'GJ')
+          @runner.registerInfo("TOU period #{tou_pd_id} annual district cooling consumption = #{kwh_in_pd} kWh.")
+        end
+      else
+        # If TOU periods were specified but this model has no district cooling, report zeroes
+        if electricity_consumption_tou_periods.size > 0
+          # Get the TOU ids
+          tou_ids = []
+          electricity_consumption_tou_periods.each do |tou_pd|
+            tou_ids << tou_pd['tou_id']
+          end
+          tou_ids.uniq.each do |tou_id|
+            @runner.registerValue("annual_consumption_district_cooling_tou_#{tou_id}", 0.0, 'GJ')
+          end
+        end
+      end
+
     else
       @runner.registerError('Could not find an annual run period')
       return OpenStudio::Attribute.new('report', result_elems)

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

@@ -283,7 +283,12 @@ module OsLib_Constructions
     # create info message
     if !runner.nil? # todo - need to look for bad visible transmittance here
       uFactorSiToIpConversion = OpenStudio.convert(material.uFactor, 'W/m^2*K', 'Btu/ft^2*h*R').get
-      runner.registerInfo("Created #{construction.name} construction. U-factor: #{OpenStudio.toNeatString(uFactorSiToIpConversion, 2, true)}(Btu/ft^2*h*R), SHGC: #{material.getSolarHeatGainCoefficient}, VT: #{material.getVisibleTransmittance.get}.")
+      # version check to support 2.x and 3.x
+      if Gem::Version.new(OpenStudio::openStudioVersion) > Gem::Version.new("2.9.1")
+        runner.registerInfo("Created #{construction.name} construction. U-factor: #{OpenStudio.toNeatString(uFactorSiToIpConversion, 2, true)}(Btu/ft^2*h*R), SHGC: #{material.solarHeatGainCoefficient}, VT: #{material.getVisibleTransmittance.get}.")
+      else
+        runner.registerInfo("Created #{construction.name} construction. U-factor: #{OpenStudio.toNeatString(uFactorSiToIpConversion, 2, true)}(Btu/ft^2*h*R), SHGC: #{material.getSolarHeatGainCoefficient}, VT: #{material.getVisibleTransmittance.get}.")
+      end
     end
 
     result = construction