urbanopt-reporting 0.5.0 → 0.6.2

data/lib/urbanopt/reporting/default_reports/solar_pv.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -52,7 +52,7 @@ module URBANopt
         # _Float_ - power capacity in kilowatts
         #
         attr_accessor :size_kw
-        attr_accessor :location
+        attr_accessor :location, :tilt, :azimuth, :module_type
 
         ##
         # Initialize SolarPV attributes from a hash. Solar PV attributes currently are limited to power capacity.
@@ -67,6 +67,39 @@ module URBANopt
           @size_kw = hash[:size_kw]
           @id = hash[:id]
           @location = hash[:location]
+          @approx_area_m2 = 0
+
+          if hash[:azimuth]
+            @azimuth = hash[:azimuth]
+          end
+          if hash[:tilt]
+            @tilt = hash[:tilt]
+          end
+          if hash[:module_type]
+            @module_type = hash[:module_type]
+
+            # calculate area with PVWatts formulas
+            # Size (kW) = Array Area (m²) × 1 kW/m² × Module Efficiency (%)
+            # also grab module efficiency: 0 (standard) = 15%, 1 (premium) = 19%, 2 (thin film) = 10%
+            eff = 0
+            case @module_type
+            when 0
+              eff = 0.15
+            when 1
+              eff = 0.19
+            when 2
+              eff = 0.10
+            end
+            if @size_kw != 0
+              @approx_area_m2 = (@size_kw / eff).round(3)
+            end
+          end
+          if hash[:gcr]
+            @gcr = hash[:gcr]
+          end
+          if hash[:average_yearly_energy_produced_kwh]
+            @annual_energy_produced = hash[:average_yearly_energy_produced_kwh]
+          end
 
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
@@ -84,6 +117,12 @@ module URBANopt
 
           result[:size_kw] = @size_kw if @size_kw
           result[:location] = @location if @location
+          result[:azimuth] = @azimuth if @azimuth
+          result[:tilt] = @tilt if @tilt
+          result[:module_type] = @module_type if @module_type
+          result[:approximate_area_m2] = @approx_area_m2 if @approx_area_m2
+          result[:gcr] = @gcr if @gcr
+          result[:average_yearly_energy_produced_kwh] = @annual_energy_produced if @annual_energy_produced
 
           return result
         end
@@ -97,7 +136,7 @@ module URBANopt
           else
             existing_pv.size_kw = (existing_pv.size_kw || 0) + (new_pv.size_kw || 0)
           end
-
+          # KAF: todo, recalculate area?
           return existing_pv
         end
       end

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/reporting/default_reports/thermal_storage.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/reporting/default_reports/timeseries_csv.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/reporting/default_reports/validator.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/reporting/default_reports/wind.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -51,7 +51,7 @@ module URBANopt
         ##
         # _Float_ - power capacity in kilowatts
         #
-        attr_accessor :size_kw
+        attr_accessor :size_kw, :average_yearly_energy_produced_kwh, :size_class
 
         ##
         # Initialize Wind attributes from a hash. Wind attributes currently are limited to power capacity.
@@ -64,6 +64,8 @@ module URBANopt
           hash.delete_if { |k, v| v.nil? }
 
           @size_kw = hash[:size_kw]
+          @avg_energy_kwh = hash[:average_yearly_energy_produced_kwh]
+          @size_class = hash[:size_class]
 
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
@@ -80,6 +82,8 @@ module URBANopt
           result = {}
 
           result[:size_kw] = @size_kw if @size_kw
+          result[:average_yearly_energy_produced_kwh] = @avg_energy_kwh if @avg_energy_kwh
+          result[:size_class] = @size_class if @size_class
 
           return result
         end
@@ -93,6 +97,11 @@ module URBANopt
           else
             existing_wind.size_kw = (existing_wind.size_kw || 0) + (new_wind.size_kw || 0)
           end
+          if existing_wind.average_yearly_energy_produced_kwh.nil? && new_wind.average_yearly_energy_produced_kwh.nil?
+            existing_wind.average_yearly_energy_produced_kwh = nil
+          else
+            existing_wind.average_yearly_energy_produced_kwh = (existing_wind.average_yearly_energy_produced_kwh || 0) + (new_wind.average_yearly_energy_produced_kwh || 0)
+          end
 
           return existing_wind
         end

data/lib/urbanopt/reporting/default_reports.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/reporting/derived_extension.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, 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/reporting/version.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,
@@ -40,6 +40,6 @@
 
 module URBANopt
   module Reporting
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.2'.freeze
   end
 end

data/lib/urbanopt/reporting.rb

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

data/urbanopt-reporting-gem.gemspec

@@ -26,6 +26,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>= 2.1.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'simplecov', '~> 0.18.2'
+  spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
+
   spec.add_runtime_dependency 'json_pure', '~> 2.3'
   spec.add_runtime_dependency 'json-schema', '~> 2.8'
   spec.add_runtime_dependency 'openstudio-extension', '~> 0.5.1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-reporting
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Rawad El Kontar
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2022-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,6 +53,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: json_pure
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +134,7 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/pull_request_template.md"
+- ".github/workflows/nightly_build.yml"
 - ".gitignore"
 - ".rdoc_options"
 - ".rubocop.yml"
@@ -174,6 +203,7 @@ files:
 - lib/urbanopt/reporting/default_reports/power_distribution.rb
 - lib/urbanopt/reporting/default_reports/program.rb
 - lib/urbanopt/reporting/default_reports/reporting_period.rb
+- lib/urbanopt/reporting/default_reports/scenario_power_distribution.rb
 - lib/urbanopt/reporting/default_reports/scenario_report.rb
 - lib/urbanopt/reporting/default_reports/schema/README.md
 - lib/urbanopt/reporting/default_reports/schema/scenario_csv_columns.txt