urbanopt-scenario 0.6.0 → 0.7.0

data/docs/package.json

@@ -13,21 +13,22 @@
     "highlight.js": "^10.4.1",
     "json-schema-ref-parser": "^9.0.6",
     "json-schema-view-js": "git+https://git@github.com/bgschiller/json-schema-view-js.git",
-    "vuepress": "^1.6.0",
     "webpack-dev-middleware": "^3.6.0"
   },
   "devDependencies": {
     "braces": "^3.0.2",
     "dot-prop": "^5.3.0",
     "gh-pages": "^3.1.0",
+    "ini": "^2.0.0",
     "is-svg": ">=4.3.1",
     "js-yaml": "^3.14.0",
     "minimist": ">=1.2.3",
     "node-forge": ">=0.10.0",
+    "postcss": "^8.2.15",
     "serialize-javascript": "^5.0.1",
-    "set-value": "^3.0.2",
+    "set-value": "^4.0.1",
     "ssri": ">=8.0.1",
-    "yargs-parser": "^20.2.1",
-    "ini": "^2.0.0"
+    "vuepress": "^1.8.2",
+    "yargs-parser": "^20.2.1"
   }
 }

data/lib/urbanopt/scenario/logger.rb

@@ -42,7 +42,7 @@ require 'logger'
 
 module URBANopt
   module Scenario
-    @@logger = Logger.new(STDOUT)
+    @@logger = Logger.new($stdout)
 
     # Definining class variable "@@logger" to log errors, info and warning messages.
     def self.logger

data/lib/urbanopt/scenario/scenario_csv.rb

@@ -82,7 +82,6 @@ module URBANopt
 
       # Require all simulation mappers in mapper_files_dir
       def load_mapper_files
-
         # loads default values from extension gem
         options = OpenStudio::Extension::RunnerConfig.default_config
         # check if runner.conf file exists
@@ -94,9 +93,9 @@ module URBANopt
 
         # bundle path is assigned from the runner.conf if it exists or is assigned in the root_dir
         bundle_path = !options.key?(:bundle_install_path) || options[:bundle_install_path] === '' ? File.join(@root_dir, '.bundle/install/') : options[:bundle_install_path]
-        
+
         # checks if bundle path doesn't exist or is empty
-        if !Dir.exists?(bundle_path) or Dir.empty?(bundle_path)
+        if !Dir.exist?(bundle_path) || Dir.empty?(bundle_path)
           # install bundle
           OpenStudio::Extension::Runner.new(@root_dir)
         end
@@ -105,8 +104,10 @@ module URBANopt
         lib_dirs = Dir.glob(File.join(bundle_path, '/**/lib'))
         lib_dirs.each do |ld|
           # for now only add openstudio and urbanopt gems to the load path
-          if ld.include? 'urbanopt' or ld.include? 'openstudio'
-            puts "adding DIR to load path: #{ld}"
+          # and only those with 'urbanopt' or 'openstudio' in the before-last path position
+          tmp_path_arr = Pathname(ld).each_filename.to_a
+          if tmp_path_arr[-2].include?('urbanopt') || tmp_path_arr[-2].include?('openstudio')
+            # puts "adding DIR to load path: #{ld}"
             $LOAD_PATH.unshift(ld)
           end
         end
@@ -119,7 +120,6 @@ module URBANopt
           @@logger.error(e.message)
           raise
         end
-
       end
 
       # Gets all the simulation directories

data/lib/urbanopt/scenario/scenario_datapoint_base.rb

@@ -41,7 +41,7 @@
 module URBANopt
   module Scenario
     class ScenarioDatapoint
-      attr_reader :scenario, :feature_id, :feature_name, :mapper_class #:nodoc:#
+      attr_reader :scenario, :feature_id, :feature_name, :mapper_class, :feature #:nodoc:#
 
       ##
       # ScenarioDatapoint is an agnostic description of the simulation of a Feature in a Scenario
@@ -58,9 +58,7 @@ module URBANopt
         @feature_name = feature_name
         @feature = scenario.feature_file.get_feature_by_id(feature_id)
         @mapper_class = mapper_class
-      end
-
-      attr_reader :feature #:nodoc:
+      end #:nodoc:
 
       ##
       # Gets the type of a feature
@@ -83,7 +81,8 @@ module URBANopt
       def run_dir
         raise 'Feature ID not set' if @feature_id.nil?
         raise 'Scenario run dir not set' if @scenario.run_dir.nil?
-        return File.join(@scenario.run_dir, @feature_id + '/')
+
+        return File.join(@scenario.run_dir, "#{@feature_id}/")
       end
 
       ##
@@ -138,6 +137,7 @@ module URBANopt
         if !File.exist?(out_osw)
           return true
         end
+
         out_osw_time = File.mtime(out_osw)
 
         # array of files that this datapoint depends on

data/lib/urbanopt/scenario/scenario_post_processor_default.rb

@@ -117,7 +117,7 @@ module URBANopt
         feature_list = Pathname.new(@initialization_hash[:directory_name]).children.select(&:directory?) # Folders in the run/scenario directory
 
         # get scenario CSV
-        scenario_csv = File.join(@initialization_hash[:root_dir], @initialization_hash[:name] + '.csv')
+        scenario_csv = File.join(@initialization_hash[:root_dir], "#{@initialization_hash[:name]}.csv")
         if File.exist?(scenario_csv)
           # csv found
           feature_ids = CSV.read(scenario_csv, headers: true)
@@ -159,7 +159,7 @@ module URBANopt
               # running sum
               arr_match[:elec_val] += Float(row[7])
             end
-          end # End elec_query
+          end
           elec_query.close
 
           gas_query = feature_db.query "SELECT ReportData.TimeIndex, Time.Year, Time.Month, Time.Day, Time.Hour,
@@ -182,10 +182,10 @@ module URBANopt
               # running sum
               arr_match[:gas_val] += Float(row[7])
             end
-          end # End gas_query
+          end
           gas_query.close
           feature_db.close
-        end # End feature_list loop
+        end
 
         elec_sql = []
         gas_sql = []

data/lib/urbanopt/scenario/scenario_post_processor_opendss.rb

@@ -80,7 +80,7 @@ module URBANopt
         # 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'))
+          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
@@ -102,7 +102,7 @@ module URBANopt
         # 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'))
+          transformer_csv = CSV.read(File.join(tf_results_path, "#{id}.csv"))
           # add results to data
           @opendss_data[id] = transformer_csv
         end
@@ -133,7 +133,7 @@ module URBANopt
             if row.include? 'Datetime'
               row.map { |header| header.prepend('opendss_') }
             end
-            csv << (feature_report_data[i] + row[1..-1])
+            csv << (feature_report_data[i] + row[1..])
           end
         end
 
@@ -142,7 +142,7 @@ module URBANopt
 
       # add feature reports for transformers
       def save_transformers_reports
-        @opendss_data.keys.each do |k|
+        @opendss_data.each_key do |k|
           if k.include? 'Transformer'
 
             # create transformer directory
@@ -171,7 +171,7 @@ module URBANopt
             end
 
             # save transformer CSV report
-            File.write(File.join(transformer_dir, 'feature_reports', 'default_feature_report_opendss' + '.csv'), transformer_csv)
+            File.write(File.join(transformer_dir, 'feature_reports', 'default_feature_report_opendss.csv'), transformer_csv)
 
             # create transformer report
             transformer_report = URBANopt::Reporting::DefaultReports::FeatureReport.new(id: k, name: k, directory_name: transformer_dir, feature_type: 'Transformer',
@@ -187,7 +187,7 @@ module URBANopt
             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')
+            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|

data/lib/urbanopt/scenario/scenario_runner_osw.rb

@@ -133,11 +133,12 @@ module URBANopt
           # add each osw file to its corresponding group id +simulation_dir+ is out_of_date
           if simulation_dir.out_of_date?
 
-            if feature_type == 'Building'
+            case feature_type
+            when 'Building'
               building_osws << simulation_dir.in_osw_path
-            elsif feature_type == 'District System'
+            when 'District System'
               district_system_osws << simulation_dir.in_osw_path
-            elsif feature_type == 'Transformer'
+            when 'Transformer'
               transformer_osws << simulation_dir.in_osw_path
             else
               raise "ScenarioRunnerOSW does not know how to run a #{feature_type} feature"

data/lib/urbanopt/scenario/scenario_visualization.rb

@@ -47,17 +47,19 @@ module URBANopt
     class ResultVisualization
       def self.create_visualization(run_dir, feature = true, feature_names = false)
         @all_results = []
-
+        name = nil
         run_dir.each do |folder|
           # create visualization for scenarios
-          if feature == false
-            name = folder.split('/')[-1]
-            csv_dir = File.join(folder, 'default_scenario_report.csv')
+          case feature
+          when false
+            name = folder.split('/')[-2]
+            csv_dir = folder
+
           # create visualization for features
-          elsif feature == true
+          when true
             index = run_dir.index(folder)
-            name = folder.split('/')[-1] + '-' + feature_names[index]
-            csv_dir = File.join(folder, 'feature_reports/default_feature_report.csv')
+            name = "#{folder.split('/')[-3]}-#{feature_names[index]}"
+            csv_dir = folder
           end
 
           if File.exist?(csv_dir)
@@ -192,7 +194,6 @@ module URBANopt
                     monthly_sum_dec += v.to_f
                     i += 1
                   end
-
                 end
               end
 
@@ -205,42 +206,49 @@ module URBANopt
               annual_values[headers_unitless[j]] = annual_sum
             end
 
-            @results = {}
-            @results['name'] = name
-            @results['monthly_values'] = {}
-            @results['annual_values'] = {}
+            results = {}
+            results['name'] = name
+            results['monthly_values'] = {}
+            results['annual_values'] = {}
 
             if @jan_next_year_index.nil? || @feb_index.nil? || @mar_index.nil? || @apr_index.nil? || @may_index.nil? || @jun_index.nil? || @jul_index.nil? || @aug_index.nil? || @sep_index.nil? || @oct_index.nil? || @nov_index.nil? || @dec_index.nil?
-              @results['complete_simulation'] = false
+              results['complete_simulation'] = false
               puts "#{name} did not contain an annual simulation…visualizations will not render for it."
             else
-              @results['complete_simulation'] = true
+              results['complete_simulation'] = true
             end
 
             monthly_totals&.each do |key, value|
               unless key == 'Datetime'
-                @results['monthly_values'][key] = value
+                results['monthly_values'][key] = value
               end
             end
 
             annual_values&.each do |key, value|
               unless key == 'Datetime'
-                @results['annual_values'][key] = value
+                results['annual_values'][key] = value
               end
             end
 
           end
 
-          unless @results.nil?
-            @all_results << @results
+          unless results.nil?
+            @all_results << results
           end
         end
+
         # create json with required data stored in a variable
-        results_path = File.join(run_dir[0], '../scenarioData.js')
+        if feature == false
+          # In case of scenario visualization store result at top of the run folder
+          results_path = File.expand_path('../../scenarioData.js', run_dir[0])
+        else
+          # In case of feature visualization store result at top of scenario folder folder
+          results_path = File.expand_path('../../../scenarioData.js', run_dir[0])
+        end
         File.open(results_path, 'w') do |file|
           file << "var scenarioData = #{JSON.pretty_generate(@all_results)};"
         end
       end
-    end # ResultVisualization
-  end # Scenario
-end # URBANopt
+    end
+  end
+end

data/lib/urbanopt/scenario/simulation_dir_base.rb

@@ -54,11 +54,7 @@ module URBANopt
         @feature_names = feature_names
       end
 
-      attr_reader :scenario #:nodoc:
-
-      attr_reader :features #:nodoc:
-
-      attr_reader :feature_names #:nodoc:
+      attr_reader :scenario, :features, :feature_names #:nodoc: #:nodoc: #:nodoc:
 
       ##
       # Return the directory that this simulation will run in

data/lib/urbanopt/scenario/simulation_dir_osw.rb

@@ -71,13 +71,15 @@ module URBANopt
       end
 
       attr_reader :mapper_class, :feature_id
+
       ##
       # Return the directory that this simulation will run in.
       ##
       def run_dir
         raise 'Feature ID not set' if @feature_id.nil?
         raise 'Scenario run dir not set' if scenario.run_dir.nil?
-        return File.join(scenario.run_dir, @feature_id + '/')
+
+        return File.join(scenario.run_dir, "#{@feature_id}/")
       end
 
       ##

data/lib/urbanopt/scenario/version.rb

@@ -40,6 +40,6 @@
 
 module URBANopt
   module Scenario
-    VERSION = '0.6.0'.freeze
+    VERSION = '0.7.0'.freeze
   end
 end

data/urbanopt-scenario-gem.gemspec

@@ -25,14 +25,14 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rspec', '~> 3.9'
 
-  spec.add_runtime_dependency 'json-schema', '~> 2.8'
   spec.add_runtime_dependency 'json_pure', '~> 2.3'
+  spec.add_runtime_dependency 'json-schema', '~> 2.8'
 
   spec.add_runtime_dependency 'sqlite3', '1.4.2'
-  spec.add_runtime_dependency 'urbanopt-core', '~> 0.6.0'
-  spec.add_runtime_dependency 'urbanopt-reporting', '~> 0.4.0'
+  spec.add_runtime_dependency 'urbanopt-core', '~> 0.7.0'
+  spec.add_runtime_dependency 'urbanopt-reporting', '~> 0.5.0'
 
   # no longer need the below
   # need to include all measure gems listed in mappers in project gemfiles

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-scenario
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Rawad El Kontar
 - Dan Macumber
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,42 +45,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: json-schema
+  name: json_pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: json_pure
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -101,28 +101,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: urbanopt-reporting
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
 description: Library to export data point OSW files from URBANopt Scenario CSV
 email:
 - rawad.elkontar@nrel.gov
@@ -182,7 +182,7 @@ homepage: https://github.com/urbanopt
 licenses:
 - Nonstandard
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -198,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Library to export data point OSW files from URBANopt Scenario CSV
 test_files: []