urbanopt-rnm-us 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 843ba686ad41687f6890709b5d53d3b30ed8bac33cfe726a0e907f2c0fe1e26f
-  data.tar.gz: 22cf46e48542910962f8c29da8c6721b885513bdd9f130083ae48b94028a264f
+  metadata.gz: 07dfa016051b9b8499a11ba5d8066a73c06131d628af10adb2dfc8c9848e7c30
+  data.tar.gz: a6e9f7af3ee4e92951d9225caa5eddfb8f97b20b0e1a5d95898a3f4a132405e3
 SHA512:
-  metadata.gz: 995c88f12b677995d076315afffc5254a6a2ba321926738d754b7e8d540396353a24ac357dc34d6d8754dd763eecae75dfea3f9ce6163203e00961ce48f8ae7d
-  data.tar.gz: c1913789eba31eb44bf3fa4f6abfb7a11715c0ccefd2b739d739c7c92c7636187945309de5f8fb3e7783ebc8c50fe1cd1b76ef3a040c898117f937e8c47c5065
+  metadata.gz: b25a77720880cc85ed29adabb35280a8e308692004183ef7da0a70ae0f4dd4e56c18d5299697490e8ed98e62e8007465ec31f80279c505595df23b144cbf16e5
+  data.tar.gz: e6a40b39b6f1f20f96df5379bf02c73205e00981e60bdf25dccaadb8780dd24522e18dcf423f3497fa7c03f6dd180cdc54531bd150666f2a33612b3a2b40c883

data/.gitignore

@@ -29,4 +29,6 @@ runner.conf
 # ignore template files for now
 /template_inputs/*
 test_opendss_catalog.json
-*.sql
+*.sql
+
+*__pycache__

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## Version 0.5.0
+Date Range 9/30/22 - 12/8/22
+
+- Update dependencies for Extension Gem 0.6.0 and OpenStudio 3.5.0
+
+## Version 0.4.0
+Date Range 05/10/22 - 9/30/22
+
+- Breaking changes to electrical catalog used and compatible RNM-US executable.
+- Update API to version 2. API v1 still working for older URBANopt SDK releases but no longer working for future versions.
+
 ## Version 0.3.0
 Date Range 11/23/21 - 05/10/22
 

data/Gemfile

@@ -9,8 +9,9 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # Below is an example of how to configure the gemfile for developing with local gems
 # modify as appropriate
 
-if allow_local && File.exists?('../urbanopt-geojson-gem')
-  gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
-elsif allow_local
-	gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
-end
+# if allow_local && File.exists?('../urbanopt-geojson-gem')
+#   gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
+# elsif allow_local
+#	  gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
+# end
+

data/README.md

@@ -42,6 +42,27 @@ An OpenDSS-formatted catalog can be generated from the extended catalog with the
 bundle exec rake create_opendss_catalog[/desired/path/to/opendss_catalog.json]
 ```
 
+## RNM-US API compatibility
+
+| API Version | RNM-US Gem Version | RNM-US exe Version |
+| ----------- | ----------- | ---------------- |
+| v1      | 0.3.0 and earlier | RNM-US_20220819 |
+| v2      | 0.4.0 | RNM-US_20221018 |
+
+
+## Validation Functionality
+
+The validation and results visualization functionality is written in python. Follow these steps if you would like to use it.
+
+1. Install python (3.10) if you do not already have it installed
+1. Clone the repo to your computer
+1. cd into the repo directory
+1. run `bundle install` to install the required ruby dependencies
+1. run `pip install -r requirements.txt` to install the required python dependencies for the validation module
+1. create input files and run the simulation as usual
+1. run `bundle exec rake run_validation[/path/to/scenario/csv]` to run the validation
+
+
 ## Testing
 
 ```bash

data/Rakefile

@@ -148,6 +148,29 @@ task :run_simulation, [:scenario_csv_path, :reopt, :use_localhost] do |t, args|
   puts '...done!'
 end
 
+# Full Runner workflow (mimics UO CLI functionality)
+# pass in the path to the scenario csv, geojson path, whether this is a reopt analysis (true/false), and whether to use localhost RNM API (true/false)
+desc 'Full Runner workflow'
+task :full_runner_workflow, [:scenario_csv_path, :geojson_path, :reopt, :use_localhost] do |t, args|
+  # todo: could allow passing in extended catalog, average peak catalog, and opendss_catalog flags too
+  # if no path passed in, use default:
+  scenario_csv = args[:scenario_csv_path] || 'spec/test/example_project/run/baseline_scenario'
+  geojson_path = args[:geojson_path] || 'spec/test/example_project/example_project_with_network_and_streets'
+  root_dir, scenario_file_name = File.split(File.expand_path(scenario_csv))
+  scenario_name = File.basename(scenario_file_name, File.extname(scenario_file_name))
+  run_dir = File.join(root_dir, 'run', scenario_name.downcase)
+  reopt = args[:reopt] || false
+  reopt = reopt == 'true'
+  use_local =  args[:use_localhost] || false
+
+  runner = URBANopt::RNM::Runner.new(scenario_name, run_dir, scenario_csv, geojson_path, reopt: reopt)
+  runner.create_simulation_files
+  runner.run(use_local)
+  runner.post_process
+
+  puts '...done!'
+end
+
 # Create opendss catalog from extended catalog
 # pass in the path and filename where the OpenDSS catalog should be saved
 desc 'Create OpenDSS catalog'
@@ -164,3 +187,36 @@ task :create_opendss_catalog, [:save_path] do |t, args|
   puts "Catalog saved to #{save_path}"
   puts '....done!'
 end
+
+
+# run validation
+# pass in the path to the scenario csv
+desc 'Run Validation'
+task :run_validation, [:scenario_csv_path, :use_numeric_ids] do |t, args|
+  #Exammple to run validation
+  #bundle exec rake run_validation[D:/.../urbanopt-rnm-us-gem/spec/files/example_project/baseline_scenario.csv,true]
+  
+  puts 'Running OpenDSS validation'
+  
+  # if no path passed in, use default:
+  scenario_csv = args[:scenario_csv_path] || 'spec/test/example_project/run/baseline_scenario'
+  root_dir, scenario_file_name = File.split(File.expand_path(scenario_csv))
+  scenario_name = File.basename(scenario_file_name, File.extname(scenario_file_name))
+  run_dir = File.join(root_dir, 'run', scenario_name.downcase)
+  rnm_dir = File.join(run_dir, 'rnm-us')
+
+  #Use numeric ids (for the hierarchical plot of the network)
+  use_numeric_ids = args[:use_numeric_ids] || false
+  use_numeric_ids = use_numeric_ids == 'true'  
+  
+  if !File.exist?(rnm_dir)
+    puts rnm_dir
+    raise 'No rnm-us directory found for this scenario...run the create_inputs rake task first.'
+  end
+
+  puts "run dir path: #{run_dir}"
+  validation = URBANopt::RNM::Validation.new(rnm_dir,use_numeric_ids)
+  validation.run_validation()
+
+  puts '...done!'
+end