urbanopt-scenario 0.1.1 → 0.2.0.pre1

data/lib/urbanopt/scenario/default_reports/schema/README.md

@@ -18,17 +18,16 @@ The URBANopt Scenario Gem includes functionality for defining scenarios, running
 
 |            output                        |  unit   |
 | -----------------------------------------| ------- |
-| Electricity:Facility                     | kbtu     |
-| ElectricityProduced:Facility             | kbtu     |
-| Gas:Facility                             | kbtu    |
-| DistrictCooling:Facility                 | kbtu    |
-| DistrictHeating:Facility                 | kbtu    |
+| Electricity:Facility                     | kWh     |
+| ElectricityProduced:Facility             | kWh     |
+| Gas:Facility                             | kBtu    |
+| DistrictCooling:Facility                 | kWh     |
+| DistrictHeating:Facility                 | kWh     |
 | District Cooling Chilled Water Rate      | GPM     |
-| District Cooling Mass Flow Rate          | lbs/min |
-| District Cooling Inlet Temperature       | °F  |
-| District Cooling Outlet Temperature      | °F  |
+| District Cooling Mass Flow Rate          | kg/s    |
+| District Cooling Inlet Temperature       | °C  |
+| District Cooling Outlet Temperature      | °C  |
 | District Heating Hot Water Rate          | GPM     |
-| District Heating Mass Flow Rate          | lbs/min |
-| District Heating Inlet Temperature       | °F  |
-| District Heating Outlet Temperature      | °F  |
-| Electricity:Grid:ToLoad                  | kWh.    |
+| District Heating Mass Flow Rate          | kg/s    |
+| District Heating Inlet Temperature       | °C  |
+| District Heating Outlet Temperature      | °C  |

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

@@ -1,13 +1,21 @@
-Electricity:Facility	
+Datetime
+Electricity:Facility
 ElectricityProduced:Facility	
-Gas:Facility	
+Gas:Facility
 DistrictCooling:Facility	
 DistrictHeating:Facility	
 District Cooling Chilled Water Rate	
-District Cooling Mass Flow 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 Hot Water Rate
+District Heating Mass Flow Rate
+District Heating Inlet Temperature
 District Heating Outlet Temperature
+Net Electric Energy
+Electricity:Facility Power
+ElectricityProduced:Facility Power
+Electricity:Facility Apparent Power
+ElectricityProduced:Facility Apparent Power
+Net Power
+Net Apparent Power

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

@@ -64,7 +64,6 @@
 				"distributed_generation": {
 					"$ref": "#/definitions/DistributedGeneration"
 				}
-				
 			},
 			"required": [
 				"id",
@@ -83,42 +82,42 @@
 			"type": "object",
 			"properties": {
 				"lcc_us_dollars": {
-					"type": "number", 
-					"description": "Optimal lifecycle cost"
+					"description": "Optimal lifecycle cost",
+					"type": "number"
 				},
 				"npv_us_dollars": {
-					"type": "number", 
-					"description": "Net present value of savings realized by the project"
+					"description": "Net present value of savings realized by the project",
+					"type": "number"
 				},
 				"year_one_energy_cost_us_dollars": {
-					"type": "number", 
-					"description": "Optimal year one utility energy cost"
+					"description": "Optimal year one utility energy cost",
+					"type": "number"
 				},
 				"year_one_demand_cost_us_dollars": {
-					"type": "number", 
-					"description": "Optimal year one utility demand cost"
+					"description": "Optimal year one utility demand cost",
+					"type": "number"
 				},
 				"year_one_bill_us_dollars": {
-					"type": "number", 
-					"description": "Optimal year one utility bill"
+					"description": "Optimal year one utility bill",
+					"type": "number"
 				},
 				"total_energy_cost_us_dollars": {
-					"type": "number", 
-					"description": "Total utility energy cost over the lifecycle, after-tax"
+					"description": "Total utility energy cost over the lifecycle, after-tax",
+					"type": "number"
 				},
-				"SolarPV" : {
+				"SolarPV": {
 					"$ref": "#/definitions/SolarPV"
 				},
-				"Wind" : {
+				"Wind": {
 					"$ref": "#/definitions/Wind"
 				},
-				"Generator" : {
+				"Generator": {
 					"$ref": "#/definitions/Generator"
 				},
-				"Storage" : {
+				"Storage": {
 					"$ref": "#/definitions/Storage"
 				}
-			 }
+			}
 		},
 		"SolarPV": {
 			"type": "object",
@@ -436,6 +435,12 @@
 				"time_setpoint_not_met_during_occupied_hours": {
 					"description": "(hrs)",
 					"type": "number"
+				},
+				"hours_out_of_comfort_bounds_PMV": {
+					"type": "number"
+				},
+				"hours_out_of_comfort_bounds_PPD": {
+					"type": "number"
 				}
 			},
 			"additionalProperties": false
@@ -709,6 +714,10 @@
 				"aspect_ratio": {
 					"description": "Ratio of longest to shortest axis",
 					"type": "number"
+				},
+				"total_construction_cost": {
+					"description": "total construction cost calculated from the defined cost per floor area ($)",
+					"type": "number"
 				}
 			},
 			"required": [

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

@@ -54,6 +54,7 @@ module URBANopt
           hash.delete_if { |k, v| v.nil? }
 
           @size_kw = hash[:size_kw]
+          @id = hash[:id]
 
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new

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

@@ -56,7 +56,12 @@ module URBANopt
 
           @path = hash[:path]
           @first_report_datetime = hash[:first_report_datetime]
+
+          # from scenario csv shema get required reults to be aggregated
+          @required_column_names = load_scenario_csv_schema_headers
+
           @column_names = hash[:column_names]
+          @column_names.delete_if { |x| !@required_column_names.include? x.split('(')[0] }
 
           # hash of column_name to array of values, does not get serialized to hash
           @mutex = Mutex.new
@@ -70,6 +75,23 @@ module URBANopt
           @@logger ||= URBANopt::Scenario::DefaultReports.logger
         end
 
+        ##
+        # load required scenario report csv headers from reports schema
+        ##
+        def load_scenario_csv_schema_headers
+          # rubocop: disable Security/Open
+          scenario_csv_schema = open(File.expand_path('../default_reports/schema/scenario_csv_columns.txt', File.dirname(__FILE__)))
+          # rubocop: enable Security/Open
+
+          scenario_csv_schema_headers = []
+          File.readlines(scenario_csv_schema).each do |line|
+            l = line.delete("\n")
+            a = l.delete("\t")
+            scenario_csv_schema_headers << a
+          end
+          return scenario_csv_schema_headers
+        end
+
         ##
         # Assigns default values if values does not exist.
         ##
@@ -153,7 +175,7 @@ module URBANopt
                   end
                 else
                   row.each_with_index do |value, i|
-                    @data[@column_names[i]] << value.to_f
+                    @data[@column_names[i]] << value
                   end
                 end
               end
@@ -214,7 +236,7 @@ module URBANopt
         ##
         def add_timeseries_csv(other)
           # initialize first_report_datetime with the incoming first_report_datetime if its nil.
-          if @first_report_datetime.nil?
+          if @first_report_datetime.nil? || @first_report_datetime == ''
             @first_report_datetime = other.first_report_datetime
           end
 
@@ -239,12 +261,16 @@ module URBANopt
             end
 
             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|
-                new_values[i] = value + current_values[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/lib/urbanopt/scenario/scenario_runner_osw.rb

@@ -132,7 +132,7 @@ module URBANopt
           end
         end
 
-        # Run osw groups in order and store simulation failure in a array.
+        # Run osw groups in order and store simulation failure in an array.
         # Return simulation_dirs after running all simulations.
 
         # failures
@@ -140,17 +140,33 @@ module URBANopt
         # run building_osws
         # building_failures = runner.run_osws(building_osws, num_parallel = Extension::NUM_PARALLEL, max_to_run = Extension::MAX_DATAPOINTS)
         building_failures = runner.run_osws(building_osws)
-        failures << building_failures
+        failures + building_failures
         # run district_system_osws
         # district_system_failures = runner.run_osws(district_system_osws, num_parallel = Extension::NUM_PARALLEL, max_to_run = Extension::MAX_DATAPOINTS)
         district_system_failures = runner.run_osws(district_system_osws)
-        failures << district_system_failures
+        failures + district_system_failures
         # run transformer_osws
         # transformer_failures = runner.run_osws(transformer_osws, num_parallel = Extension::NUM_PARALLEL, max_to_run = Extension::MAX_DATAPOINTS)
         transformer_failures = runner.run_osws(transformer_osws)
-        failures << transformer_failures
+        failures + transformer_failures
+
+        puts 'Done Running Scenario'
+
+        # if failures.size > 0
+        #   puts "DATAPOINT FAILURES: #{failures}"
+        # end
+
+        # look for other failed datapoints
+        failed_sims = []
+        simulation_dirs.each do |simulation_dir|
+          if File.exist?(File.join(simulation_dir.run_dir, 'failed.job'))
+            failed_sims << simulation_dir.run_dir.split('/')[-1]
+          end
+        end
+        if !failed_sims.empty?
+          puts "FAILED SIMULATION IDs: #{failed_sims.join(',')}"
+        end
 
-        # puts "failures = #{failures}"
         return simulation_dirs
       end
     end

data/lib/urbanopt/scenario/version.rb

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

data/urbanopt-scenario-gem.gemspec

@@ -6,8 +6,8 @@ require 'urbanopt/scenario/version'
 Gem::Specification.new do |spec|
   spec.name          = 'urbanopt-scenario'
   spec.version       = URBANopt::Scenario::VERSION
-  spec.authors       = ['Dan Macumber']
-  spec.email         = ['daniel.macumber@nrel.gov']
+  spec.authors       = ['Rawad El Kontar', 'Dan Macumber']
+  spec.email         = ['rawad.elkontar@nrel.gov']
 
   spec.summary       = 'Library to export data point OSW files from URBANopt Scenario CSV'
   spec.description   = 'Library to export data point OSW files from URBANopt Scenario CSV'
@@ -21,18 +21,20 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  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_dependency 'json-schema'
   spec.add_dependency 'json_pure'
-  spec.add_dependency 'openstudio-model-articulation', '~> 0.1.0'
+  spec.add_dependency 'openstudio-model-articulation', '~> 0.1.1'
   spec.add_dependency 'urbanopt-core', '~> 0.1.0'
 
-  spec.add_dependency 'github_api'
-
   # lock the version of these dependencies due to using older version of Ruby.
   spec.add_dependency 'public_suffix', '3.1.1'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-scenario
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0.pre1
 platform: ruby
 authors:
+- Rawad El Kontar
 - Dan Macumber
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-15 00:00:00.000000000 Z
+date: 2020-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +53,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: github_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !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
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +115,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: urbanopt-core
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +137,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
-- !ruby/object:Gem::Dependency
-  name: github_api
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: public_suffix
   requirement: !ruby/object:Gem::Requirement
@@ -138,12 +153,11 @@ dependencies:
         version: 3.1.1
 description: Library to export data point OSW files from URBANopt Scenario CSV
 email:
-- daniel.macumber@nrel.gov
+- rawad.elkontar@nrel.gov
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/CONTRIBUTING.md"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/pull_request_template.md"
@@ -151,8 +165,8 @@ files:
 - ".rdoc_options"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Jenkinsfile
 - LICENSE.md
@@ -234,14 +248,14 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5.1