urbanopt-scenario 0.1.1 → 0.2.0.pre1

data/docs/package.json

@@ -13,7 +13,7 @@
     "highlight.js": "^9.15.6",
     "json-schema-ref-parser": "^6.1.0",
     "json-schema-view-js": "git+https://git@github.com/bgschiller/json-schema-view-js.git",
-    "vuepress": "^0.14.10",
+    "vuepress": "^1.2.0",
     "webpack-dev-middleware": "^3.6.0"
   },
   "devDependencies": {

data/lib/measures/default_feature_reports/LICENSE.md

@@ -1,4 +1,4 @@
-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/measures/default_feature_reports/README.md

@@ -5,7 +5,7 @@
 # DefaultFeatureReports
 
 ## Description
-Writes default_feature_reports.json file used by URBANopt Scenario Default Post Processor
+Writes default_feature_reports.json and default_feature_reports.csv files used by URBANopt Scenario Default Post Processor
 
 ## 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.

data/lib/measures/default_feature_reports/measure.rb

@@ -44,7 +44,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
 
   # human readable description
   def description
-    return 'Writes default_feature_reports.json file used by URBANopt Scenario Default Post Processor'
+    return 'Writes default_feature_reports.json and default_feature_reports.csv files used by URBANopt Scenario Default Post Processor'
   end
 
   # human readable description of modeling approach
@@ -77,7 +77,8 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     reporting_frequency_chs << 'Timestep'
     reporting_frequency_chs << 'Hourly'
     reporting_frequency_chs << 'Daily'
-    # reporting_frequency_chs << "BillingPeriod" # match it to utility bill object
+    # reporting_frequency_chs << 'Zone Timestep'
+    reporting_frequency_chs << 'BillingPeriod' # match it to utility bill object
     ## Utility report here to report the start and end for each fueltype
     reporting_frequency_chs << 'Monthly'
     reporting_frequency_chs << 'Runperiod'
@@ -85,17 +86,13 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     reporting_frequency = OpenStudio::Measure::OSArgument.makeChoiceArgument('reporting_frequency', reporting_frequency_chs, true)
     reporting_frequency.setDisplayName('Reporting Frequency')
     reporting_frequency.setDescription('The frequency at which to report timeseries output data.')
-    reporting_frequency.setDefaultValue('Hourly')
+    reporting_frequency.setDefaultValue('Timestep')
     args << reporting_frequency
 
-    # move this in the run method
-    if reporting_frequency.defaultValueDisplayName == 'BillingPeriod'
-      @@logger.error('BillingPeriod frequency is not implemented yet')
-    end
-
     return args
   end
 
+  # define fuel types
   def fuel_types
     fuel_types = [
       'Electricity',
@@ -109,6 +106,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     return fuel_types
   end
 
+  # define enduses
   def end_uses
     end_uses = [
       'Heating',
@@ -131,6 +129,24 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     return end_uses
   end
 
+  # format datetime
+  def format_datetime(date_time)
+    date_time.tr!('-', '/')
+    date_time.gsub!('Jan', '01')
+    date_time.gsub!('Feb', '02')
+    date_time.gsub!('Mar', '03')
+    date_time.gsub!('Apr', '04')
+    date_time.gsub!('May', '05')
+    date_time.gsub!('Jun', '06')
+    date_time.gsub!('Jul', '07')
+    date_time.gsub!('Aug', '08')
+    date_time.gsub!('Sep', '09')
+    date_time.gsub!('Oct', '10')
+    date_time.gsub!('Nov', '11')
+    date_time.gsub!('Dec', '12')
+    return date_time
+  end
+
   # return a vector of IdfObject's to request EnergyPlus objects needed by the run method
   # rubocop:disable Naming/MethodName
   def energyPlusOutputRequests(runner, user_arguments)
@@ -152,7 +168,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       end
     end
 
-    ### Request the output for each end use/fuel type combination
+    # Request the output for each end use/fuel type combination
     result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Electricity:Facility,#{reporting_frequency};").get
     result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,ElectricityProduced:Facility,#{reporting_frequency};").get
     result << OpenStudio::IdfObject.load("Output:Meter:MeterFileOnly,Gas:Facility,#{reporting_frequency};").get
@@ -229,6 +245,11 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     # Assign the user inputs to variables
     reporting_frequency = runner.getStringArgumentValue('reporting_frequency', user_arguments)
 
+    # BilingPeriod reporting frequency not implemented yet
+    if reporting_frequency == 'BillingPeriod'
+      @@logger.error('BillingPeriod frequency is not implemented yet')
+    end
+
     # cache runner for this instance of the measure
     @runner = runner
 
@@ -271,7 +292,10 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     feature_report.name = feature_name
     feature_report.feature_type = feature_type
     feature_report.directory_name = workflow.absoluteRunDir
-    feature_report.timesteps_per_hour = model.getTimestep.numberOfTimestepsPerHour
+
+    timesteps_per_hour = model.getTimestep.numberOfTimestepsPerHour
+    feature_report.timesteps_per_hour = timesteps_per_hour
+
     feature_report.simulation_status = 'Complete'
 
     feature_report.reporting_periods << URBANopt::Scenario::DefaultReports::ReportingPeriod.new
@@ -434,6 +458,10 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     aspect_ratio ||= nil
     feature_report.program.aspect_ratio = aspect_ratio
 
+    # total_construction_cost
+    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
+
     ############################################################################
     ##
     # Get Reporting Periods information and store in the feature_report
@@ -592,23 +620,53 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       'District Heating Outlet Temperature'
     ]
 
+    # add thermal comfort timeseries
+    comfortTimeseries = ['Zone Thermal Comfort Fanger Model PMV', 'Zone Thermal Comfort Fanger Model PPD']
+    requested_timeseries_names += comfortTimeseries
+
+    # add additional power timeseries (for calculating transformer apparent power to compare to rating ) in VA
+    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
+
+    # register info all timeseries
+    runner.registerInfo("All timeseries: #{requested_timeseries_names}")
+
+    # timeseries variables to keep to calculate power
+    tsToKeep = ['Electricity:Facility', 'ElectricityProduced:Facility']
+    tsToKeepIndexes = {}
+
+    ### powerFactor ###
+    # use power_factor default:  0.9
+    # TODO: Set powerFactor default based on building type
+    powerFactor = 0.9
+
+    ### power_conversion ###
+    # divide values by  total_seconds to convert J to W (W = J/sec)
+    # divide values by total_hours to convert kWh to kW (kW = kWh/hrs)
+    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
+    puts "Power Converion: to convert kWh to kW values will be divided by #{power_conversion}"
+
     # number of values in each timeseries
     n = nil
-
-    # all numeric timeseries values, transpose of CSV file (e.g. values[j] is column, values[j][i] is column and row)
+    # all numeric timeseries values, transpose of CSV file (e.g. values[key_cnt] is column, values[key_cnt][i] is column and row)
     values = []
-
-    # Since schedule value will have a bunch of key_values, we need to keep track of these as additional timeseries
+    tmpArray = []
+    # since schedule value will have a bunch of key_values, we need to keep track of these as additional timeseries
+    key_cnt = 0
     # this is recording the name of these final timeseries to write in the header of the CSV
     final_timeseries_names = []
 
     # loop over requested timeseries
     # rubocop: disable Metrics/BlockLength
-    requested_timeseries_names.each_with_index do |timeseries_name, j|
+    requested_timeseries_names.each_index do |i|
+      timeseries_name = requested_timeseries_names[i]
       runner.registerInfo("TIMESERIES: #{timeseries_name}")
 
-      # get all the key values that this timeseries can be reported for (e.g. if power is requested for each zone)
-      key_values = sql_file.availableKeyValues(ann_env_pd.to_s, reporting_frequency.to_s, timeseries_name)
+      # get all the key values that this timeseries can be reported for (e.g. if PMV is requested for each zone)
+      key_values = sql_file.availableKeyValues('RUN PERIOD 1', 'Zone Timestep', timeseries_name)
       runner.registerInfo("KEY VALUES: #{key_values}")
       if key_values.empty?
         key_values = ['']
@@ -616,7 +674,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
 
       # sort keys
       sorted_keys = key_values.sort
-      requested_keys = ['SUMMED ELECTRICITY:FACILITY', 'SUMMED ELECTRICITY:FACILITY POWER', 'SUMMED ELECTRICITYPRODUCED:FACILITY', 'SUMMED ELECTRICITYPRODUCED:FACILITY POWER', 'SUMMED NET APPARENT POWER', 'SUMMED NET ELECTRIC ENERGY', 'SUMMED NET POWER', 'TRANSFORMER OUTPUT ELECTRIC ENERGY SCHEDULE']
+      requested_keys = requested_timeseries_names
       final_keys = []
       # make sure aggregated timeseries are listed in sorted order before all individual feature timeseries
       sorted_keys.each do |k|
@@ -649,7 +707,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
             new_timeseries_name = key_value
           end
         end
-        final_timeseries_names << new_timeseries_name
+        # final_timeseries_names << new_timeseries_name
 
         # get the actual timeseries
         ts = sql_file.timeSeries(ann_env_pd.to_s, reporting_frequency.to_s, timeseries_name, key_value)
@@ -657,38 +715,195 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
         if n.nil?
           # first timeseries should always be set
           runner.registerInfo('First timeseries')
-          values[j] = ts.get.values
-          n = values[j].size
+          values[key_cnt] = ts.get.values
+          n = values[key_cnt].size
         elsif ts.is_initialized
           runner.registerInfo('Is Initialized')
-          values[j] = ts.get.values
+          values[key_cnt] = ts.get.values
         else
           runner.registerInfo('Is NOT Initialized')
-          values[j] = Array.new(n, 0)
+          values[key_cnt] = Array.new(n, 0)
         end
 
-        # ##Unit conversion
-        old_units = ts.get.units if ts.is_initialized
-        new_units = case old_units.to_s
-                      when 'J'
-                        'kBtu'
-                      when 'kWh'
-                        'kBtu'
-                      when 'm3'
-                        'gal'
-                    end
-
-        # Unit conversion here
-        os_vec = values[j]
-
-        # loop through each value to retrieve it
-        for i in 0..os_vec.length - 1
-          unless new_units == old_units
-            os_vec[i] = OpenStudio.convert(os_vec[i], old_units, new_units).get
+        # unit conversion
+        old_unit = ts.get.units if ts.is_initialized
+
+        if timeseries_name.include? 'Gas'
+          new_unit = 'kBtu'
+        else
+          new_unit = case old_unit.to_s
+                        when 'J'
+                          'kWh'
+                        when 'kBtu'
+                          'kWh'
+                        when 'gal'
+                          'm3'
+                      end
+        end
+        # loop through each value and apply unit conversion
+        os_vec = values[key_cnt]
+        if !timeseries_name.include? 'Zone Thermal Comfort'
+          for i in 0..os_vec.length - 1
+            unless new_unit == old_unit
+              os_vec[i] = OpenStudio.convert(os_vec[i], old_unit, new_unit).get
+            end
           end
         end
+
+        # keep certain timeseries to calculate power
+        if tsToKeep.include? timeseries_name
+          tsToKeepIndexes[timeseries_name] = key_cnt
+        end
+
+        # special processing: power
+        if powerTimeseries.include? timeseries_name
+          # special case: net series (subtract generation from load)
+          if timeseries_name.include? 'Net'
+
+            newVals = Array.new(n, 0)
+            # Apparent power calculation
+
+            if timeseries_name.include?('Apparent')
+              (0..n - 1).each do |j|
+                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'
+            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)
+                j += 1
+              end
+              new_unit = 'kWh'
+            else
+              runner.registerInfo('Power calc')
+              # Power calculation
+              (0..n - 1).each do |j|
+                newVals[j] = (values[tsToKeepIndexes['Electricity:Facility']][j].to_f - values[tsToKeepIndexes['ElectricityProduced:Facility']][j].to_f) / power_conversion
+                j += 1
+              end
+              new_unit = 'kW'
+            end
+
+            values[key_cnt] = newVals
+          else
+            tsToKeepIndexes.each do |key, indexValue|
+              if timeseries_name.include? key
+                runner.registerInfo("timeseries_name: #{timeseries_name}, key: #{key}")
+                # use this timeseries
+                newVals = Array.new(n, 0)
+                # Apparent power calculation
+                if timeseries_name.include?('Apparent')
+                  (0..n - 1).each do |j|
+                    newVals[j] = values[indexValue][j].to_f / power_conversion / powerFactor
+                    j += 1
+                  end
+                  new_unit = 'kW'
+                else
+                  # Power calculation
+                  (0..n - 1).each do |j|
+                    newVals[j] = values[indexValue][j].to_f / power_conversion
+                    j += 1
+                  end
+                  new_unit = 'kW'
+                end
+                values[key_cnt] = newVals
+              end
+            end
+          end
+        end
+
+        # append units to headers
+        new_timeseries_name += "(#{new_unit})"
+        final_timeseries_names << new_timeseries_name
+
+        # TODO: DELETE PUTS
+        # puts " *********timeseries_name = #{timeseries_name}******************"
+        # if timeseries_name.include? 'Power'
+        #   puts "values = #{values[key_cnt]}"
+        #   puts "units = #{new_unit}"
+        # 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
+
+          # set up array if 1st key_value
+          if key_i == 0
+            runner.registerInfo("SETTING UP NEW ARRAY FOR: #{timeseries_name}")
+            tmpArray = Array.new(n, 0)
+          end
+
+          # add to array (keep max value at each timestep)
+          (0..(n - 1)).each do |ind|
+            # process negative and positive values differently
+            tVal = values[key_cnt][ind].to_f
+            if tVal < 0
+              tmpArray[ind] = [tVal, tmpArray[ind]].min
+            else
+              tmpArray[ind] = [tVal, tmpArray[ind]].max
+            end
+          end
+
+          # aggregate and save when all keyvalues have been processed
+          if key_i == final_keys.size - 1
+
+            hrsOutOfBounds = 0
+            if timeseries_name === 'Zone Thermal Comfort Fanger Model PMV'
+              (0..(n - 1)).each do |ind|
+                # -0.5 < x < 0.5 is within bounds
+                if values[key_cnt][ind].to_f > 0.5 || values[key_cnt][ind].to_f < -0.5
+                  hrsOutOfBounds += 1
+                end
+              end
+              hrsOutOfBounds = hrsOutOfBounds.to_f / timesteps_per_hour
+            elsif timeseries_name === 'Zone Thermal Comfort Fanger Model PPD'
+              (0..(n - 1)).each do |ind|
+                # > 20 is outside bounds
+                if values[key_cnt][ind].to_f > 20
+                  hrsOutOfBounds += 1
+                end
+              end
+              hrsOutOfBounds = hrsOutOfBounds.to_f / timesteps_per_hour
+            else
+              # this one is already scaled by timestep, no need to divide total
+              (0..(n - 1)).each do |ind|
+                hrsOutOfBounds += values[key_cnt][ind].to_f if values[key_cnt][ind].to_f > 0
+              end
+            end
+
+            # save variable to feature_reports hash
+            runner.registerInfo("timeseries #{timeseries_name}: hours out of bounds: #{hrsOutOfBounds}")
+            if timeseries_name === 'Zone Thermal Comfort Fanger Model PMV'
+              feature_report.reporting_periods[0].comfort_result[:hours_out_of_comfort_bounds_PMV] = hrsOutOfBounds
+            elsif timeseries_name == 'Zone Thermal Comfort Fanger Model PPD'
+              feature_report.reporting_periods[0].comfort_result[:hours_out_of_comfort_bounds_PPD] = hrsOutOfBounds
+            end
+
+          end
+
+        end
+
+        # increment key_cnt in new_keys loop
+        key_cnt += 1
       end
     end
+
+    # Add datime column
+    datetimes = []
+    # check what timeseries is available
+    available_ts = sql_file.availableTimeSeries
+    # get the timeseries for any of available timeseries
+    ts_d = sql_file.timeSeries(ann_env_pd.to_s, reporting_frequency.to_s, available_ts[0], '')
+    timeseries_d = ts_d.get
+    # get formated datetimes
+    timeseries_d.dateTimes.each do |datetime|
+      datetimes << format_datetime(datetime.to_s)
+    end
+    # insert datetimes to values
+    values.insert(0, datetimes)
+    # insert datetime header to names
+    final_timeseries_names.insert(0, 'Datetime')
+
     # rubocop: enable Metrics/BlockLength
     runner.registerInfo("new final_timeseries_names size: #{final_timeseries_names.size}")
 

data/lib/measures/default_feature_reports/measure.xml

@@ -2,12 +2,12 @@
   <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>607df4a0-d1ff-4c14-8d2f-93cde078dc47</version_id>
+  <version_modified>20200308T020104Z</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>
@@ -41,7 +41,7 @@
       <type>Choice</type>
       <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 +59,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>
@@ -94,12 +98,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 +111,22 @@
       <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>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>5C1DD676</checksum>
     </file>
     <file>
       <version>
@@ -133,7 +137,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>8C94E56E</checksum>
+      <checksum>DC29E5E6</checksum>
     </file>
   </files>
 </measure>