urbanopt-reporting 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6205d1365f248754c777e239f169baa1afc044feb96395140bb8afb954870edb
-  data.tar.gz: 25aa3729072d869f6198b9988c9181430aa33cbeea1285b66e9b9e8b89306578
+  metadata.gz: eae158ffc7f5239454037c578719bc38263a2991b0597ea1654ff682c875dbf0
+  data.tar.gz: 83f93741c0f85426fd02132cc57c245b1f38967f1e4f02712447c8c0ad8e4ca6
 SHA512:
-  metadata.gz: 643acfe0c5894ebebcd342d0eaecb5574b09f30899b7276024058fdd8803677fdbae17a1109fd51805d6384da2869101f4b946760b1abb5073b56e52913e0b91
-  data.tar.gz: 7cdc12b353473ccce4cd1d8547fdd1ae9f90f8f5413818016ed40a44f88b28f1bb282cfcff4fcb2851bdc30db3ffafe95516c83d2c0827de23983f288565fe70
+  metadata.gz: ffcc7a5f81d1bc56569a74cfecfc14593125faacede9f5e52256a568392eec8cb0a8e02d0ba2ce4ae3f9d4d52f7d00cf60720f30d7d66b2a8d38dcef898e0cac
+  data.tar.gz: 685fcf61b239616865a48b4cdf1f3179f246b07fceeed4be9f240dee44eefba3fac32b4b52afeb564675873a5bef5eb72a60a3b64b411e151b21eb7b5423ba5b

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # URBANopt Reporting Gem
 
+## Version 0.1.1
+
+08/26/2020
+
+- Adding thermal storage reporting
+- Fix paths for reporting and scenario gems split
+
 ## Version 0.1.0
 
 08/17/2020

data/lib/measures/default_feature_reports/measure.rb

@@ -71,6 +71,11 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     feature_type.setDefaultValue('Building')
     args << feature_type
 
+    feature_location = OpenStudio::Measure::OSArgument.makeStringArgument('feature_location', false)
+    feature_location.setDisplayName('URBANopt Feature Location')
+    feature_location.setDefaultValue('0')
+    args << feature_location
+
     # make an argument for the frequency
     reporting_frequency_chs = OpenStudio::StringVector.new
     reporting_frequency_chs << 'Detailed'
@@ -193,6 +198,9 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
                        'District Heating Inlet Temperature', 'District Heating Outlet Temperature', 'Cooling Coil Total Cooling Rate',
                        'Heating Coil Heating Rate']
 
+    tes_timeseries_data = ['Ice Thermal Storage End Fraction', 'Cooling coil Ice Thermal Storage End Fraction']
+    timeseries_data += tes_timeseries_data
+
     timeseries_data.each do |ts|
       result << OpenStudio::IdfObject.load("Output:Variable,*,#{ts},#{reporting_frequency};").get
     end
@@ -254,6 +262,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     feature_id = runner.getStringArgumentValue('feature_id', user_arguments)
     feature_name = runner.getStringArgumentValue('feature_name', user_arguments)
     feature_type = runner.getStringArgumentValue('feature_type', user_arguments)
+    feature_location = runner.getStringArgumentValue('feature_location', user_arguments)
 
     # Assign the user inputs to variables
     reporting_frequency = runner.getStringArgumentValue('reporting_frequency', user_arguments)
@@ -318,13 +327,16 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     # Get Location information and store in the feature_report
     ##
 
-    # latitude
-    latitude = epw_file.latitude
-    feature_report.location.latitude = latitude
-
-    # longitude
-    longitude = epw_file.longitude
-    feature_report.location.longitude = longitude
+    if feature_location.include? '['
+      # get latitude from feature_location
+      latitude = (feature_location.split(',')[0].delete! '[]').to_f
+      # get longitude from feature_location
+      longitude = (feature_location.split(',')[1].delete! '[]').to_f
+      # latitude
+      feature_report.location.latitude = latitude
+      # longitude
+      feature_report.location.longitude = longitude
+    end
 
     # surface_elevation
     elev = sql_query(runner, sql_file, 'InputVerificationandResultsSummary', "TableName='General' AND RowName='Elevation' AND ColumnName='Value'")
@@ -332,6 +344,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
 
     ##########################################################################
     ##
+
     # Get program information and store in the feature_report
     ##
 
@@ -475,6 +488,39 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     total_construction_cost = sql_query(runner, sql_file, 'Life-Cycle Cost Report', "TableName='Present Value for Recurring, Nonrecurring and Energy Costs (Before Tax)' AND RowName='LCC_MAT - BUILDING - LIFE CYCLE COSTS' AND ColumnName='Cost'")
     feature_report.program.total_construction_cost = total_construction_cost
 
+    # packaged thermal storage capacities by cooling coil
+    ptes_keys = sql_file.availableKeyValues('RUN Period 1', 'Zone Timestep', 'Cooling Coil Ice Thermal Storage End Fraction')
+    if ptes_keys.empty?
+      ptes_size = nil
+      runner.registerWarning('Query failed for Packaged Ice Thermal Storage Capacity')
+    else
+      begin
+        ptes_size = 0
+        ptes_keys.each do |pk|
+          ptes_size += sql_query(runner, sql_file, 'ComponentSizingSummary', "TableName='Coil:Cooling:DX:SingleSpeed:ThermalStorage' AND RowName='#{pk}' AND ColumnName='Ice Storage Capacity'").to_f
+        end
+        ptes_size = convert_units(ptes_size, 'GJ', 'kWh')
+      rescue StandardError
+        runner.registerWarning('Query ptes_size.get failed')
+      end
+    end
+    feature_report.thermal_storage.ptes_size = ptes_size
+
+    # get the central tank thermal storage capacity
+    its_size = nil
+    its_size_index = sql_file.execAndReturnFirstDouble("SELECT ReportVariableDataDictionaryIndex FROM ReportVariableDataDictionary WHERE VariableName='Ice Thermal Storage Capacity'")
+    if its_size_index.empty?
+      runner.registerWarning('Query failed for Ice Thermal Storage Capacity')
+    else
+      begin
+        its_size = sql_file.execAndReturnFirstDouble("SELECT VariableValue FROM ReportVariableData WHERE ReportVariableDataDictionaryIndex=#{its_size_index}").get
+        its_size = convert_units(its_size.to_f, 'GJ', 'kWh')
+      rescue StandardError
+        runner.registerWarning('Query its_size.get failed')
+      end
+    end
+    feature_report.thermal_storage.its_size = its_size
+
     ############################################################################
     ##
     # Get Reporting Periods information and store in the feature_report
@@ -669,6 +715,10 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     powerTimeseries = ['Net Electric Energy', 'Electricity:Facility Power', 'ElectricityProduced:Facility Power', 'Electricity:Facility Apparent Power', 'ElectricityProduced:Facility Apparent Power', 'Net Power', 'Net Apparent Power']
     requested_timeseries_names += powerTimeseries
 
+    # add additional thermal storage timeseries
+    tesTimeseries = ['Ice Thermal Storage End Fraction', 'Cooling Coil Ice Thermal Storage End Fraction']
+    requested_timeseries_names += tesTimeseries
+
     # register info all timeseries
     runner.registerInfo("All timeseries: #{requested_timeseries_names}")
 
@@ -870,6 +920,22 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         #   puts "units = #{new_unit}"
         # end
 
+        # thermal storage ice end fractions have multiple timeseries, aggregate into a single series with consistent name and use the average value at each timestep
+        if tesTimeseries.include? timeseries_name
+
+          # set up array if 1st key_value
+          if key_i == 0
+            runner.registerInfo("SETTING UP NEW ARRAY FOR: #{timeseries_name}")
+            tmpArray = Array.new(n, 1)
+          end
+
+          # add to array (keep min value at each timestep)
+          (0..(n - 1)).each do |ind|
+            tVal = values[key_cnt][ind].to_f
+            tmpArray[ind] = [tVal, tmpArray[ind]].min
+          end
+        end
+
         # comfort results usually have multiple timeseries (per zone), aggregate into a single series with consistent name and use worst value at each timestep
         if comfortTimeseries.include? timeseries_name
 

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

@@ -36,6 +36,7 @@ require_relative  'timeseries_csv'
 require_relative  'distributed_generation'
 require_relative  'power_distribution'
 require_relative  'validator'
+require_relative  'thermal_storage'
 
 require 'json-schema'
 require 'json'
@@ -52,7 +53,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, :distributed_generation, :power_distribution # :nodoc:
+                      :timeseries_csv, :location, :program, :design_parameters, :construction_costs, :reporting_periods, :distributed_generation, :power_distribution, :thermal_storage # :nodoc:
         ##
         # Each FeatureReport object corresponds to a single Feature.
         ##
@@ -88,6 +89,8 @@ module URBANopt
 
           @power_distribution = PowerDistribution.new(hash[:power_distribution])
 
+          @thermal_storage = ThermalStorage.new(hash[:thermal_storage])
+
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
           @@schema ||= @@validator.schema
@@ -108,6 +111,7 @@ module URBANopt
           hash[:reporting_periods] = []
           hash[:distributed_generation] = {}
           hash[:power_distribution] = {}
+          hash[:thermal_storage] = {}
           return hash
         end
 
@@ -209,6 +213,8 @@ module URBANopt
 
           result[:power_distribution] = @power_distribution.to_hash if @power_distribution
 
+          result[:thermal_storage] = @thermal_storage.to_hash if @thermal_storage
+
           # 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)}"

data/lib/urbanopt/reporting/default_reports/schema/scenario_csv_columns.txt

@@ -31,4 +31,6 @@ ElectricityProduced:Facility Power
 Electricity:Facility Apparent Power
 ElectricityProduced:Facility Apparent Power
 Net Power
-Net Apparent Power
+Net Apparent Power
+Ice Thermal Storage End Fraction
+Cooling Coil Ice Thermal Storage End Fraction

data/lib/urbanopt/reporting/default_reports/schema/scenario_schema.json

@@ -63,6 +63,9 @@
 				},
 				"distributed_generation": {
 					"$ref": "#/definitions/DistributedGeneration"
+				},
+				"thermal_storage": {
+					"$ref": "#/definitions/ThermalStorage"
 				}
 			},
 			"required": [
@@ -216,6 +219,9 @@
 				},
 				"power_distribution": {
 					"$ref": "#/definitions/PowerDistribution"
+				},
+				"thermal_storage": {
+					"$ref": "#/definitions/ThermalStorage"
 				}
 			},
 			"required": [
@@ -541,11 +547,11 @@
 			"type": "object",
 			"properties": {
 				"latitude": {
-					"description": "(deg)",
+					"description": "latitude for the centroid of the feature (deg)",
 					"type": "number"
 				},
 				"longitude": {
-					"description": "(deg)",
+					"description": "longitude for the centroid of the feature (deg)",
 					"type": "number"
 				},
 				"surface_elevation": {
@@ -852,6 +858,19 @@
 					"type": "number"
 				}
 			}
+		},
+		"ThermalStorage": {
+			"type": "object",
+			"properties": {
+				"its_size": {
+					"description": "Total central plant TES capacity in kWh",
+					"type": "number"
+				},
+				"ptes_size": {
+					"description": "Total distributed/packaged TES capacity in kWh",
+					"type": "number"
+				}
+			}
 		}
 	}
-}
+}

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

@@ -0,0 +1,111 @@
+# *********************************************************************************
+# 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/reporting/default_reports/validator'
+require 'json-schema'
+
+module URBANopt
+  module Reporting
+    module DefaultReports
+      ##
+      # Ice Thermal Storage Systems
+      ##
+      class ThermalStorage
+        ##
+        # _Float_ - Total ice storage capacity on central plant loop in kWh
+        #
+        attr_accessor :its_size
+
+        # _Float_ - Total ice storage capacity distributed to packaged systems in kWh
+        #
+        attr_accessor :ptes_size
+
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+
+          @its_size = hash[:its_size]
+          @ptes_size = hash[:ptes_size]
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+
+          # initialize @@logger
+          @@logger ||= URBANopt::Reporting::DefaultReports.logger
+        end
+
+        ##
+        # Assigns default values if attribute values do not exist.
+        ##
+        def defaults
+          hash = {}
+          hash[:its_size] = nil
+          hash[:ptes_size] = nil
+
+          return hash
+        end
+
+        ##
+        # Convert to hash equivalent for JSON serialization
+        ##
+        def to_hash
+          result = {}
+          result[:its_size] = @its_size if @its_size
+          result[:ptes_size] = @ptes_size if @ptes_size
+
+          return result
+        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 thermal storage
+        ##
+        def self.merge_thermal_storage(existing_tes, new_tes)
+          existing_tes.its_size = add_values(existing_tes.its_size, new_tes.its_size)
+          existing_tes.ptes_size = add_values(existing_tes.ptes_size, new_tes.ptes_size)
+
+          return existing_tes
+        end
+      end
+    end
+  end
+end

data/lib/urbanopt/reporting/version.rb

@@ -30,6 +30,6 @@
 
 module URBANopt
   module Reporting
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.1.1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-reporting
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rawad El Kontar
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-18 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,6 +144,7 @@ files:
 - lib/urbanopt/reporting/default_reports/schema/scenario_schema.json
 - lib/urbanopt/reporting/default_reports/solar_pv.rb
 - lib/urbanopt/reporting/default_reports/storage.rb
+- lib/urbanopt/reporting/default_reports/thermal_storage.rb
 - lib/urbanopt/reporting/default_reports/timeseries_csv.rb
 - lib/urbanopt/reporting/default_reports/validator.rb
 - lib/urbanopt/reporting/default_reports/wind.rb
@@ -168,8 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Library to report URBANopt results