urbanopt-cli 0.6.2 → 0.6.3

data/example_files/reopt/base_assumptions.json

@@ -22,8 +22,8 @@
         "net_metering_limit_kw": 0,
         "interconnection_limit_kw": 100000000.0,
         "blended_monthly_demand_charges_us_dollars_per_kw": [10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10], 
-        "blended_monthly_rates_us_dollars_per_kwh": [0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13] 
-      },
+        "blended_monthly_rates_us_dollars_per_kwh": [0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13]
+     },
       "Wind": {
         "min_kw": 0,
         "max_kw": 0,
@@ -77,7 +77,7 @@
         "losses": 0.14,
         "array_type": 1,
         "module_type": 0,
-        "gcr": 0.4,
+        "gcr": 1,
         "dc_ac_ratio": 1.2,
         "inv_eff": 0.96,
         "radius": 0,

data/example_files/reopt/multiPV_assumptions.json

@@ -77,7 +77,7 @@
         "losses": 0.14,
         "array_type": 1,
         "module_type": 0,
-        "gcr": 0.4,
+        "gcr": 1,
         "dc_ac_ratio": 1.2,
         "inv_eff": 0.96,
         "radius": 0,
@@ -113,7 +113,7 @@
         "losses": 0.14,
         "array_type": 0,
         "module_type": 0,
-        "gcr": 0.4,
+        "gcr": 1,
         "dc_ac_ratio": 1.2,
         "inv_eff": 0.96,
         "radius": 0,

data/example_files/resources/hpxml-measures/Gemfile

@@ -2,7 +2,7 @@
 
 source 'http://rubygems.org'
 
-gem 'nokogiri', '~> 1.10'
+gem 'nokogiri', '~> 1.12'
 gem 'oga'
 gem 'schematron-nokogiri'
 gem 'rake'

data/example_files/resources/hpxml-measures/Gemfile.lock

@@ -4,27 +4,17 @@ GEM
     ansi (1.5.0)
     ast (2.4.2)
     builder (3.2.4)
-    ci_reporter (2.0.0)
-      builder (>= 2.1.2)
-    ci_reporter_minitest (1.0.0)
-      ci_reporter (~> 2.0)
-      minitest (~> 5.0)
-    codecov (0.2.12)
-      json
-      simplecov
-    docile (1.3.5)
-    json (2.5.1)
-    mini_portile2 (2.5.0)
+    mini_portile2 (2.6.1)
     minitest (5.14.4)
     minitest-reporters (1.4.3)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    nokogiri (1.11.2)
-      mini_portile2 (~> 2.5.0)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
-    nokogiri (1.11.2-x64-mingw32)
+    nokogiri (1.12.5-x64-mingw32)
       racc (~> 1.4)
     oga (3.3)
       ast
@@ -38,28 +28,19 @@ GEM
     ruby-progressbar (1.11.0)
     schematron-nokogiri (0.0.3)
       nokogiri (~> 1.6)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
 
 PLATFORMS
   ruby
   x64-mingw32
 
 DEPENDENCIES
-  ci_reporter_minitest (~> 1.0.0)
-  codecov (= 0.2.12)
   minitest (~> 5.9)
   minitest-reporters
-  nokogiri (~> 1.10)
+  nokogiri (~> 1.12)
   oga
   parallel
   rake
   schematron-nokogiri
-  simplecov
 
 BUNDLED WITH
-   2.2.11
+   2.2.11

data/example_files/visualization/input_visualization_feature.html

@@ -383,7 +383,7 @@
 
         var months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
         
-        var datasets = ['Electricity:Facility', 'ElectricityProduced:Facility', 'NaturalGas:Facility', 'Propane:Facility', 'FuelOilNo2:Facility', 'OtherFuels:Facility'];
+        var datasets = ['Electricity:Facility', 'REopt:ElectricityProduced:Total', 'NaturalGas:Facility', 'Propane:Facility', 'FuelOilNo2:Facility', 'OtherFuels:Facility'];
         
         var endUseKeys = ['Heating:Electricity', 'Cooling:Electricity', 'InteriorLights:Electricity', 'ExteriorLights:Electricity', 'ExteriorEquipment:Electricity', 'InteriorEquipment:Electricity', 'Fans:Electricity', 'Pumps:Electricity', 'HeatRejection:Electricity', 'WaterSystems:Electricity'];
 
@@ -483,7 +483,7 @@
                     datasetUnit = 'Electricity:Facility(kWh)';
                   }
                 }
-              } else if (dataset == 'ElectricityProduced:Facility') {
+              } else if (dataset == 'REopt:ElectricityProduced:Total') {
                 // first check if there is data to include
                 if (!(values.every(item => item === 0))) {
                   if (changeToKbtu) {
@@ -543,13 +543,13 @@
               values: _.map(months, function (month, i) {
                 var value = 0;
                  if (changeToKbtu){
-                  value = feature.monthly_values['Electricity:Facility'][i]*3.41 - feature.monthly_values['ElectricityProduced:Facility'][i]*3.41;
+                  value = feature.monthly_values['Electricity:Facility'][i]*3.41 - feature.monthly_values['REopt:ElectricityProduced:Total'][i]*3.41;
                   _.forEach(kbtu_datasets, function(ds){
                     value += feature.monthly_values[ds][i];
                   });
                  }
                 else {
-                  value = feature.monthly_values['Electricity:Facility'][i] - feature.monthly_values['ElectricityProduced:Facility'][i]; //Values are in kWh
+                  value = feature.monthly_values['Electricity:Facility'][i] - feature.monthly_values['REopt:ElectricityProduced:Total'][i]; //Values are in kWh
                 }
 
                 $scope.annualNetChartData[feature.name] += value;

data/example_files/visualization/input_visualization_scenario.html

@@ -373,7 +373,7 @@
 
         var months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
         
-        var datasets = ['Electricity:Facility', 'ElectricityProduced:Facility', 'NaturalGas:Facility', 'Propane:Facility', 'FuelOilNo2:Facility', 'OtherFuels:Facility'];
+        var datasets = ['Electricity:Facility', 'REopt:ElectricityProduced:Total', 'NaturalGas:Facility', 'Propane:Facility', 'FuelOilNo2:Facility', 'OtherFuels:Facility'];
 
         var endUseKeys = ['Heating:Electricity', 'Cooling:Electricity', 'InteriorLights:Electricity', 'ExteriorLights:Electricity', 'InteriorEquipment:Electricity', 'ExteriorEquipment:Electricity', 'Fans:Electricity', 'Pumps:Electricity', 'HeatRejection:Electricity', 'WaterSystems:Electricity'];
         
@@ -456,7 +456,7 @@
                     datasetUnit = 'Electricity:Facility(kWh)';
                   }
                 }
-              } else if (dataset == 'ElectricityProduced:Facility') {
+              } else if (dataset == 'REopt:ElectricityProduced:Total') {
                 // first check if there is data to include
                 if (!(values.every(item => item === 0))) {
                   if (changeToKbtu) {
@@ -515,14 +515,14 @@
               values: _.map(months, function (month, i) {
                 var value = 0;
                 if (changeToKbtu){
-                  value = scenario.monthly_values['Electricity:Facility'][i]*3.41 - scenario.monthly_values['ElectricityProduced:Facility'][i]*3.41 + scenario.monthly_values['NaturalGas:Facility'][i]; //Values are in kBtu
+                  value = scenario.monthly_values['Electricity:Facility'][i]*3.41 - scenario.monthly_values['REopt:ElectricityProduced:Total'][i]*3.41 + scenario.monthly_values['NaturalGas:Facility'][i]; //Values are in kBtu
 
                    _.forEach(kbtu_datasets, function(ds){
                      value += scenario.monthly_values[ds][i];
                    });
                  }
                 else {
-                  value = scenario.monthly_values['Electricity:Facility'][i] - scenario.monthly_values['ElectricityProduced:Facility'][i]; //Values are in kWh
+                  value = scenario.monthly_values['Electricity:Facility'][i] - scenario.monthly_values['REopt:ElectricityProduced:Total'][i]; //Values are in kWh
                 }
                 // value;
                 $scope.annualNetChartData[scenario.name] += value;

data/lib/uo_cli/version.rb

@@ -40,6 +40,6 @@
 
 module URBANopt
   module CLI
-    VERSION = '0.6.2'.freeze
+    VERSION = '0.6.3'.freeze
   end
 end

data/lib/uo_cli.rb

@@ -129,6 +129,9 @@ module URBANopt
           opt :streets, "\nCreate default project wiht FeatureFile containing streets, used for RNM analysis\n" \
           "Example: uo create --project-folder urbanopt_example_project --streets", short: :t
 
+          opt :photovoltaic, "\nCreate default project with FeatureFile containing community photovoltaic for the district and ground-mount photovoltaic associated with buildings, used for REopt analysis \n" \
+          "Example: uo create --project-folder urbanopt_example_project --photovoltaic", short: :v
+
           opt :empty, "\nUse with --project-folder argument to create an empty project folder\n" \
           "Then add your own Feature file in the project directory you created,\n" \
           "add Weather files in the weather folder and add OpenStudio models of Features\n" \
@@ -226,10 +229,10 @@ module URBANopt
           "Example: uo rnm --scenario baseline_scenario.csv --feature example_project.json --reopt", short: :r
 
           opt :extended_catalog, "\nUse this option to specify the extended electrical catalog path.\n" \
-          "If this option is not included, the default catalog will be used", short: :c
+          "If this option is not included, the default catalog will be used", type: String, short: :c
 
           opt :average_peak_catalog, "\nUse this option to specify the average peak catalog path.\n" \
-          "If this option is not included, the default catalog will be used", short: :a
+          "If this option is not included, the default catalog will be used", type: String, short: :a
 
           opt :opendss, "\n If this option is specified, an OpenDSS-compatible electrical database will be created \n" \
           "Example: uo rnm --scenario baseline_scenario.csv --feature example_project_with_streets.json --opendss", short: :o
@@ -533,11 +536,13 @@ module URBANopt
               FileUtils.cp(File.join(path_item, 'example_project_with_electric_network.json'), dir_name)
             elsif @opthash.subopts[:streets] == true
               FileUtils.cp(File.join(path_item, 'example_project_with_streets.json'), dir_name)
+            elsif @opthash.subopts[:photovoltaic] == true
+              FileUtils.cp(File.join(path_item, 'example_project_with_PV.json'), dir_name)
             end
 
             if @opthash.subopts[:floorspace] == false
 
-              if @opthash.subopts[:electric] != true && @opthash.subopts[:streets] != true
+              if @opthash.subopts[:electric] != true && @opthash.subopts[:streets] != true && @opthash.subopts[:photovoltaic] != true
                 # copy feature file
                 FileUtils.cp(File.join(path_item, 'example_project.json'), dir_name)
               end
@@ -554,6 +559,7 @@ module URBANopt
                 FileUtils.cp(File.join(path_item, 'mappers/HighEfficiency.rb'), File.join(dir_name, 'mappers'))
                 FileUtils.cp(File.join(path_item, 'mappers/ThermalStorage.rb'), File.join(dir_name, 'mappers'))
                 FileUtils.cp(File.join(path_item, 'mappers/EvCharging.rb'), File.join(dir_name, 'mappers'))
+                FileUtils.cp(File.join(path_item, 'mappers/FlexibleHotWater.rb'), File.join(dir_name, 'mappers'))
 
                 # copy osw file
                 FileUtils.cp(File.join(path_item, 'mappers/base_workflow.osw'), File.join(dir_name, 'mappers'))
@@ -923,29 +929,57 @@ module URBANopt
           scenario_assumptions = File.expand_path(@opthash.subopts[:reopt_scenario_assumptions_file]).to_s
         end
         puts "\nRunning the REopt Scenario post-processor with scenario assumptions file: #{scenario_assumptions}\n"
+        # Add community photovoltaic if present in the Feature File
+        community_photovoltaic = []
+        feature_file = JSON.parse(File.read(File.expand_path(@opthash.subopts[:feature])), symbolize_names: true)
+        feature_file[:features].each do |feature|
+          begin
+            if feature[:properties][:district_system_type] 
+              if feature[:properties][:district_system_type] == 'Community Photovoltaic'
+                community_photovoltaic << feature
+              end
+            end
+          rescue
+          end
+        end
         reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(
           scenario_report,
           scenario_assumptions,
           scenario_base.reopt_feature_assumptions,
-          DEVELOPER_NREL_KEY
+          DEVELOPER_NREL_KEY,false
         )
         if @opthash.subopts[:reopt_scenario] == true
           puts "\nPost-processing entire scenario with REopt\n"
           scenario_report_scenario = reopt_post_processor.run_scenario_report(
             scenario_report: scenario_report,
             save_name: 'scenario_optimization',
-            run_resilience: @opthash.subopts[:reopt_resilience]
+            run_resilience: @opthash.subopts[:reopt_resilience],
+            community_photovoltaic: community_photovoltaic
           )
           results << { "process_type": 'reopt_scenario', "status": 'Complete', "timestamp": Time.now.strftime('%Y-%m-%dT%k:%M:%S.%L') }
           puts "\nDone\n"
         elsif @opthash.subopts[:reopt_feature] == true
           puts "\nPost-processing each building individually with REopt\n"
+          # Add groundmount photovoltaic if present in the Feature File
+          groundmount_photovoltaic = {}
+          feature_file = JSON.parse(File.read(File.expand_path(@opthash.subopts[:feature])), symbolize_names: true)
+          feature_file[:features].each do |feature|
+            begin
+              if feature[:properties][:district_system_type]
+                if feature[:properties][:district_system_type] == 'Ground Mount Photovoltaic'
+                  groundmount_photovoltaic[feature[:properties][:associated_building_id]] = feature[:properties][:footprint_area]
+                end
+              end
+            rescue
+            end
+          end
             scenario_report_features = reopt_post_processor.run_scenario_report_features(
               scenario_report: scenario_report,
               save_names_feature_reports: ['feature_optimization'] * scenario_report.feature_reports.length,
               save_name_scenario_report: 'feature_optimization',
               run_resilience: @opthash.subopts[:reopt_resilience],
-              keep_existing_output: @opthash.subopts[:reopt_keep_existing]
+              keep_existing_output: @opthash.subopts[:reopt_keep_existing],
+              groundmount_photovoltaic: groundmount_photovoltaic
             )
           results << { "process_type": 'reopt_feature', "status": 'Complete', "timestamp": Time.now.strftime('%Y-%m-%dT%k:%M:%S.%L') }
           puts "\nDone\n"
@@ -971,11 +1005,16 @@ module URBANopt
         scenario_folders = []
         scenario_report_exists = false
         Dir.glob(File.join(run_dir, '/*_scenario')) do |scenario_folder|
-          scenario_report = File.join(scenario_folder, 'default_scenario_report.csv')
-          if File.exist?(scenario_report)
-            scenario_folders << scenario_folder
+          scenario_report = File.join(scenario_folder, 'scenario_optimization.csv')
+          # Check if Scenario Optimization REopt file exists and add that
+          if File.exist?(File.join(scenario_folder, 'scenario_optimization.csv'))
+            scenario_folders << File.join(scenario_folder, 'scenario_optimization.csv')
             scenario_report_exists = true
-          else
+          # Check if Default Feature Report exists and add that
+          elsif File.exist?(File.join(scenario_folder, 'default_scenario_report.csv'))
+            scenario_folders << File.join(scenario_folder, 'default_scenario_report.csv')
+            scenario_report_exists = true
+          elsif
             puts "\nERROR: Default reports not created for #{scenario_folder}. Please use 'process --default' to create default post processing reports for all scenarios first. Visualization not generated for #{scenario_folder}.\n"
           end
         end
@@ -1011,11 +1050,14 @@ module URBANopt
         feature_folders = []
         # loop through building feature ids from scenario csv
         csv['Feature Id'].each do |feature|
-          feature_report = File.join(run_dir, feature, 'feature_reports')
-          if File.exist?(feature_report)
+          # Check if Feature Optimization REopt file exists and add that
+          if File.exist?(File.join(run_dir, feature, 'feature_reports/feature_optimization.csv'))
             feature_report_exists = true
-            feature_folders << File.join(run_dir, feature)
-          else
+            feature_folders << File.join(run_dir, feature, 'feature_reports/feature_optimization.csv')
+          elsif File.exist?(File.join(run_dir, feature, 'feature_reports/default_feature_report.csv'))
+            feature_report_exists = true
+            feature_folders << File.join(run_dir, feature, 'feature_reports/default_feature_report.csv')
+          elsif
             puts "\nERROR: Default reports not created for #{feature}. Please use 'process --default' to create default post processing reports for all features first. Visualization not generated for #{feature}.\n"
           end
         end

data/uo_cli.gemspec

@@ -34,11 +34,11 @@ Gem::Specification.new do |spec|
 
   #   use specific versions of urbanopt and openstudio dependencies while under heavy development
   spec.add_runtime_dependency 'optimist', '~> 3'
-  spec.add_runtime_dependency 'urbanopt-geojson', '~> 0.6.5'
-  spec.add_runtime_dependency 'urbanopt-reporting', '~> 0.4.1'
-  spec.add_runtime_dependency 'urbanopt-scenario', '~> 0.6.2'
-  spec.add_runtime_dependency 'urbanopt-reopt', '~> 0.6.1'
-  spec.add_runtime_dependency 'urbanopt-rnm-us', '~> 0.1.0'
+  spec.add_runtime_dependency 'urbanopt-geojson', '~> 0.6.6'
+  spec.add_runtime_dependency 'urbanopt-reporting', '~> 0.4.2'
+  spec.add_runtime_dependency 'urbanopt-scenario', '~> 0.6.3'
+  spec.add_runtime_dependency 'urbanopt-reopt', '~> 0.6.2'
+  spec.add_runtime_dependency 'urbanopt-rnm-us', '~> 0.1.1'
 
   spec.add_development_dependency 'bundler', '>= 2.1.0'
   spec.add_development_dependency 'rake', '~> 13.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-cli
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Nathan Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-23 00:00:00.000000000 Z
+date: 2021-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optimist
@@ -30,70 +30,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.5
+        version: 0.6.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.5
+        version: 0.6.6
 - !ruby/object:Gem::Dependency
   name: urbanopt-reporting
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: urbanopt-scenario
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: urbanopt-reopt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: urbanopt-rnm-us
   requirement: !ruby/object:Gem::Requirement
     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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -209,11 +209,13 @@ files:
 - example_files/example_floorspace_project.json
 - example_files/example_project.json
 - example_files/example_project_combined.json
+- example_files/example_project_with_PV.json
 - example_files/example_project_with_electric_network.json
 - example_files/example_project_with_streets.json
 - example_files/mappers/Baseline.rb
 - example_files/mappers/CreateBar.rb
 - example_files/mappers/EvCharging.rb
+- example_files/mappers/FlexibleHotWater.rb
 - example_files/mappers/Floorspace.rb
 - example_files/mappers/HighEfficiency.rb
 - example_files/mappers/HighEfficiencyCreateBar.rb