urbanopt-scenario 0.3.0.pre1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f3b7d2011137b207de9f896a21ec59a4aaf58d730b5ddf6d0044487fa5c52e3
-  data.tar.gz: ee379c34924b4a6217434ce6e57500674ac5a158c69fcb939cb2730c65377c77
+  metadata.gz: f93b1a5a10c8bbbc7e9c2b24e1ba08b78ebefdd3cd9b63bb0c5221cc52bef70f
+  data.tar.gz: 2cda8b296e36d810d0c581b1e9b40432e68a8d356681cc2b3dbebf29a036bdcc
 SHA512:
-  metadata.gz: 06fc50c836b10099c13c05329f815db355940733f7fbc39979688c7fbb9e4a2732f0d303b969a3be9d16166f3996bdeccd91b339f366a20fc4761d81228af484
-  data.tar.gz: 29f0f9becdd8b064bbc5d2e36bc7bd031e221fc2bef185dc15160057cab22f3c0472cd5dfaebc8999e3db6fa0149b58a5c9383b4e64f374f8493ef256ec53cd6
+  metadata.gz: 0dd003e6dce979401fc293f3b5df0f1bcedaa095442daf0050515eb34eece41eebacea7b380dfd07f90e315399df9ffbedfa5badce30a066301fff0fbae9be90
+  data.tar.gz: d4b7f9ac5b19526a545c77185234c5aa65ff918d47056824e703460b8908097ed643549e5a9a6db6b1ba47789c2329b0e49bc6bed56819721f36733d65c45306

data/CHANGELOG.md

@@ -1,13 +1,15 @@
 # URBANopt Scenario Gem
 
-## Version 0.3.0.pre1
-Date Range: 04/01/20 - 05/18/20:
+## Version 0.3.0
+Date Range: 04/01/20 - 06/04/20:
 
 Updating to OpenStudio 3.0 and Ruby 2.5
 
 - Fixed [#114]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/114 ), Bug fix
 - Fixed [#117]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/117 ), Added utility cost outputs to reports
 - Fixed [#118]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/118 ), test Jenkins using pipeline to run OpenStudio 3.0.0
+- Fixed [#119]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/119 ), added timeseries outputs for heat rejection end uses
+- Fixed [#120]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/120 ), Bug fix r
 
 ## Version 0.2.0
 

data/lib/measures/.rubocop.yml

@@ -2,4 +2,4 @@ AllCops:
   Exclude:
     - 'spec/test_measures/**/*'
 inherit_from:
-  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop.yml
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v3.yml

data/lib/measures/default_feature_reports/README.md

@@ -2,16 +2,16 @@
 
 ###### (Automatically generated documentation)
 
-# DefaultFeatureReports
+# 
 
 ## Description
-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.
+
 
 ## Measure Type
-ReportingMeasure
+ModelMeasure
 
 ## Taxonomy
 
@@ -19,38 +19,8 @@ ReportingMeasure
 ## Arguments
 
 
-### Feature unique identifier
-
-**Name:** feature_id,
-**Type:** String,
-**Units:** ,
-**Required:** false,
-**Model Dependent:** false
-
-### Feature scenario specific name
-
-**Name:** feature_name,
-**Type:** String,
-**Units:** ,
-**Required:** false,
-**Model Dependent:** false
-
-### URBANopt Feature Type
-
-**Name:** feature_type,
-**Type:** String,
-**Units:** ,
-**Required:** false,
-**Model Dependent:** false
-
-### Reporting Frequency
-The frequency at which to report timeseries output data.
-**Name:** reporting_frequency,
-**Type:** Choice,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
 
 
+This measure does not have any user arguments
 
 

data/lib/measures/default_feature_reports/measure.rb

@@ -185,15 +185,14 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     # 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
-    result << OpenStudio::IdfObject.load("Output:Variable,*,Heating Coil Heating Rate,hourly; !- HVAC Average [W];").get
+    result << OpenStudio::IdfObject.load('Output:Variable,*,Heating Coil Heating Rate,hourly; !- HVAC Average [W];').get
 
     timeseries_data = ['District Cooling Chilled Water Rate', 'District Cooling Mass Flow Rate',
                        'District Cooling Inlet Temperature', 'District Cooling Outlet Temperature',
                        'District Heating Hot Water Rate', 'District Heating Mass Flow Rate',
-                       'District Heating Inlet Temperature', 'District Heating Outlet Temperature','Cooling Coil Total Cooling Rate',
+                       'District Heating Inlet Temperature', 'District Heating Outlet Temperature', 'Cooling Coil Total Cooling Rate',
                        'Heating Coil Heating Rate']
 
-                       
     timeseries_data.each do |ts|
       result << OpenStudio::IdfObject.load("Output:Variable,*,#{ts},#{reporting_frequency};").get
     end
@@ -588,8 +587,8 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
 
     ## Total utility cost
     total_utility_cost = sql_query(runner, sql_file, 'Economics Results Summary Report', "TableName='Annual Cost' AND RowName='Cost' AND ColumnName='Total'")
-    feature_report.reporting_periods[0].total_utility_cost = total_utility_cost 
-    
+    feature_report.reporting_periods[0].total_utility_cost = total_utility_cost
+
     ## Utility Costs
     # electricity utility cost
     elec_utility_cost = sql_query(runner, sql_file, 'Economics Results Summary Report', "TableName='Annual Cost' AND RowName='Cost' AND ColumnName='Electric'")
@@ -597,8 +596,8 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     feature_report.reporting_periods[0].utility_costs[0][:total_cost] = elec_utility_cost
     # gas utility cost
     gas_utility_cost = sql_query(runner, sql_file, 'Economics Results Summary Report', "TableName='Annual Cost' AND RowName='Cost' AND ColumnName='Gas'")
-    feature_report.reporting_periods[0].utility_costs << {:fuel_type => 'Natural Gas', :total_cost => gas_utility_cost}
-    
+    feature_report.reporting_periods[0].utility_costs << { fuel_type: 'Natural Gas', total_cost: gas_utility_cost }
+
     ## comfort_result
     # time_setpoint_not_met_during_occupied_cooling
     time_setpoint_not_met_during_occupied_cooling = sql_query(runner, sql_file, 'AnnualBuildingUtilityPerformanceSummary', "TableName='Comfort and Setpoint Not Met Summary' AND RowName='Time Setpoint Not Met During Occupied Cooling' AND ColumnName='Facility'")
@@ -643,6 +642,8 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       'Fans:Electricity',
       'Pumps:Electricity',
       'WaterSystems:Electricity',
+      'HeatRejection:Electricity',
+      'HeatRejection:Gas',
       'Heating:Gas',
       'WaterSystems:Gas',
       'InteriorEquipment:Gas',
@@ -655,7 +656,7 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
       'District Heating Hot Water Rate',
       'District Heating Mass Flow Rate',
       'District Heating Inlet Temperature',
-      'District Heating Outlet Temperature', 
+      'District Heating Outlet Temperature',
       'Cooling Coil Total Cooling Rate',
       'Heating Coil Heating Rate'
     ]
@@ -700,9 +701,9 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     final_timeseries_names = []
 
     # loop over requested timeseries
-    # rubocop: disable Metrics/BlockLength
     requested_timeseries_names.each_index do |i|
       timeseries_name = requested_timeseries_names[i]
+      puts " *********timeseries_name = #{timeseries_name}******************"
       runner.registerInfo("TIMESERIES: #{timeseries_name}")
 
       # get all the key values that this timeseries can be reported for (e.g. if PMV is requested for each zone)
@@ -782,13 +783,13 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
                           'W'
                       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 || old_unit.nil?  || new_unit.nil? || !ts.is_initialized
+            unless new_unit == old_unit || old_unit.nil? || new_unit.nil? || !ts.is_initialized
               os_vec[i] = OpenStudio.convert(os_vec[i], old_unit, new_unit).get
             end
 
@@ -937,12 +938,19 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     datetimes = []
     # check what timeseries is available
     available_ts = sql_file.availableTimeSeries
-
+    puts "####### available_ts = #{available_ts}"
     # get the timeseries for any of available timeseries
     # RK: code enhancement needed
-    ts_d = sql_file.timeSeries(ann_env_pd.to_s, reporting_frequency.to_s, available_ts[2], '')
-      
-    timeseries_d = ts_d.get
+    ts_d_e = sql_file.timeSeries(ann_env_pd.to_s, reporting_frequency.to_s, 'Electricity:Facility', '')
+    ts_d_g = sql_file.timeSeries(ann_env_pd.to_s, reporting_frequency.to_s, 'Gas:Facility', '')
+
+    if ts_d_e.is_initialized
+      timeseries_d = ts_d_e.get
+    elsif ts_d_g.is_initialized
+      timeseries_d = ts_d_g.get
+    else
+      raise 'ELECTRICITY and GAS results are not initiaized'
+    end
     # get formated datetimes
     timeseries_d.dateTimes.each do |datetime|
       datetimes << format_datetime(datetime.to_s)
@@ -952,7 +960,6 @@ class DefaultFeatureReports < OpenStudio::Measure::ReportingMeasure
     # 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

@@ -1,9 +1,10 @@
+<?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>dcf043ff-d992-4835-893d-8658a6365eb3</version_id>
-  <version_modified>20200329T155122Z</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>
@@ -13,32 +14,45 @@
     <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>Timestep</default_value>
@@ -72,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>
@@ -122,12 +138,6 @@
       <usage_type>test</usage_type>
       <checksum>56E0804B</checksum>
     </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>5C1DD676</checksum>
-    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
@@ -137,7 +147,14 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>DF6AAD06</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/default_reports/program.rb

@@ -219,7 +219,6 @@ module URBANopt
         # [parameters:]
         # +other+ - _Program_ - An object of Program class.
         ##
-        # rubocop:disable Metrics/AbcSize # :nodoc:
         def add_program(other)
           @site_area = add_values(@site_area, other.site_area)
 

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

@@ -44,7 +44,7 @@ module URBANopt
       class ReportingPeriod
         attr_accessor :id, :name, :multiplier, :start_date, :end_date, :month, :day_of_month, :year, :total_site_energy, :total_source_energy,
                       :net_site_energy, :net_source_energy, :total_utility_cost, :net_utility_cost, :utility_costs, :electricity, :natural_gas, :additional_fuel, :district_cooling,
-                      :district_heating, :water, :electricity_produced, :end_uses, :energy_production, :photovoltaic, 
+                      :district_heating, :water, :electricity_produced, :end_uses, :energy_production, :photovoltaic,
                       :fuel_type, :total_cost, :usage_cost, :demand_cost, :comfort_result, :time_setpoint_not_met_during_occupied_cooling,
                       :time_setpoint_not_met_during_occupied_heating, :time_setpoint_not_met_during_occupied_hours, :hours_out_of_comfort_bounds_PMV, :hours_out_of_comfort_bounds_PPD #:nodoc:
         # ReportingPeriod class initializes the reporting period attributes:
@@ -208,7 +208,6 @@ module URBANopt
         ##
         # +new_period+ - _ReportingPeriod_ - An object of ReportingPeriod class.
         ##
-        # rubocop: disable Metrics/AbcSize
         def self.merge_reporting_period(existing_period, new_period)
           # modify the existing_period by summing up the results
           existing_period.total_site_energy = add_values(existing_period.total_site_energy, new_period.total_site_energy)
@@ -235,7 +234,7 @@ module URBANopt
           end
 
           if existing_period.utility_costs
-            #RK: this need to be updated
+            # RK: this need to be updated
             existing_period.utility_costs.each_with_index do |item, i|
               existing_period.utility_costs[i][:fuel_type] = existing_period.utility_costs[i][:fuel_type]
               existing_period.utility_costs[i][:total_cost] = add_values(existing_period.utility_costs[i][:total_cost], new_period.utility_costs[i][:total_cost])

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

@@ -10,6 +10,8 @@ InteriorEquipment:Electricity
 Fans:Electricity
 Pumps:Electricity
 WaterSystems:Electricity
+HeatRejection:Electricity
+HeatRejection:Gas
 Heating:Gas
 WaterSystems:Gas
 InteriorEquipment:Gas

data/lib/urbanopt/scenario/simulation_dir_osw.rb

@@ -132,8 +132,6 @@ module URBANopt
         return result
       end
 
-      # rubocop: disable Metrics/AbcSize #:nodoc:
-
       ##
       # Return true if the simulation is out of date (input files newer than results), false otherwise.
       # Non-existant simulation input files are out of date.
@@ -199,8 +197,6 @@ module URBANopt
       end
       # rubocop: enable Metrics/AbcSize #:nodoc:
 
-      # rubocop: disable Style/GuardClause #:nodoc:
-
       ##
       # Return simulation status one of {'Not Started', 'Started', 'Complete', 'Failed'}
       ##

data/lib/urbanopt/scenario/version.rb

@@ -30,6 +30,6 @@
 
 module URBANopt
   module Scenario
-    VERSION = '0.3.0.pre1'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/urbanopt-scenario-gem.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|lib.measures.*tests|spec|features)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -31,9 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json_pure'
   spec.add_dependency 'openstudio-common-measures', '~> 0.2.0'
   spec.add_dependency 'openstudio-model-articulation', '~> 0.2.0'
-  spec.add_dependency 'urbanopt-core', '~> 0.3.0.pre2'
+  spec.add_dependency 'urbanopt-core', '~> 0.3.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.3.0.pre1
+  version: 0.3.0
 platform: ruby
 authors:
 - Rawad El Kontar
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,14 +115,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0.pre2
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0.pre2
+        version: 0.3.0
 description: Library to export data point OSW files from URBANopt Scenario CSV
 email:
 - rawad.elkontar@nrel.gov
@@ -170,9 +170,6 @@ files:
 - lib/measures/default_feature_reports/README.md.erb
 - lib/measures/default_feature_reports/measure.rb
 - lib/measures/default_feature_reports/measure.xml
-- lib/measures/default_feature_reports/tests/USA_CO_Golden-NREL.724666_TMY3.epw
-- lib/measures/default_feature_reports/tests/default_feature_reports_test.rb
-- lib/measures/default_feature_reports/tests/example_model.osm
 - lib/urbanopt-scenario.rb
 - lib/urbanopt/scenario.rb
 - lib/urbanopt/scenario/default_reports.rb
@@ -226,9 +223,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: