Updates postprocessing for new sampling / increased geographic resolution

.github/pull_request_template.md

@@ -30,7 +30,7 @@ Author pull request checklist:
  - [ ] Changes reflected in example `.yml` files
  - [ ] Changes reflected in `README.md` files
  - [ ] Added 'See ComStock License' language to first two lines of each code file
- - [ ] Implements corresponding measure tests and indexing path in `test/measure_tests.txt` or/and `test/resource_measure_tests.txt`
+ - [ ] Implements corresponding measure tests and indexing path in `test/reporting_measure_tests.txt`, `test/workflow_measure_tests.txt`, or `test/upgrade_measure_tests.txt`
  - [ ] All new and existing tests pass the CI
 
 ### Review Checklist

.gitignore

@@ -1,6 +1,7 @@
 .temp
 .idea
 .DS_Store
+.vs
 clusters
 data
 local_configuration.*
@@ -26,3 +27,8 @@ lib/
 /sampling/truth_data
 *.pyc
 report.xml
+resources/Gemfile.lock
+
+# Rubocop output
+/.rubocop
+/.rubocop-http*

Jenkinsfile_main_develop

@@ -1,6 +1,6 @@
 #!/usr/bin/groovy
 
-@Library('cbci_shared_libs@develop') _
+@Library('cbci_shared_libs@comstock-dev') _
 
 
 // Build for PR to main branch only.

README.md

@@ -78,3 +78,17 @@ conda activate buildstockbatch
 pip install GHEDesigner==1.0
 pip install NREL-PySAM==4.2.0
 ```
+
+## Measure Tests
+1. Follow the developer installation instructions above. In particular, `GHEDesigner==1.0` must be installed with `pip install GHEDesigner==1.0`.
+2. Run the measure tests with the rake command:
+  - `bundle exec rake unit_tests:all_tests` to run all measure tests.
+  - `bundle exec rake unit_tests:reporting_measure_tests` to run all reporting measure tests.
+  - `bundle exec rake unit_tests:workflow_measure_tests` to run all workflow measure tests.
+	- `bundle exec rake unit_tests:upgrade_measure_tests` to run all `upgrade_` measure tests.
+
+## Running Rubocop
+1. Follow the developer installation instructions above
+2. navigate to the `.custom_gems` directory
+3. run `bundle exec rake rubocop:show` in terminal
+4. review results by opening the `rubocop-results.html` in the `.rubocop/` directory

Rakefile

@@ -1,48 +1,89 @@
-require 'rake'
 require 'rake/testtask'
-require 'minitest/reporters'  # Require the gem
+require 'minitest/reporters'
+require 'parallel'
+require 'rubocop/rake_task'
 
-# Configure the JUnit reporter
-
-desc 'Perform tasks related to unit tests'
+desc 'Run measure tests'
 namespace :unit_tests do
-  desc 'Run measure tests'
-  Rake::TestTask.new('measure_tests') do |t|
-    MEASURETESTS_PATH = "test/measure_tests.txt"
-    if File.exist?(MEASURETESTS_PATH)
-      # load test files from file.
-      full_file_list = FileList.new(File.readlines(MEASURETESTS_PATH).map(&:chomp))
-      full_file_list.select! { |item| item.include?('rb')}
-      p full_file_list
+  desc 'Run all measure tests'
+  task all_tests: [:reporting_measure_tests, :workflow_measure_tests, :upgrade_measure_tests] do
+    puts 'Running all measure tests:'
+  end
 
+  desc 'Run reporting measure tests'
+  task :reporting_measure_tests do
+    puts 'Running all reporting measure tests:'
+    # load test files from file
+    file_list = FileList.new(File.readlines('test/reporting_measure_tests.txt').map(&:chomp))
+    file_list.select! { |item| item.include?('rb') && File.exist?(item) }
+    Parallel.each(file_list, in_processes: Parallel.processor_count) do |file|
+      puts "Running test #{file} in process #{Process.pid}"
+      load file
+      true
+    rescue StandardError => e
+      puts "Error in #{file}: #{e.message}"
+      Minitest::Reporters.reporter.report_error(file, e)
+      false
     end
-    t.test_files = full_file_list
-    p(full_file_list)
-    t.verbose = false
-    t.warning = false
   end
 
-  Rake::TestTask.new('resource_measure_tests') do |t|
-    RESOURCE_MEASURETESTS_PATH = "test/resource_measure_tests.txt"
-    if File.exist?(RESOURCE_MEASURETESTS_PATH)
-      # load test files from file.
-      full_file_list = FileList.new(File.readlines(RESOURCE_MEASURETESTS_PATH).map(&:chomp))
-      full_file_list.select! { |item| item.include?('rb')  && File.exist?(item) }
-      p full_file_list
+  desc 'Run workflow measure tests'
+  task :workflow_measure_tests do
+    puts 'Running all workflow measure tests:'
+    # load test files from file
+    file_list = FileList.new(File.readlines('test/workflow_measure_tests.txt').map(&:chomp))
+    file_list.select! { |item| item.include?('rb') && !item.include?('upgrade') && File.exist?(item) }
+    Parallel.each(file_list, in_processes: Parallel.processor_count) do |file|
+      puts "Running test #{file} in process #{Process.pid}"
+      load file
+      true
+    rescue StandardError => e
+      puts "Error in #{file}: #{e.message}"
+      Minitest::Reporters.reporter.report_error(file, e)
+      false
     end
-    t.test_files = full_file_list.select do |file|
-      begin
-        # Try to load the file to check for syntax errors
-        load file
-        true
-      rescue Exception => e
-        puts "Error in #{file}: #{e.message}"
-        Minitest::Reporters.reporter.report_error(file, e)
-        false
-      end
+  end
+
+  desc 'Run upgrade measure tests'
+  task :upgrade_measure_tests do
+    puts 'Running all upgrade measure tests:'
+    # load test files from file
+    file_list = FileList.new(File.readlines('test/upgrade_measure_tests.txt').map(&:chomp))
+    file_list.select! { |item| item.include?('rb') && item.include?('upgrade') && File.exist?(item) }
+    Parallel.each(file_list, in_processes: Parallel.processor_count) do |file|
+      puts "Running test #{file} in process #{Process.pid}"
+      load file
+      true
+    rescue StandardError => e
+      puts "Error in #{file}: #{e.message}"
+      Minitest::Reporters.reporter.report_error(file, e)
+      false
     end
-    p(full_file_list)
-    t.verbose = false
-    t.warning = false
+  end
+end
+
+desc 'Check the code for style consistency'
+RuboCop::RakeTask.new(:rubocop) do |t|
+  # Make a folder for the output
+  out_dir = '.rubocop'
+  FileUtils.mkdir_p(out_dir)
+  # Output both XML (CheckStyle format) and HTML
+  t.options = ["--out=#{out_dir}/rubocop-results.xml", '--format=h', "--out=#{out_dir}/rubocop-results.html", '--format=offenses', "--out=#{out_dir}/rubocop-summary.txt"]
+  t.requires = ['rubocop/formatter/checkstyle_formatter']
+  t.formatters = ['RuboCop::Formatter::CheckstyleFormatter']
+  # don't abort rake on failure
+  t.fail_on_error = false
+end
+
+desc 'Show the rubocop output in a web browser'
+task 'rubocop:show' => [:rubocop] do
+  link = "#{__dir__}/.rubocop/rubocop-results.html"
+  case RbConfig::CONFIG['host_os']
+  when /mswin/, /mingw/, /cygwin/
+    system "start #{link}"
+  when /darwin/
+    system "open #{link}"
+  when /linux/, /bsd/
+    system "xdg-open #{link}"
   end
 end