urbanopt-scenario 0.1.0 → 0.1.1

data/docs/package.json

@@ -17,6 +17,10 @@
     "webpack-dev-middleware": "^3.6.0"
   },
   "devDependencies": {
-    "gh-pages": "^2.0.1"
+    "braces": ">=2.3.1",
+    "gh-pages": "^2.0.1",
+    "js-yaml": ">=3.13.1",
+    "serialize-javascript": ">=2.1.1",
+    "set-value": ">=2.0.1"
   }
 }

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 = 'URBANopt'
+repo = 'urbanopt-scenario-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/measures/default_feature_reports/measure.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -576,10 +576,21 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     end
 
     # timeseries we want to report
-    requested_timeseries_names = ['Electricity:Facility', 'ElectricityProduced:Facility', 'Gas:Facility',
-                                  'DistrictCooling:Facility', 'DistrictHeating:Facility', 'District Cooling Chilled Water Rate',
-                                  'District Cooling Mass Flow Rate', 'District Cooling Inlet Temperature', 'District Cooling Outlet Temperature',
-                                  'District Heating Hot Water Rate', 'District Heating Mass Flow Rate', 'District Heating Inlet Temperature', 'District Heating Outlet Temperature']
+    requested_timeseries_names = [
+      'Electricity:Facility',
+      'ElectricityProduced:Facility',
+      'Gas:Facility',
+      'DistrictCooling:Facility',
+      'DistrictHeating:Facility',
+      'District Cooling Chilled Water Rate',
+      'District Cooling Mass Flow Rate',
+      'District Cooling Inlet Temperature',
+      'District Cooling Outlet Temperature',
+      'District Heating Hot Water Rate',
+      'District Heating Mass Flow Rate',
+      'District Heating Inlet Temperature',
+      'District Heating Outlet Temperature'
+    ]
 
     # number of values in each timeseries
     n = nil

data/lib/measures/default_feature_reports/tests/default_feature_reports_test.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt-scenario.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/scenario.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/scenario/default_reports.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/scenario/default_reports/construction_cost.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/scenario/default_reports/date.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/scenario/default_reports/distributed_generation.rb

@@ -0,0 +1,187 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+require 'json'
+require 'urbanopt/scenario/default_reports/solar_pv'
+require 'urbanopt/scenario/default_reports/wind'
+require 'urbanopt/scenario/default_reports/generator'
+require 'urbanopt/scenario/default_reports/storage'
+require 'json-schema'
+
+module URBANopt
+  module Scenario
+    module DefaultReports
+      ##
+      # Onsite distributed generation system (i.e. SolarPV, Wind, Storage, Generator) design attributes and financial metrics.
+      ##
+      class DistributedGeneration
+        ##
+        # _Float_ - Lifecycle costs for the complete distributed generation system in US Dollars
+        #
+        attr_accessor :lcc_us_dollars
+
+        ##
+        # _Float_ - Net present value of the complete distributed generation system in US Dollars
+        #
+        attr_accessor :npv_us_dollars
+
+        ##
+        # _Float_ - Total amount paid for utility energy in US Dollars in the first year of operation
+        #
+        attr_accessor :year_one_energy_cost_us_dollars
+
+        ##
+        # _Float_ - Total amount paid in utility demand charges in US Dollars in the first year of operation
+        #
+        attr_accessor :year_one_demand_cost_us_dollars
+
+        ##
+        # _Float_ - Total amount paid to the utility in US Dollars in the first year of operation
+        #
+        attr_accessor :year_one_bill_us_dollars
+
+        ##
+        # _Float_ - Total amount paid to the utility in US Dollars over the life of the system
+        #
+        attr_accessor :total_energy_cost_us_dollars
+
+        ##
+        # _SolarPV_ - Installed \solar PV attributes
+        #
+        attr_accessor :solar_pv
+
+        ##
+        # _Wind_ -  Installed \wind attributes
+        #
+        attr_accessor :wind
+
+        ##
+        # _Generator_ - Installed \generator attributes
+        #
+        attr_accessor :generator
+
+        ##
+        # _Storage_ - Installed \storage attributes
+        #
+        attr_accessor :storage
+
+        ##
+        # Initialize distributed generation system design and financial metrics.
+        #
+        # * Technologies include +:solar_pv+, +:wind+, +:generator+, and +:storage+.
+        # * Financial metrics include +:lcc_us_dollars+, +:npv_us_dollars+, +:year_one_energy_cost_us_dollars+, +:year_one_demand_cost_us_dollars+,
+        # +:year_one_bill_us_dollars+, and +:total_energy_cost_us_dollars+
+        ##
+        # [parameters:]
+        #
+        # * +hash+ - _Hash_ - A hash containting key/value pairs for the distributed generation system attributes listed above.
+        #
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+
+          @lcc_us_dollars = hash[:lcc_us_dollars]
+          @npv_us_dollars = hash[:npv_us_dollars]
+          @year_one_energy_cost_us_dollars = hash[:year_one_energy_cost_us_dollars]
+          @year_one_demand_cost_us_dollars = hash[:year_one_demand_cost_us_dollars]
+          @year_one_bill_us_dollars = hash[:year_one_bill_us_dollars]
+          @total_energy_cost_us_dollars = hash[:total_energy_cost_us_dollars]
+
+          @solar_pv = SolarPV.new(hash[:solar_pv] || {})
+          @wind = Wind.new(hash[:wind] || {})
+          @generator = Generator.new(hash[:generator] || {})
+          @storage = Storage.new(hash[:storage] || {})
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+
+          # initialize @@logger
+          @@logger ||= URBANopt::Scenario::DefaultReports.logger
+        end
+
+        ##
+        # Convert to a Hash equivalent for JSON serialization
+        ##
+        def to_hash
+          result = {}
+
+          result[:lcc_us_dollars] = @lcc_us_dollars if @lcc_us_dollars
+          result[:npv_us_dollars] = @npv_us_dollars if @npv_us_dollars
+          result[:year_one_energy_cost_us_dollars] = @year_one_energy_cost_us_dollars if @year_one_energy_cost_us_dollars
+          result[:year_one_demand_cost_us_dollars] = @year_one_demand_cost_us_dollars if @year_one_demand_cost_us_dollars
+          result[:year_one_bill_us_dollars] = @year_one_bill_us_dollars if @year_one_bill_us_dollars
+          result[:total_energy_cost_us_dollars] = @total_energy_cost_us_dollars if @total_energy_cost_us_dollars
+          result[:solar_pv] = @solar_pv.to_hash if @solar_pv
+          result[:wind] = @wind.to_hash if @wind
+          result[:generator] = @generator.to_hash if @generator
+          result[:storage] = @storage.to_hash if @storage
+
+          return result
+        end
+
+        ### get keys ...not needed
+        # def self.get_all_keys(h)
+        #   h.each_with_object([]){|(k,v),a| v.is_a?(Hash) ? a.push(k,*get_all_keys(v)) : a << k }
+        # end
+
+        ##
+        # Add up old and new values
+        ##
+        def self.add_values(existing_value, new_value) #:nodoc:
+          if existing_value && new_value
+            existing_value += new_value
+          elsif new_value
+            existing_value = new_value
+          end
+          return existing_value
+        end
+
+        ##
+        # Merge a distributed generation system with a new system
+        ##
+        def self.merge_distributed_generation(existing_dgen, new_dgen)
+          existing_dgen.lcc_us_dollars = add_values(existing_dgen.lcc_us_dollars, new_dgen.lcc_us_dollars)
+          existing_dgen.npv_us_dollars = add_values(existing_dgen.npv_us_dollars, new_dgen.npv_us_dollars)
+          existing_dgen.year_one_energy_cost_us_dollars = add_values(existing_dgen.year_one_energy_cost_us_dollars, new_dgen.year_one_energy_cost_us_dollars)
+          existing_dgen.year_one_demand_cost_us_dollars = add_values(existing_dgen.year_one_demand_cost_us_dollars, new_dgen.year_one_demand_cost_us_dollars)
+          existing_dgen.year_one_bill_us_dollars = add_values(existing_dgen.year_one_bill_us_dollars, new_dgen.year_one_bill_us_dollars)
+          existing_dgen.total_energy_cost_us_dollars = add_values(existing_dgen.total_energy_cost_us_dollars, new_dgen.total_energy_cost_us_dollars)
+
+          existing_dgen.solar_pv = SolarPV.add_pv existing_dgen.solar_pv, new_dgen.solar_pv
+          existing_dgen.wind = Wind.add_wind existing_dgen.wind, new_dgen.wind
+          existing_dgen.generator = Generator.add_generator existing_dgen.generator, new_dgen.generator
+          existing_dgen.storage = Storage.add_storage existing_dgen.storage, new_dgen.storage
+
+          return existing_dgen
+        end
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/default_reports/end_use.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/scenario/default_reports/end_uses.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/scenario/default_reports/feature_report.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -34,6 +34,8 @@ require 'urbanopt/scenario/default_reports/location'
 require 'urbanopt/scenario/default_reports/reporting_period'
 require 'urbanopt/scenario/default_reports/timeseries_csv'
 require 'urbanopt/scenario/default_reports/validator'
+require 'urbanopt/scenario/default_reports/distributed_generation'
+
 require 'json-schema'
 
 require 'json'
@@ -50,7 +52,7 @@ module URBANopt
       ##
       class FeatureReport
         attr_accessor :id, :name, :directory_name, :feature_type, :timesteps_per_hour, :simulation_status,
-                      :timeseries_csv, :location, :program, :design_parameters, :construction_costs, :reporting_periods # :nodoc:
+                      :timeseries_csv, :location, :program, :design_parameters, :construction_costs, :reporting_periods, :distributed_generation # :nodoc:
         ##
         # Each FeatureReport object corresponds to a single Feature.
         ##
@@ -82,6 +84,8 @@ module URBANopt
             @reporting_periods << ReportingPeriod.new(rp)
           end
 
+          @distributed_generation = DistributedGeneration.new(hash[:distributed_generation] || {})
+
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
           @@schema ||= @@validator.schema
@@ -194,6 +198,8 @@ module URBANopt
           result[:reporting_periods] = []
           @reporting_periods.each { |rp| result[:reporting_periods] << rp.to_hash }
 
+          result[:distributed_generation] = @distributed_generation.to_hash if @distributed_generation
+
           # validate feature_report properties against schema
           if @@validator.validate(@@schema[:definitions][:FeatureReport][:properties], result).any?
             raise "feature_report properties does not match schema: #{@@validator.validate(@@schema[:definitions][:FeatureReport][:properties], result)}"