openstudio-extension 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3faa07577e5a2980e7cacc747e5fb9f3ceb5cdb7
-  data.tar.gz: b4e220c8aca2e0227e65866ded3d1af1b7b19958
+SHA256:
+  metadata.gz: 4d0b42ef4c9c5ee88e2e750956e7147ec1971614d9bc46b0f8926332937aabbb
+  data.tar.gz: 2177f877389dcc3587c575f361d10d0228269d875c59f22ba7f03bd5fa829d06
 SHA512:
-  metadata.gz: 23ec9c229a5618bc27932844884998bb41fac6f57c5753d2d79f2c2702652e37e7836d42e75e9f3c78a2e0321729284fec4a012e80995dee89359f3b7a7fa440
-  data.tar.gz: da121f8ec77b913ec6d61c528ffb78841ec645dcd0fb7b126df4668f87f3df74e56f7ef8bf9068d6b81b4e02ae4aa17922a9d33abba4fc94a52dc509cae28ff3
+  metadata.gz: a6796c88ae5bdd6a269377c4d9845421aa36318f60297dc55bba600f4ebc83143f0ed21fbae5d6ea0c1c05be3363dfdc97f4109866959070fb86dcbe27174dbe
+  data.tar.gz: a96dd4fc093da1528f39b4401b0cab6a0ca195877dd979ace7e285fdb83674b19885a901f5df8d18c77a3a37a19f40a4683bbdf82e3181df4e575bb92dec97b5

data/CHANGELOG.md

@@ -1,12 +1,11 @@
 # OpenStudio Extension Gem
 
-## Version 0.1.6
+## Version 0.2.0
 
-* 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
+* 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)
 
 ## Version 0.1.4
 

data/Gemfile

@@ -2,5 +2,3 @@ source 'http://rubygems.org'
 
 # Specify your gem's dependencies in openstudio-extension.gemspec
 gemspec
-
-gem 'simplecov', github: 'NREL/simplecov'

data/Jenkinsfile

@@ -5,6 +5,6 @@
 // Build for PR to develop branch only. 
 if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) { // check if set
 
-  openstudio_extension_gems()
+  openstudio_extension_gems_3_x()
     
 }

data/README.md

@@ -150,7 +150,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,11 +235,22 @@ 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/lib/change_log.rb

@@ -0,0 +1,147 @@
+#!/usr/bin/env ruby
+
+require 'github_api'
+require 'date'
+require 'optparse'
+require 'optparse/date'
+
+# Instructions:
+#   Get a token from github's settings (https://github.com/settings/tokens)
+#
+# Example:
+#   ruby change_log.rb -t abcdefghijklmnopqrstuvwxyz -s 2017-09-06
+#
+
+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 ""
+
+  # defaults, go back 90 days
+  options[:start_date] = Date.today - 90
+  options[:end_date] = Date.today
+
+  opts.on('-s', '--start-date [DATE]', Date, 'Start of data (e.g. 2017-09-06)') do |v|
+    options[:start_date] = v
+  end
+  opts.on('-e', '--end-date [DATE]', Date, 'End of data (e.g. 2017-09-13)') do |v|
+    options[:end_date] = v
+  end
+  opts.on('-t', '--token [String]', String, 'Github API Token') do |v|
+    options[:token] = v
+  end
+end.parse!
+
+# Convert dates to time objects
+options[:start_date] = Time.parse(options[:start_date].to_s)
+options[:end_date] = Time.parse(options[:end_date].to_s)
+puts options
+
+### Repository options
+repo_owner = 'NREL'
+repo = 'openstudio-extension-gem'
+
+github = Github.new
+if options[:token]
+  puts 'Using github token'
+  github = Github.new oauth_token: options[:token]
+end
+
+total_open_issues = []
+total_open_pull_requests = []
+new_issues = []
+closed_issues = []
+accepted_pull_requests = []
+
+def get_num(issue)
+  issue.html_url.split('/')[-1].to_i
+end
+
+def get_issue_num(issue)
+  "\##{get_num(issue)}"
+end
+
+def get_html_url(issue)
+  issue.html_url
+end
+
+def get_title(issue)
+  issue.title
+end
+
+def print_issue(issue)
+  is_feature = false
+  issue.labels.each { |label| is_feature = true if label.name == 'Feature Request' }
+
+  if is_feature
+    "- Improved [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
+  else
+    "- Fixed [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
+  end
+end
+
+# Process Open Issues
+results = -1
+page = 1
+while results != 0
+  resp = github.issues.list user: repo_owner, repo: repo, sort: 'created', direction: 'asc',
+                            state: 'open', per_page: 100, page: page
+  results = resp.length
+  resp.env[:body].each do |issue, _index|
+    created = Time.parse(issue.created_at)
+    if !issue.key?(:pull_request)
+      total_open_issues << issue
+      if created >= options[:start_date] && created <= options[:end_date]
+        new_issues << issue
+      end
+    else
+      total_open_pull_requests << issue
+    end
+  end
+
+  page += 1
+end
+
+# Process Closed Issues
+results = -1
+page = 1
+while results != 0
+  resp = github.issues.list user: repo_owner, repo: repo, sort: 'created', direction: 'asc',
+                            state: 'closed', per_page: 100, page: page
+  results = resp.length
+  resp.env[:body].each do |issue, _index|
+    created = Time.parse(issue.created_at)
+    closed = Time.parse(issue.closed_at)
+    if !issue.key?(:pull_request)
+      if created >= options[:start_date] && created <= options[:end_date]
+        new_issues << issue
+      end
+      if closed >= options[:start_date] && closed <= options[:end_date]
+        closed_issues << issue
+      end
+    elsif closed >= options[:start_date] && closed <= options[:end_date]
+      accepted_pull_requests << issue
+    end
+  end
+
+  page += 1
+end
+
+closed_issues.sort! { |x, y| get_num(x) <=> get_num(y) }
+new_issues.sort! { |x, y| get_num(x) <=> get_num(y) }
+accepted_pull_requests.sort! { |x, y| get_num(x) <=> get_num(y) }
+total_open_pull_requests.sort! { |x, y| get_num(x) <=> get_num(y) }
+
+puts "Total Open Issues: #{total_open_issues.length}"
+puts "Total Open Pull Requests: #{total_open_pull_requests.length}"
+puts "\nDate Range: #{options[:start_date].strftime('%m/%d/%y')} - #{options[:end_date].strftime('%m/%d/%y')}:"
+puts "\nNew Issues: #{new_issues.length} (" + new_issues.map { |issue| get_issue_num(issue) }.join(', ') + ')'
+
+puts "\nClosed Issues: #{closed_issues.length}"
+closed_issues.each { |issue| puts print_issue(issue) }
+
+puts "\nAccepted Pull Requests: #{accepted_pull_requests.length}"
+accepted_pull_requests.each { |issue| puts print_issue(issue) }
+
+puts "\nAll Open Issues: #{total_open_issues.length} (" + total_open_issues.map { |issue| get_issue_num(issue) }.join(', ') + ')'

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

@@ -45,23 +45,6 @@ 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,
@@ -70,8 +53,7 @@ module OsLib_CreateResults
                      start_hr = 14,
                      end_mo = 'September',
                      end_day = 30,
-                     end_hr = 18,
-                     electricity_consumption_tou_periods = [])
+                     end_hr = 18)
 
     # get the current version of OS being used to determine if sql query
     # changes are needed (for when E+ changes).
@@ -515,83 +497,6 @@ 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
@@ -682,88 +587,6 @@ 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)