urbanopt-scenario 0.2.0.pre2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c30cc0b50e26c5a2800687bb0f17e4f4e9584a97
-  data.tar.gz: e03adccb2d7d9115389194fe0cb446d34f872984
+  metadata.gz: 268f5db33f1444f7e4daddf2f6055b5a5c7f9f03
+  data.tar.gz: 8a2af9239f2433fc2ffc883e69e8748f1ba69d9b
 SHA512:
-  metadata.gz: 4c8f5ef9d42cedf144b96d314d712f7ba78a9c54af6ec1ffeb5198eaa374e843e441f741bd1f05d9d7ee225c83ccb3b5d0edf05066b4638dcc36866f5f95da24
-  data.tar.gz: 842b3e3d0dbbdca6622476399072a9f9c85f36e82c05a50fb1017b7dc0aefb031f558b81632102513c880bbca9b1f0e9a991c9d7ea8cc35f73d942807735486c
+  metadata.gz: c9110c7e58e8f9d47891f46ac2519a436ba6733e11bd4a2e4907ba65bb85c39ce635133ec1edb0fc0380dea2bd5438b432ad0cdc31c370aed76afa75d6351839
+  data.tar.gz: e6bb432c9ef28be6db0511da9f1a58e7fc94438b5a0655924eb9654688a9bf358909715724b234d072d5d15774dfe63f5e7f30e5cce06857628ef8ddc442ce67

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # URBANopt Scenario Gem
- 
+
+## Version 0.2.0
+
+
+Date Range: 01/15/20 - 03/30/20:
+
+- Fixed [#27]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/27 ), FeatureReports are not initialized with location information.
+- Fixed [#38]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/38 ), Write documentation on how to configure ScenarioRunner to run multiple OSWs in parallel
+- Fixed [#42]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/42 ), Scenario Report Instantiation from Hash
+- Fixed [#43]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/43 ), Add timestep column to timeseries csv or add start and end timestep to feature and scenario reports
+- Fixed [#46]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/46 ), add Validator class
+- Fixed [#52]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/52 ), create a save as method that takes a file name
+- Fixed [#54]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/54 ), Add constraint on the versions of ruby in the gemspec file
+- Fixed [#56]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/56 ), Add folder for mapper csv files
+- Fixed [#58]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/58 ), post process results
+- Fixed [#59]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/59 ), figure out how UrbanOpt will select tariff structure for REopt
+- Fixed [#65]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/65 ), make default timeseries csv for scenario; update adding feature timeseries
+- Fixed [#67]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/67 ), update vuepress version
+- Fixed [#70]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/70 ), updates to Scenario Gem to Support REopt Release
+- Fixed [#74]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/74 ), Update copyrights
+- Fixed [#75]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/75 ), make github_api a development dependency
+- Fixed [#81]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/81 ), add thermal comfort results and timestamp to reports
+- Fixed [#83]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/83 ), add multiple pV
+- Fixed [#88]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/88 ), add units to CSV reports
+- Fixed [#89]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/89 ), created Save feature report method
+- Fixed [#91]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/91 ), add total_costruction_cost to reports
+- Fixed [#95]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/95 ), list datapoint failures
+- Fixed [#98]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/98 ), add power, net power, net energy and apparent power to timeseries results
+- Fixed [#101]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/101 ), fix for unit conversion when timeseries doe not exist
+- Fixed [#102]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/102 ), add opendss post_processor
+- Fixed [#104]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/104 ), add power distribution results to schema and reports
+- Fixed [#110]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/110 ), save transformer features CSV and JSON reports
+- Fixed [#112]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/112 ), added additional timeseries results to CSV reports
+
 ## Version 0.1.1
 
 Date Range: 10/16/19 - 01/14/20

data/Gemfile

@@ -40,6 +40,3 @@ end
 
 # simplecov has an unnecessary dependency on native json gem, use fork that does not require this
 gem 'simplecov', github: 'NREL/simplecov'
-
-# Fix rack version temporarily to work with Ruby 2.2.4
-gem 'rack', '2.1.2'

data/lib/measures/default_feature_reports/measure.rb

@@ -174,6 +174,17 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Gas:Facility,#{reporting_frequency};").get
     result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,DistrictCooling:Facility,#{reporting_frequency};").get
     result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,DistrictHeating:Facility,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Cooling:Electricity,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Heating:Electricity,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,InteriorLights:Electricity,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,ExteriorLights:Electricity,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,InteriorEquipment:Electricity,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Fans:Electricity,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Pumps:Electricity,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,WaterSystems:Electricity,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Heating:Gas,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,WaterSystems:Gas,#{reporting_frequency};").get
+    # result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,InteriorEquipment:Gas,#{reporting_frequency};").get
 
     timeseries_data = ['District Cooling Chilled Water Rate', 'District Cooling Mass Flow Rate',
                        'District Cooling Inlet Temperature', 'District Cooling Outlet Temperature',
@@ -608,6 +619,17 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       'Electricity:Facility',
       'ElectricityProduced:Facility',
       'Gas:Facility',
+      'Cooling:Electricity',
+      'Heating:Electricity',
+      'InteriorLights:Electricity',
+      'ExteriorLights:Electricity',
+      'InteriorEquipment:Electricity',
+      'Fans:Electricity',
+      'Pumps:Electricity',
+      'WaterSystems:Electricity',
+      'Heating:Gas',
+      'WaterSystems:Gas',
+      'InteriorEquipment:Gas',
       'DistrictCooling:Facility',
       'DistrictHeating:Facility',
       'District Cooling Chilled Water Rate',
@@ -646,7 +668,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     total_seconds = (60 / timesteps_per_hour.to_f) * 60 # make sure timesteps_per_hour is a float in the division
     total_hours = 1 / timesteps_per_hour.to_f # make sure timesteps_per_hour is a float in the division
     # set power_conversion
-    power_conversion = total_hours
+    power_conversion = total_hours # we set the power conversio to total_hours since we want to convert lWh to kW
     puts "Power Converion: to convert kWh to kW values will be divided by #{power_conversion}"
 
     # number of values in each timeseries
@@ -768,7 +790,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
                 newVals[j] = (values[tsToKeepIndexes['Electricity:Facility']][j].to_f - values[tsToKeepIndexes['ElectricityProduced:Facility']][j].to_f) / power_conversion / powerFactor
                 j += 1
               end
-              new_unit = 'kW'
+              new_unit = 'kVA'
             elsif timeseries_name.include? 'Net Electric Energy'
               (0..n - 1).each do |j|
                 newVals[j] = (values[tsToKeepIndexes['Electricity:Facility']][j].to_f - values[tsToKeepIndexes['ElectricityProduced:Facility']][j].to_f)
@@ -798,7 +820,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
                     newVals[j] = values[indexValue][j].to_f / power_conversion / powerFactor
                     j += 1
                   end
-                  new_unit = 'kW'
+                  new_unit = 'kVA'
                 else
                   # Power calculation
                   (0..n - 1).each do |j|

data/lib/measures/default_feature_reports/measure.xml

@@ -2,8 +2,8 @@
   <schema_version>3.0</schema_version>
   <name>default_feature_reports</name>
   <uid>9ee3135a-8070-4408-bfa1-b75fecf9dd4f</uid>
-  <version_id>607df4a0-d1ff-4c14-8d2f-93cde078dc47</version_id>
-  <version_modified>20200308T020104Z</version_modified>
+  <version_id>dcf043ff-d992-4835-893d-8658a6365eb3</version_id>
+  <version_modified>20200329T155122Z</version_modified>
   <xml_checksum>FB304155</xml_checksum>
   <class_name>DefaultFeatureReports</class_name>
   <display_name>DefaultFeatureReports</display_name>
@@ -137,7 +137,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>DC29E5E6</checksum>
+      <checksum>DF6AAD06</checksum>
     </file>
   </files>
 </measure>

data/lib/urbanopt/scenario.rb

@@ -36,6 +36,7 @@ require 'urbanopt/scenario/scenario_base'
 require 'urbanopt/scenario/scenario_csv'
 require 'urbanopt/scenario/scenario_post_processor_base'
 require 'urbanopt/scenario/scenario_post_processor_default'
+require 'urbanopt/scenario/scenario_post_processor_opendss'
 require 'urbanopt/scenario/scenario_runner_base'
 require 'urbanopt/scenario/scenario_runner_osw'
 require 'urbanopt/scenario/simulation_dir_base'

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

@@ -107,6 +107,11 @@ module URBANopt
         #
         attr_accessor :total_storage_kw
 
+        ##
+        # _Float_ -  Installed storage capacity
+        #
+        attr_accessor :total_storage_kwh
+
         ##
         # _Float_ -  Installed generator capacity
         #
@@ -286,15 +291,15 @@ module URBANopt
             result[:solar_pv].push pv.to_hash
           end
           result[:wind] = []
-          @wind.each do |pv|
+          @wind.each do |wind|
             result[:wind].push wind.to_hash
           end
           result[:generator] = []
-          @generator.each do |pv|
+          @generator.each do |generator|
             result[:generator].push generator.to_hash
           end
           result[:storage] = []
-          @storage.each do |pv|
+          @storage.each do |storage|
             result[:storage].push storage.to_hash
           end
           return result

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

@@ -33,9 +33,10 @@ require 'urbanopt/scenario/default_reports/program'
 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 'urbanopt/scenario/default_reports/power_distribution'
 
+require 'urbanopt/scenario/default_reports/validator'
 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 # :nodoc:
+                      :timeseries_csv, :location, :program, :design_parameters, :construction_costs, :reporting_periods, :distributed_generation, :power_distribution # :nodoc:
         ##
         # Each FeatureReport object corresponds to a single Feature.
         ##
@@ -84,7 +85,9 @@ module URBANopt
             @reporting_periods << ReportingPeriod.new(rp)
           end
 
-          @distributed_generation = DistributedGeneration.new(hash[:distributed_generation] || {})
+          @distributed_generation = DistributedGeneration.new(hash[:distributed_generation])
+
+          @power_distribution = PowerDistribution.new(hash[:power_distribution])
 
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
@@ -104,6 +107,8 @@ module URBANopt
           hash[:program] = {}
           hash[:construction_costs] = []
           hash[:reporting_periods] = []
+          hash[:distributed_generation] = {}
+          hash[:power_distribution] = {}
           return hash
         end
 
@@ -203,6 +208,8 @@ module URBANopt
 
           result[:distributed_generation] = @distributed_generation.to_hash if @distributed_generation
 
+          result[:power_distribution] = @power_distribution.to_hash if @power_distribution
+
           # 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)}"
@@ -216,7 +223,7 @@ module URBANopt
         ##
         # [parameters]:
         # +file_name+ - _String_ - Assign a name to the saved feature report results file without an extension
-        def save_feature_report(file_name = 'updated_default_feature_report')
+        def save_feature_report(file_name = 'default_feature_report')
           # reassign the initialize local variable @file_name to the file name input.
           @file_name = file_name
 
@@ -232,13 +239,13 @@ module URBANopt
           @timeseries_csv.path = File.join(@directory_name, 'feature_reports', file_name + '.csv')
           @timeseries_csv.save_data
 
-          hash = {}
-          hash[:feature_report] = to_hash
+          # feature_hash
+          feature_hash = to_hash
 
           json_name_path = File.join(@directory_name, 'feature_reports', file_name + '.json')
 
           File.open(json_name_path, 'w') do |f|
-            f.puts JSON.pretty_generate(hash)
+            f.puts JSON.pretty_generate(feature_hash)
             # make sure data is written to the disk one way or the other
             begin
               f.fsync

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

@@ -0,0 +1,102 @@
+# *********************************************************************************
+# 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/validator'
+require 'json-schema'
+
+module URBANopt
+  module Scenario
+    module DefaultReports
+      ##
+      # power_distributio include eletrical power distribution systems information.
+      ##
+      class PowerDistribution
+        attr_accessor :under_voltage_hours, :over_voltage_hours # :nodoc:
+        ##
+        # PowerDistrinution class intialize all power_distribution attributes:
+        # +:under_voltage_hours+ , +:over_voltage_hours+
+        ##
+        # [parameters:]
+        # +hash+ - _Hash_ - A hash which may contain a deserialized power_distribution.
+        ##
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+
+          @under_voltage_hours = hash[:under_voltage_hours]
+          @over_voltage_hours = hash[:over_voltage_hours]
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+        end
+
+        ##
+        # Assigns default values if attribute values do not exist.
+        ##
+        def defaults
+          hash = {}
+          hash[:under_voltage_hours] = nil
+          hash[:over_voltage_hours] = nil
+
+          return hash
+        end
+
+        ##
+        # Converts to a Hash equivalent for JSON serialization.
+        ##
+        # - Exclude attributes with nil values.
+        # - Validate power_distribution hash properties against schema.
+        ##
+        def to_hash
+          result = {}
+          result[:under_voltage_hours] = @under_voltage_hours if @under_voltage_hours
+          result[:over_voltage_hours] = @over_voltage_hours if @over_voltage_hours
+
+          # validate power_distribution properties against schema
+          if @@validator.validate(@@schema[:definitions][:PowerDistribution][:properties], result).any?
+            raise "power_distribution properties does not match schema: #{@@validator.validate(@@schema[:definitions][:PowerDistribution][:properties], result)}"
+          end
+
+          return result
+        end
+
+        ##
+        # Merges muliple power distribution results together.
+        ##
+        # +new_costs+ - _Array_ - An array of ConstructionCost objects.
+        def merge_power_distribition
+          # method to be developed for any attributes to be aggregated or merged
+        end
+      end
+    end
+  end
+end

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

@@ -151,7 +151,7 @@ module URBANopt
           # reassign the initialize local variable @file_name to the file name input.
           @file_name = file_name
 
-          # save the csv data
+          # save the scenario reports csv and json data
           old_timeseries_path = nil
           if !@timeseries_csv.path.nil?
             old_timeseries_path = @timeseries_csv.path
@@ -184,6 +184,12 @@ module URBANopt
           else
             @timeseries_csv.path = File.join(@directory_name, file_name + '.csv')
           end
+
+          # save the feature reports csv and json data
+          # @feature_reports.each do |feature_report|
+          #  feature_report.save_feature_report()
+          # end
+
           return true
         end
 

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

@@ -1,13 +1,24 @@
 Datetime
 Electricity:Facility
-ElectricityProduced:Facility	
+ElectricityProduced:Facility
 Gas:Facility
-DistrictCooling:Facility	
-DistrictHeating:Facility	
-District Cooling Chilled Water Rate	
+Cooling:Electricity
+Heating:Electricity
+InteriorLights:Electricity
+ExteriorLights:Electricity
+InteriorEquipment:Electricity
+Fans:Electricity
+Pumps:Electricity
+WaterSystems:Electricity
+Heating:Gas
+WaterSystems:Gas
+InteriorEquipment:Gas
+DistrictCooling:Facility
+DistrictHeating:Facility
+District Cooling Chilled Water Rate
 District Cooling Mass Flow Rate
-District Cooling Inlet Temperature	
-District Cooling Outlet Temperature	
+District Cooling Inlet Temperature
+District Cooling Outlet Temperature
 District Heating Hot Water Rate
 District Heating Mass Flow Rate
 District Heating Inlet Temperature

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

@@ -213,6 +213,9 @@
 				},
 				"distributed_generation": {
 					"$ref": "#/definitions/DistributedGeneration"
+				},
+				"power_distribution": {
+					"$ref": "#/definitions/PowerDistribution"
 				}
 			},
 			"required": [
@@ -834,6 +837,17 @@
 				"column_names"
 			],
 			"additionalProperties": false
+		},
+		"PowerDistribution": {
+			"type": "object",
+			"properties": {
+				"over_voltage_hours": {
+					"type": "number"
+				},
+				"under_voltage_hours": {
+					"type": "number"
+				}
+			}
 		}
 	}
 }

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

@@ -87,7 +87,8 @@ module URBANopt
           File.readlines(scenario_csv_schema).each do |line|
             l = line.delete("\n")
             a = l.delete("\t")
-            scenario_csv_schema_headers << a
+            r = a.delete("\r")
+            scenario_csv_schema_headers << r
           end
           return scenario_csv_schema_headers
         end
@@ -152,7 +153,11 @@ module URBANopt
                 end
               else
                 row.each_with_index do |value, i|
-                  @data[@column_names[i]] << value.to_f
+                  if i == 0
+                    @data[@column_names[i]] << value
+                  else
+                    @data[@column_names[i]] << value.to_f
+                  end
                 end
               end
             end
@@ -204,6 +209,7 @@ module URBANopt
           if path.nil?
             path = @path
           end
+
           File.open(path, 'w') do |f|
             f.puts @column_names.join(',')
             n = @data[@column_names[0]].size - 1
@@ -246,35 +252,44 @@ module URBANopt
           end
 
           # merge the column names
-          @column_names = @column_names.concat(other.column_names).uniq
+          other_column_names = []
+          other.column_names.each do |n|
+            if !n[0, 4].casecmp('ZONE').zero?
+              other_column_names << n
+            end
+          end
+
+          @column_names = @column_names.concat(other_column_names).uniq
 
           # merge the column data
           other.column_names.each do |column_name|
-            if !@column_names.include? column_name
-              @column_names.push column_name
-            end
+            if !column_name[0, 4].casecmp('ZONE').zero?
+              if !@column_names.include? column_name
+                @column_names.push column_name
+              end
 
-            new_values = other.get_data(column_name)
+              new_values = other.get_data(column_name)
 
-            if @data.nil?
-              @data = {}
-            end
+              if @data.nil?
+                @data = {}
+              end
 
-            current_values = @data[column_name]
+              current_values = @data[column_name]
 
-            if current_values
-              if current_values.size != new_values.size
-                raise 'Values of different sizes in add_timeseries_csv'
-              end
-              new_values.each_with_index do |value, i|
-                # aggregate all columns except Datime column
-                if column_name != 'Datetime'
-                  new_values[i] = value.to_f + current_values[i].to_f
+              if current_values
+                if current_values.size != new_values.size
+                  raise 'Values of different sizes in add_timeseries_csv'
+                end
+                new_values.each_with_index do |value, i|
+                  # aggregate all columns except Datime column
+                  if column_name != 'Datetime'
+                    new_values[i] = value.to_f + current_values[i].to_f
+                  end
                 end
+                @data[column_name] = new_values
+              else
+                @data[column_name] = new_values
               end
-              @data[column_name] = new_values
-            else
-              @data[column_name] = new_values
             end
           end
         end

data/lib/urbanopt/scenario/scenario_post_processor_opendss.rb

@@ -0,0 +1,276 @@
+# *********************************************************************************
+# 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 'urbanopt/scenario/scenario_post_processor_base'
+require 'urbanopt/scenario/default_reports'
+require 'urbanopt/scenario/default_reports/logger'
+
+require 'csv'
+require 'json'
+require 'fileutils'
+require 'pathname'
+
+module URBANopt
+  module Scenario
+    class OpenDSSPostProcessor
+      ##
+      # OpenDSSPostProcessor post-processes OpenDSS results to selected OpenDSS results and integrate them in scenario and feature reports.
+      ##
+      # [parameters:]
+      # +scenario_report+ - _ScenarioBase_ - An object of Scenario_report class.
+      # +opendss_results_dir_name+ - _directory name of opendss results
+      def initialize(scenario_report, opendss_results_dir_name = 'opendss')
+        if !scenario_report.nil?
+          @scenario_report = scenario_report
+          @opendss_results_dir = File.join(@scenario_report.directory_name, opendss_results_dir_name)
+        else
+          raise 'scenario_report is not valid'
+        end
+
+        # hash of column_name to array of values, does not get serialized to hash
+        @mutex = Mutex.new
+
+        # initialize opendss data
+        @opendss_data = {}
+
+        # initialize feature_reports data
+        @feature_reports_data = {}
+
+        # initialize logger
+        @@logger ||= URBANopt::Scenario::DefaultReports.logger
+      end
+
+      # load opendss data
+      def load_opendss_data
+        # load building features data
+        @scenario_report.feature_reports.each do |feature_report|
+          # read results from opendss
+          opendss_csv = CSV.read(File.join(@opendss_results_dir, 'results', 'Features', feature_report.id + '.csv'))
+          # add results to data
+          @opendss_data[feature_report.id] = opendss_csv
+        end
+
+        ## load transformers data
+
+        # transformers results directory path
+        tf_results_path = File.join(@opendss_results_dir, 'results', 'Transformers')
+
+        # get transformer ids
+        transformer_ids = []
+        Dir.entries(tf_results_path.to_s).select do |f|
+          if !File.directory? f
+            fn = File.basename(f, '.csv')
+            transformer_ids << fn
+          end
+        end
+
+        # add transformer results to @opendss_data
+        transformer_ids.each do |id|
+          # read results from transformers
+          transformer_csv = CSV.read(File.join(tf_results_path, id + '.csv'))
+          # add results to data
+          @opendss_data[id] = transformer_csv
+        end
+      end
+
+      # load feature report data
+      def load_feature_report_data
+        @scenario_report.feature_reports.each do |feature_report|
+          # read feature results
+          feature_csv = CSV.read(File.join(feature_report.timeseries_csv.path))
+          # add results to data
+          @feature_reports_data[feature_report.id] = feature_csv
+        end
+      end
+
+      # load feature report data and opendss data
+      def load_data
+        # load selected opendss data
+        load_opendss_data
+        # load selected feature reports data
+        load_feature_report_data
+      end
+
+      # merge data
+      def merge_data(feature_report_data, opendss_data)
+        output = CSV.generate do |csv|
+          opendss_data.each_with_index do |row, i|
+            if row.include? 'Datetime'
+              row.map { |header| header.prepend('opendss_') }
+            end
+            csv << (feature_report_data[i] + row[1..-1])
+          end
+        end
+
+        return output
+      end
+
+      # add feature reports for transformers
+      def save_transformers_reports
+        @opendss_data.keys.each do |k|
+          if k.include? 'Transformer'
+
+            # create transformer directory
+            transformer_dir = File.join(@scenario_report.directory_name, k)
+            FileUtils.mkdir_p(File.join(transformer_dir, 'feature_reports'))
+
+            # write data to csv
+            # store under voltages and over voltages
+            under_voltage_hrs = 0
+            over_voltage_hrs = 0
+
+            transformer_csv = CSV.generate do |csv|
+              @opendss_data[k].each_with_index do |row, i|
+                csv << row
+
+                if !row[1].include? 'loading'
+                  if row[1].to_f > 1.05
+                    over_voltage_hrs += 1
+                  end
+
+                  if row[1].to_f < 0.95
+                    under_voltage_hrs += 1
+                  end
+                end
+              end
+            end
+
+            # save transformer CSV report
+            File.write(File.join(transformer_dir, 'feature_reports', 'default_feature_report_opendss' + '.csv'), transformer_csv)
+
+            # create transformer report
+            transformer_report = URBANopt::Scenario::DefaultReports::FeatureReport.new(id: k, name: k, directory_name: transformer_dir, feature_type: 'Transformer',
+                                                                                       timesteps_per_hour: @scenario_report.timesteps_per_hour,
+                                                                                       simulation_status: 'complete')
+
+            # assign results to transfomrer report
+            transformer_report.power_distribution.over_voltage_hours = over_voltage_hrs
+            transformer_report.power_distribution.under_voltage_hours = under_voltage_hrs
+
+            ## save transformer JSON file
+            # transformer_hash
+            transformer_hash = transformer_report.to_hash
+            # transformer_hash.delete_if { |k, v| v.nil? }
+
+            json_name_path = File.join(transformer_dir, 'feature_reports', 'default_feature_report_opendss' + '.json')
+
+            # save the json file
+            File.open(json_name_path, 'w') do |f|
+              f.puts JSON.pretty_generate(transformer_hash)
+              # make sure data is written to the disk one way or the other
+              begin
+                f.fsync
+              rescue StandardError
+                f.flush
+              end
+            end
+
+            # add transformers reports to scenario_report
+            @scenario_report.feature_reports << transformer_report
+
+          end
+        end
+      end
+
+      ##
+      # Save csv report method
+      ##
+      # [parameters:]
+      # +feature_report+ - _feature report object_ - An onject of the feature report
+      # +updated_feature_report_csv+ - _CSV_ - An updated feature report csv
+      # +file_name+ - _String_ - Assigned name to save the file with no extension
+      def save_csv(feature_report, updated_feature_report_csv, file_name = 'default_feature_report')
+        File.write(File.join(feature_report.directory_name, 'feature_reports', "#{file_name}.csv"), updated_feature_report_csv)
+      end
+
+      ##
+      # create opendss json report results
+      ##
+      # [parameters:]
+      # +feature_report+ - _feature report object_ - An onject of the feature report
+      def add_summary_results(feature_report)
+        under_voltage_hrs = 0
+        over_voltage_hrs = 0
+
+        id = feature_report.id
+        @opendss_data[id].each_with_index do |row, i|
+          if !row[1].include? 'voltage'
+
+            if row[1].to_f > 1.05
+              over_voltage_hrs += 1
+            end
+
+            if row[1].to_f < 0.95
+              under_voltage_hrs += 1
+            end
+
+          end
+        end
+
+        # assign results to feature report
+        feature_report.power_distribution.over_voltage_hours = over_voltage_hrs
+        feature_report.power_distribution.under_voltage_hours = under_voltage_hrs
+
+        return feature_report
+      end
+
+      ##
+      # run opendss post_processor
+      ##
+      def run
+        @scenario_report.feature_reports.each do |feature_report|
+          # load data
+          load_data
+
+          # puts " @opendss data = #{@opendss_data}"
+
+          # get summary results
+          add_summary_results(feature_report)
+
+          # merge csv data
+          id = feature_report.id
+          updated_feature_csv = merge_data(@feature_reports_data[id], @opendss_data[id])
+
+          # save fetaure reports
+          feature_report.save_feature_report('default_feature_report_opendss')
+
+          # resave updated csv report
+          save_csv(feature_report, updated_feature_csv, 'default_feature_report_opendss')
+        end
+
+        # add transformer reports
+        save_transformers_reports
+
+        # save the updated scenario reports
+        @scenario_report.save(file_name = 'scenario_report_opendss')
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/version.rb

@@ -30,6 +30,6 @@
 
 module URBANopt
   module Scenario
-    VERSION = '0.2.0.pre2'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/urbanopt-scenario-gem.gemspec

@@ -24,17 +24,17 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '~> 2.2.4'
 
   spec.add_development_dependency 'bundler', '~> 1.14'
-  spec.add_development_dependency 'rake', '12.3.1'
-  spec.add_development_dependency 'rspec', '3.7.0'
   spec.add_development_dependency 'github_api', '~> 0.18.0'
-  # Fix rack version temporarily to work with Ruby 2.2.4
-  spec.add_development_dependency 'rack', '2.1.2'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.7'
 
   spec.add_dependency 'json-schema'
   spec.add_dependency 'json_pure'
   spec.add_dependency 'openstudio-model-articulation', '~> 0.1.1'
-  spec.add_dependency 'urbanopt-core', '~> 0.1.0'
+  spec.add_dependency 'urbanopt-core', '~> 0.2.0'
 
   # lock the version of these dependencies due to using older version of Ruby.
   spec.add_dependency 'public_suffix', '3.1.1'
+  spec.add_development_dependency 'rack', '2.1.2'
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-scenario
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre2
+  version: 0.2.0
 platform: ruby
 authors:
 - Rawad El Kontar
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2020-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -26,61 +26,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 12.3.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 12.3.1
-- !ruby/object:Gem::Dependency
-  name: rspec
+  name: github_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 0.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
-  name: github_api
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -129,14 +115,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: public_suffix
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +137,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.2
 description: Library to export data point OSW files from URBANopt Scenario CSV
 email:
 - rawad.elkontar@nrel.gov
@@ -214,6 +214,7 @@ files:
 - 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/power_distribution.rb
 - lib/urbanopt/scenario/default_reports/program.rb
 - lib/urbanopt/scenario/default_reports/reporting_period.rb
 - lib/urbanopt/scenario/default_reports/scenario_report.rb
@@ -232,6 +233,7 @@ files:
 - lib/urbanopt/scenario/scenario_datapoint_base.rb
 - lib/urbanopt/scenario/scenario_post_processor_base.rb
 - lib/urbanopt/scenario/scenario_post_processor_default.rb
+- lib/urbanopt/scenario/scenario_post_processor_opendss.rb
 - lib/urbanopt/scenario/scenario_runner_base.rb
 - lib/urbanopt/scenario/scenario_runner_osw.rb
 - lib/urbanopt/scenario/simulation_dir_base.rb
@@ -253,9 +255,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1