urbanopt-scenario 0.1.1 → 0.3.0

data/lib/measures/default_feature_reports/measure.xml

@@ -1,47 +1,61 @@
+<?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
   <name>default_feature_reports</name>
   <uid>9ee3135a-8070-4408-bfa1-b75fecf9dd4f</uid>
-  <version_id>803f9d76-a088-489d-88d3-6f3a5ae50d8a</version_id>
-  <version_modified>20191030T020950Z</version_modified>
+  <version_id>95706c7a-88ab-433b-b897-00435181a6dd</version_id>
+  <version_modified>20200603T001228Z</version_modified>
   <xml_checksum>FB304155</xml_checksum>
   <class_name>DefaultFeatureReports</class_name>
   <display_name>DefaultFeatureReports</display_name>
-  <description>Writes default_feature_reports.json file used by URBANopt Scenario Default Post Processor</description>
+  <description>Writes default_feature_reports.json and default_feature_reports.csv files used by URBANopt Scenario Default Post Processor</description>
   <modeler_description>This measure only allows for one feature_report per simulation. If multiple features are simulated in a single simulation, a new measure must be written to disaggregate simulation results to multiple features.</modeler_description>
   <arguments>
     <argument>
       <name>feature_id</name>
       <display_name>Feature unique identifier</display_name>
+      <description></description>
       <type>String</type>
+      <units></units>
       <required>false</required>
       <model_dependent>false</model_dependent>
       <default_value>1</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>feature_name</name>
       <display_name>Feature scenario specific name</display_name>
+      <description></description>
       <type>String</type>
+      <units></units>
       <required>false</required>
       <model_dependent>false</model_dependent>
       <default_value>name</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>feature_type</name>
       <display_name>URBANopt Feature Type</display_name>
+      <description></description>
       <type>String</type>
+      <units></units>
       <required>false</required>
       <model_dependent>false</model_dependent>
       <default_value>Building</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
     <argument>
       <name>reporting_frequency</name>
       <display_name>Reporting Frequency</display_name>
       <description>The frequency at which to report timeseries output data.</description>
       <type>Choice</type>
+      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
-      <default_value>Hourly</default_value>
+      <default_value>Timestep</default_value>
       <choices>
         <choice>
           <value>Detailed</value>
@@ -59,6 +73,10 @@
           <value>Daily</value>
           <display_name>Daily</display_name>
         </choice>
+        <choice>
+          <value>BillingPeriod</value>
+          <display_name>BillingPeriod</display_name>
+        </choice>
         <choice>
           <value>Monthly</value>
           <display_name>Monthly</display_name>
@@ -68,10 +86,12 @@
           <display_name>Runperiod</display_name>
         </choice>
       </choices>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
   </arguments>
-  <outputs/>
-  <provenances/>
+  <outputs />
+  <provenances />
   <tags>
     <tag>Reporting.QAQC</tag>
   </tags>
@@ -94,12 +114,6 @@
       <usage_type>test</usage_type>
       <checksum>BDF687C1</checksum>
     </file>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>B646B327</checksum>
-    </file>
     <file>
       <filename>README.md.erb</filename>
       <filetype>erb</filetype>
@@ -113,16 +127,16 @@
       <checksum>CC4BFFAF</checksum>
     </file>
     <file>
-      <filename>README.md</filename>
+      <filename>LICENSE.md</filename>
       <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>FDBC6AE2</checksum>
+      <usage_type>license</usage_type>
+      <checksum>EA283B74</checksum>
     </file>
     <file>
       <filename>default_feature_reports_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>8E37E2D9</checksum>
+      <checksum>56E0804B</checksum>
     </file>
     <file>
       <version>
@@ -133,7 +147,14 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>8C94E56E</checksum>
+      <checksum>A00C8077</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>0B68E96D</checksum>
     </file>
   </files>
 </measure>
+<error>wrong number of arguments (given 1, expected 0)</error>

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

@@ -73,25 +73,50 @@ module URBANopt
         attr_accessor :total_energy_cost_us_dollars
 
         ##
-        # _SolarPV_ - Installed \solar PV attributes
+        # _Array_ - List of _SolarPV_ systems
         #
         attr_accessor :solar_pv
 
         ##
-        # _Wind_ -  Installed \wind attributes
+        # _Array_ - List of _Wind_ systems
         #
         attr_accessor :wind
 
         ##
-        # _Generator_ - Installed \generator attributes
+        # _Array_ - List of _Generator_ systems
         #
         attr_accessor :generator
 
         ##
-        # _Storage_ - Installed \storage attributes
+        # _Array_ - List of _Storage_ systems
         #
         attr_accessor :storage
 
+        ##
+        # _Float_ -  Installed solar PV capacity
+        #
+        attr_accessor :total_solar_pv_kw
+
+        ##
+        # _Float_ -  Installed wind capacity
+        #
+        attr_accessor :total_wind_kw
+
+        ##
+        # _Float_ -  Installed storage capacity
+        #
+        attr_accessor :total_storage_kw
+
+        ##
+        # _Float_ -  Installed storage capacity
+        #
+        attr_accessor :total_storage_kwh
+
+        ##
+        # _Float_ -  Installed generator capacity
+        #
+        attr_accessor :total_generator_kw
+
         ##
         # Initialize distributed generation system design and financial metrics.
         #
@@ -113,10 +138,85 @@ module URBANopt
           @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] || {})
+          @total_solar_pv_kw = nil
+          @total_wind_kw = nil
+          @total_generator_kw = nil
+          @total_storage_kw = nil
+          @total_storage_kwh = nil
+
+          @solar_pv = []
+          if hash[:solar_pv].class == Hash
+            hash[:solar_pv] = [hash[:solar_pv]]
+          elsif hash[:solar_pv].nil?
+            hash[:solar_pv] = []
+          end
+
+          hash[:solar_pv].each do |s|
+            if !s[:size_kw].nil? && (s[:size_kw] != 0)
+              @solar_pv.push SolarPV.new(s)
+              if @total_solar_pv_kw.nil?
+                @total_solar_pv_kw = @solar_pv[-1].size_kw
+              else
+                @total_solar_pv_kw += @solar_pv[-1].size_kw
+              end
+            end
+          end
+
+          @wind = []
+          if hash[:wind].class == Hash
+            hash[:wind] = [hash[:wind]]
+          elsif hash[:wind].nil?
+            hash[:wind] = []
+          end
+
+          hash[:wind].each do |s|
+            if !s[:size_kw].nil? && (s[:size_kw] != 0)
+              @wind.push Wind.new(s)
+              if @total_wind_kw.nil?
+                @total_wind_kw = @wind[-1].size_kw
+              else
+                @total_wind_kw += @wind[-1].size_kw
+              end
+            end
+          end
+
+          @generator = []
+          if hash[:generator].class == Hash
+            hash[:generator] = [hash[:generator]]
+          elsif hash[:generator].nil?
+            hash[:generator] = []
+          end
+
+          hash[:generator].each do |s|
+            if !s[:size_kw].nil? && (s[:size_kw] != 0)
+              @generator.push Generator.new(s)
+              if @total_generator_kw.nil?
+                @total_generator_kw = @generator[-1].size_kw
+              else
+                @total_generator_kw += @generator[-1].size_kw
+              end
+            end
+          end
+
+          @storage = []
+          if hash[:storage].class == Hash
+            hash[:storage] = [hash[:storage]]
+          elsif hash[:storage].nil?
+            hash[:storage] = []
+          end
+
+          hash[:storage].each do |s|
+            if !s[:size_kw].nil? && (s[:size_kw] != 0)
+              @storage.push Storage.new(s)
+              if @total_storage_kw.nil?
+                @total_storage_kw = @storage[-1].size_kw
+                @total_storage_kwh = @storage[-1].size_kwh
+              else
+                @total_storage_kw += @storage[-1].size_kw
+                @total_storage_kwh += @storage[-1].size_kwh
+              end
+            end
+          end
 
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
@@ -126,6 +226,49 @@ module URBANopt
           @@logger ||= URBANopt::Scenario::DefaultReports.logger
         end
 
+        ##
+        # Add a tech
+        ##
+        def add_tech(name, tech)
+          if name == 'solar_pv'
+            @solar_pv.push tech
+            if @total_solar_pv_kw.nil?
+              @total_solar_pv_kw = tech.size_kw
+            else
+              @total_solar_pv_kw += tech.size_kw
+            end
+          end
+
+          if name == 'wind'
+            @wind.push tech
+            if @total_wind_kw.nil?
+              @total_wind_kw = tech.size_kw
+            else
+              @total_wind_kw += tech.size_kw
+            end
+          end
+
+          if name == 'storage'
+            @storage.push tech
+            if @total_storage_kw.nil?
+              @total_storage_kw = tech.size_kw
+              @total_storage_kwh = tech.size_kwh
+            else
+              @total_storage_kw += tech.size_kw
+              @total_storage_kwh += tech.size_kwh
+            end
+          end
+
+          if name == 'generator'
+            @generator.push tech
+            if @total_generator_kw.nil?
+              @total_generator_kw = tech.size_kw
+            else
+              @total_generator_kw += tech.size_kw
+            end
+          end
+        end
+
         ##
         # Convert to a Hash equivalent for JSON serialization
         ##
@@ -137,12 +280,28 @@ module URBANopt
           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
+          result[:total_solar_pv_kw] = @total_solar_pv_kw if @total_solar_pv_kw
+          result[:total_wind_kw] = @total_wind_kw if @total_wind_kw
+          result[:total_generator_kw] = @total_generator_kw if @total_generator_kw
+          result[:total_storage_kw] = @total_storage_kw if @total_storage_kw
+          result[:total_storage_kwh] = @total_storage_kwh if @total_storage_kwh
 
+          result[:solar_pv] = []
+          @solar_pv.each do |pv|
+            result[:solar_pv].push pv.to_hash
+          end
+          result[:wind] = []
+          @wind.each do |wind|
+            result[:wind].push wind.to_hash
+          end
+          result[:generator] = []
+          @generator.each do |generator|
+            result[:generator].push generator.to_hash
+          end
+          result[:storage] = []
+          @storage.each do |storage|
+            result[:storage].push storage.to_hash
+          end
           return result
         end
 
@@ -174,10 +333,43 @@ module URBANopt
           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
+          new_dgen.solar_pv.each do |pv|
+            existing_dgen.solar_pv.push pv
+            if existing_dgen.total_solar_pv_kw.nil?
+              existing_dgen.total_solar_pv_kw = pv.size_kw
+            else
+              existing_dgen.total_solar_pv_kw += pv.size_kw
+            end
+          end
+
+          new_dgen.wind.each do |wind|
+            existing_dgen.wind.push wind
+            if existing_dgen.total_wind_kw.nil?
+              existing_dgen.total_wind_kw = wind.size_kw
+            else
+              existing_dgen.total_wind_kw += wind.size_kw
+            end
+          end
+
+          new_dgen.storage.each do |storage|
+            existing_dgen.storage.push storage
+            if existing_dgen.total_wind_kw.nil?
+              existing_dgen.total_storage_kw = storage.size_kw
+              existing_dgen.total_storage_kwh = storage.size_kwh
+            else
+              existing_dgen.total_storage_kw += storage.size_kw
+              existing_dgen.total_storage_kwh += storage.size_kwh
+            end
+          end
+
+          new_dgen.generator.each do |generator|
+            existing_dgen.generator.push generator
+            if existing_dgen.total_wind_kw.nil?
+              existing_dgen.total_generator_kw = generator.size_kw
+            else
+              existing_dgen.total_generator_kw += generator.size_kw
+            end
+          end
 
           return existing_dgen
         end

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,11 +85,16 @@ 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
           @@schema ||= @@validator.schema
+
+          # initialize feature report file name to be saved.
+          @file_name = 'default_feature_report'
         end
 
         ##
@@ -101,6 +107,8 @@ module URBANopt
           hash[:program] = {}
           hash[:construction_costs] = []
           hash[:reporting_periods] = []
+          hash[:distributed_generation] = {}
+          hash[:power_distribution] = {}
           return hash
         end
 
@@ -200,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)}"
@@ -207,6 +217,50 @@ module URBANopt
 
           return result
         end
+
+        ##
+        # Saves the 'default_feature_report.json' and 'default_feature_report.csv' files
+        ##
+        # [parameters]:
+        # +file_name+ - _String_ - Assign a name to the saved feature report results file without an extension
+        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
+
+          # create feature reports directory
+          Dir.mkdir(File.join(@directory_name, 'feature_reports')) unless Dir.exist?(File.join(@directory_name, 'feature_reports'))
+
+          # save the csv data
+          old_timeseries_path = nil
+          if !@timeseries_csv.path.nil?
+            old_timeseries_path = @timeseries_csv.path
+          end
+
+          @timeseries_csv.path = File.join(@directory_name, 'feature_reports', file_name + '.csv')
+          @timeseries_csv.save_data
+
+          # 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(feature_hash)
+            # make sure data is written to the disk one way or the other
+            begin
+              f.fsync
+            rescue StandardError
+              f.flush
+            end
+          end
+
+          if !old_timeseries_path.nil?
+            @timeseries_csv.path = old_timeseries_path
+          else
+            @timeseries_csv.path = File.join(@directory_name, 'feature_reports', file_name + '.csv')
+          end
+          return true
+        end
       end
     end
   end