urbanopt-scenario 0.1.0 → 0.1.1

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

@@ -0,0 +1,105 @@
+# *********************************************************************************
+# 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 'json-schema'
+
+module URBANopt
+  module Scenario
+    module DefaultReports
+      ##
+      # Onsite storage system attributes
+      ##
+      class Storage
+        ##
+        # _Float_ - power capacity in kilowatts
+        #
+        attr_accessor :size_kw
+
+        ##
+        # _Float_ - storage capacity in kilowatt-hours
+        #
+        attr_accessor :size_kwh
+
+        ##
+        # Initialize Storage attributes from a hash. Storage attributes currently are limited to power and storage capacity.
+        ##
+        # [parameters:]
+        #
+        # * +hash+ - _Hash_ - A hash containting +:size_kw+ and +:size_kwh+ key/value pair which represents the power and storage capacity in kilowatts (kW) and kilowatt-hours respectively.
+        #
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+
+          @size_kw = hash[:size_kw]
+          @size_kwh = hash[:size_kwh]
+
+          # 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[:size_kw] = @size_kw if @size_kw
+          result[:size_kwh] = @size_kwh if @size_kwh
+
+          return result
+        end
+
+        ##
+        # Merge Storage systems
+        ##
+        def self.add_storage(existing_storage, new_storage)
+          if existing_storage.size_kw.nil?
+            existing_storage.size_kw = new_storage.size_kw
+          else
+            existing_storage.size_kw = (existing_storage.size_kw || 0) + (new_storage.size_kw || 0)
+          end
+
+          if existing_storage.size_kw.nil?
+            existing_storage.size_kwh = new_storage.size_kwh
+          else
+            existing_storage.size_kwh = (existing_storage.size_kwh || 0) + (new_storage.size_kwh || 0)
+          end
+
+          return existing_storage
+        end
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/default_reports/timeseries_csv.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,
@@ -115,6 +115,28 @@ module URBANopt
           return result
         end
 
+        ##
+        # Reloads data from the CSV file.
+        ##
+        def reload_data(new_data)
+          @mutex.synchronize do
+            @data = {}
+            @column_names = []
+            new_data.each do |row|
+              if @column_names.empty?
+                @column_names = row
+                @column_names.each do |column_name|
+                  @data[column_name] = []
+                end
+              else
+                row.each_with_index do |value, i|
+                  @data[@column_names[i]] << value.to_f
+                end
+              end
+            end
+          end
+        end
+
         ##
         # Loads data from the CSV file.
         ##
@@ -156,10 +178,13 @@ module URBANopt
         # [parameters:]
         # +path+ - _String_ - The path of the scenario report CSV (default_scenario_report.csv).
         ##
-        def save_data(path)
+        def save_data(path = nil)
+          if path.nil?
+            path = @path
+          end
           File.open(path, 'w') do |f|
             f.puts @column_names.join(',')
-            n = @data[@column_names[0]].size
+            n = @data[@column_names[0]].size - 1
 
             (0..n).each do |i|
               line = []
@@ -188,8 +213,6 @@ module URBANopt
         # +other+ - _TimeseriesCSV_ - An object of TimeseriesCSV class.
         ##
         def add_timeseries_csv(other)
-          @path = other.path
-
           # initialize first_report_datetime with the incoming first_report_datetime if its nil.
           if @first_report_datetime.nil?
             @first_report_datetime = other.first_report_datetime
@@ -205,6 +228,10 @@ module URBANopt
 
           # merge the column data
           other.column_names.each do |column_name|
+            if !@column_names.include? column_name
+              @column_names.push column_name
+            end
+
             new_values = other.get_data(column_name)
 
             if @data.nil?

data/lib/urbanopt/scenario/default_reports/validator.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,
@@ -36,7 +36,7 @@ module URBANopt
       class Validator
         @@schema = nil
 
-        # initialize the root directory
+        # Initialize the root directory
         def initialize
           super
 

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

@@ -0,0 +1,92 @@
+# *********************************************************************************
+# 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 'json-schema'
+
+module URBANopt
+  module Scenario
+    module DefaultReports
+      ##
+      # Onsite wind system attributes
+      ##
+      class Wind
+        ##
+        # _Float_ - power capacity in kilowatts
+        #
+        attr_accessor :size_kw
+
+        ##
+        # Initialize Wind attributes from a hash. Wind attributes currently are limited to power capacity.
+        ##
+        # [parameters:]
+        #
+        # * +hash+ - _Hash_ - A hash containting a +:size_kw+ key/value pair which represents the nameplate capacity in kilowatts (kW)
+        #
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+
+          @size_kw = hash[:size_kw]
+
+          # 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[:size_kw] = @size_kw if @size_kw
+
+          return result
+        end
+
+        ##
+        # Merge Wind systems
+        ##
+        def self.add_wind(existing_wind, new_wind)
+          if existing_wind.size_kw.nil? && new_wind.size_kw.nil?
+            existing_wind.size_kw = nil
+          else
+            existing_wind.size_kw = (existing_wind.size_kw || 0) + (new_wind.size_kw || 0)
+          end
+
+          return existing_wind
+        end
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/extension.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/logger.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/scenario_base.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/scenario_csv.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/scenario_datapoint_base.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/scenario_post_processor_base.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/scenario_post_processor_default.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,
@@ -46,10 +46,9 @@ module URBANopt
       # +scenario_base+ - _ScenarioBase_ - An object of ScenarioBase class.
       def initialize(scenario_base)
         super(scenario_base)
-        @scenario_result = URBANopt::Scenario::DefaultReports::ScenarioReport.new
-        @scenario_result.id = scenario_base.name
-        @scenario_result.name = scenario_base.name
-        @scenario_result.directory_name = scenario_base.run_dir
+
+        initialization_hash = { directory_name: scenario_base.run_dir, name: scenario_base.name, id: scenario_base.name }
+        @scenario_result = URBANopt::Scenario::DefaultReports::ScenarioReport.new(initialization_hash)
 
         @@logger ||= URBANopt::Scenario::DefaultReports.logger
       end
@@ -87,7 +86,9 @@ module URBANopt
       ##
       # Save scenario result
       ##
-      def save
+      # [parameters:]
+      # +file_name+ - _String_ - Assign a name to the saved scenario results file
+      def save(file_name = 'default_scenario_report')
         @scenario_result.save
 
         return @scenario_result

data/lib/urbanopt/scenario/scenario_runner_base.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/scenario_runner_osw.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/simulation_dir_base.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/simulation_dir_osw.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/simulation_mapper_base.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/version.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,
@@ -30,6 +30,6 @@
 
 module URBANopt
   module Scenario
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.1.1'.freeze
   end
 end

data/urbanopt-scenario-gem.gemspec

@@ -31,6 +31,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'openstudio-model-articulation', '~> 0.1.0'
   spec.add_dependency 'urbanopt-core', '~> 0.1.0'
 
+  spec.add_dependency 'github_api'
+
   # lock the version of these dependencies due to using older version of Ruby.
   spec.add_dependency 'public_suffix', '3.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-scenario
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dan Macumber
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-30 00:00:00.000000000 Z
+date: 2020-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: github_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: public_suffix
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +143,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CONTRIBUTING.md"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".rdoc_options"
 - ".rspec"
@@ -160,6 +178,7 @@ files:
 - docs/package-lock.json
 - docs/package.json
 - docs/schemas/scenario-schema.md
+- lib/change_log.rb
 - lib/measures/.rubocop.yml
 - lib/measures/default_feature_reports/LICENSE.md
 - lib/measures/default_feature_reports/README.md
@@ -174,9 +193,11 @@ files:
 - lib/urbanopt/scenario/default_reports.rb
 - lib/urbanopt/scenario/default_reports/construction_cost.rb
 - lib/urbanopt/scenario/default_reports/date.rb
+- lib/urbanopt/scenario/default_reports/distributed_generation.rb
 - lib/urbanopt/scenario/default_reports/end_use.rb
 - lib/urbanopt/scenario/default_reports/end_uses.rb
 - lib/urbanopt/scenario/default_reports/feature_report.rb
+- lib/urbanopt/scenario/default_reports/generator.rb
 - lib/urbanopt/scenario/default_reports/location.rb
 - lib/urbanopt/scenario/default_reports/logger.rb
 - lib/urbanopt/scenario/default_reports/program.rb
@@ -185,8 +206,11 @@ files:
 - lib/urbanopt/scenario/default_reports/schema/README.md
 - lib/urbanopt/scenario/default_reports/schema/scenario_csv_columns.txt
 - lib/urbanopt/scenario/default_reports/schema/scenario_schema.json
+- lib/urbanopt/scenario/default_reports/solar_pv.rb
+- lib/urbanopt/scenario/default_reports/storage.rb
 - lib/urbanopt/scenario/default_reports/timeseries_csv.rb
 - lib/urbanopt/scenario/default_reports/validator.rb
+- lib/urbanopt/scenario/default_reports/wind.rb
 - lib/urbanopt/scenario/extension.rb
 - lib/urbanopt/scenario/logger.rb
 - lib/urbanopt/scenario/scenario_base.rb