urbanopt-reopt 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08720d2d382b148c63ee68975a27430291e55874404f84b9a41e6ae24b2f7243'
-  data.tar.gz: 288f60fd246337f62e770197e452237ccef0519ce36d16b60503b454397f9ae2
+  metadata.gz: 6f914ce58eb625102b9e996099d74ad53c12a8db4cd4c169222b04c62983a210
+  data.tar.gz: 1292d94d05fa38dafc702b11b4c50732ed4331e4d1d38f2e949d5c93b6e023c3
 SHA512:
-  metadata.gz: fe5c4c30111deb10c1a5b7e3a804ecb3d666feb3c3f8e40705046a531c765c6fbea4e47f725b4e9b7cfa7dff716c9a12b1250058bc1b5d6a57faa4bb4f0b0f1c
-  data.tar.gz: 034bf2e923102c9c30cc7f1aee476c3c580e9d27750988bf38ea654db2b8f285c4e9dbe12f8993562f53bb1a467bab38c85555f7ad63e7f93dd376f22c0983b2
+  metadata.gz: 4632f539ed5e68dde1dd5ae579f5606b0201a9083b7eaccaf77229f4320230074f0dccce601c1b13418da1900d3a599f4e0a7b79929f3352e86680bc81d1c50c
+  data.tar.gz: 630e01b66eae49563eb947d360c76b889c46f694d464cdf7f31352d5f73f2702917db2fb3545af18e042bd8899ffc502578bd2418296c8ec15d730984bf71a31

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # URBANopt REopt Gem
 
+## Version 1.2.0
+
+* Updates for name change and license
+* Lifecycle Cost Analysis (LCCA) Functionality for UO-REopt GHP workflow
+* Updates to support system parameters file schema changes
+* Updates to support URBANopt-REopt Cost Analysis capabilities
+
 ## Version 1.1.0
 
 * Upgrade to OpenStudio 3.10 

data/CONTRIBUTING.md

@@ -10,7 +10,7 @@ The contribution process for URBANopt is composed of three steps:
 
 In order for us to distribute your code as part of URBANopt under the URBANopt SDK [license](https://github.com/urbanopt/urbanopt-reopt-gem/blob/develop/LICENSE.md), we’ll need your consent. An email acknowledging your understanding of these terms and agreeing to them is all that will be asked of any contributor. Send an email to the URBANopt project manager ([see below](#documentation) for the address) including the following text and a list of co-contributors (if any):
 
-*I agree to contribute to the URBANopt SDK. I agree to the following terms and conditions for my contributions: First, I agree that I am licensing the copyright to my contributions under the terms of the current URBANopt SDK license. Second, I hereby grant to Alliance for Sustainable Energy, LLC, to any successor manager and distributor of URBANopt SDK appointed by the U.S. Department of Energy, and to all recipients of a version of URBANopt SDK that includes my contributions, a non-exclusive, worldwide, royalty-free, irrevocable patent license under any patent claims owned by me, or owned by my employer and known to me, that are or will be,necessarily infringed upon by my contributions alone, or by combination of my contributions with the version of URBANopt SDK to which they are contributed, to make, have made, use, offer to sell, sell, import, and otherwise transfer any version of URBANopt SDK that includes my contributions, in source code and object code form. Third, I represent and warrant that I am authorized to make the contributions and grant the foregoing license(s). Additionally, if, to my knowledge, my employer has rights to intellectual property that covers my contributions, I represent and warrant that I have received permission to make these contributions and grant the foregoing license(s) on behalf of my employer.*
+*I agree to contribute to the URBANopt SDK. I agree to the following terms and conditions for my contributions: First, I agree that I am licensing the copyright to my contributions under the terms of the current URBANopt SDK license. Second, I hereby grant to Alliance for Energy Innovation, LLC, to any successor manager and distributor of URBANopt SDK appointed by the U.S. Department of Energy, and to all recipients of a version of URBANopt SDK that includes my contributions, a non-exclusive, worldwide, royalty-free, irrevocable patent license under any patent claims owned by me, or owned by my employer and known to me, that are or will be,necessarily infringed upon by my contributions alone, or by combination of my contributions with the version of URBANopt SDK to which they are contributed, to make, have made, use, offer to sell, sell, import, and otherwise transfer any version of URBANopt SDK that includes my contributions, in source code and object code form. Third, I represent and warrant that I am authorized to make the contributions and grant the foregoing license(s). Additionally, if, to my knowledge, my employer has rights to intellectual property that covers my contributions, I represent and warrant that I have received permission to make these contributions and grant the foregoing license(s) on behalf of my employer.*
 
 Once we have your consent on file, you’ll only need to redo it if conditions change (e.g. a change of employer).
 
@@ -53,6 +53,6 @@ URBANopt Project Management\
 ben.polly@nrel.gov\
 (303) 384-7429
 
-URBANopt is funded by the U.S. Department of Energy (DOE) and managed by the National Renewable Energy Laboratory (NREL).
+URBANopt is funded by the U.S. Department of Energy (DOE) and managed by the National Laboratory of the Rockies (NLR).
 
-URBANopt is developed in collaboration with NREL, LBNL, and private firms.
+URBANopt is developed in collaboration with NLR, LBNL, and private firms.

data/Gemfile

@@ -17,7 +17,7 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # if allow_local && File.exist?('../OpenStudio-extension-gem')
 #   gem 'openstudio-extension', path: '../OpenStudio-extension-gem'
 # elsif allow_local
-#   gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'faraday'
+#   gem 'openstudio-extension', github: 'NatLabRockies/OpenStudio-extension-gem', branch: 'develop'
 # else
 #   gem 'openstudio-extension', '~> 0.8.1'
 # end
@@ -25,7 +25,7 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # if allow_local && File.exist?('../openstudio-common-measures-gem')
 #   gem 'openstudio-common-measures', path: '../openstudio-common-measures-gem'
 # elsif allow_local
-#   gem 'openstudio-common-measures', github: 'NREL/openstudio-common-measures-gem', branch: 'faraday'
+#   gem 'openstudio-common-measures', github: 'NatLabRockies/openstudio-common-measures-gem', branch: 'develop'
 # else
 #  gem 'openstudio-common-measures', '0.12.3'
 # end
@@ -33,13 +33,13 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # if allow_local && File.exist?('../urbanopt-core-gem')
 #   gem 'urbanopt-core', path: '../urbanopt-core-gem'
 # elsif allow_local
-#   gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'faraday'
+#   gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'develop'
 # end
 #
 # if allow_local && File.exist?('../openstudio-model-articulation-gem')
 #   gem 'openstudio-model-articulation', path: '../openstudio-model-articulation-gem'
 # elsif allow_local
-#   gem 'openstudio-model-articulation', github: 'NREL/openstudio-model-articulation-gem', branch: 'faraday'
+#   gem 'openstudio-model-articulation', github: 'NatLabRockies/openstudio-model-articulation-gem', branch: 'develop'
 # else
 #  gem 'openstudio-model-articulation', '0.12.2'
 # end
@@ -47,11 +47,18 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # if allow_local && File.exist?('../urbanopt-scenario-gem')
 #   gem 'urbanopt-scenario', path: '../urbanopt-scenario-gem'
 # elsif allow_local
-#   gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'faraday'
+#   gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
 # end
 
 # if allow_local && File.exist?('../urbanopt-geojson-gem')
 #   gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
 # elsif allow_local
-#   gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'faraday'
+#   gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
+# end
+
+
+# if allow_local && File.exist?('../urbanopt-geojson-gem')
+#   gem 'urbanopt-reporting', path: '../urbanopt-reporting-gem'
+# elsif allow_local
+#   gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
 # end

data/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2026, Alliance for Energy Innovation, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/RDOC_MAIN.md

@@ -5,7 +5,7 @@ REopt is a technoeconomic model which leverages mixed integer linear programming
 
 See the [example project](https://github.com/urbanopt/urbanopt-example-reopt-project.git) for more infomation about usage of this gem.
 
-<b>Note:</b> This module requires an API Key from the [NREL Developer Network](https://developer.nrel.gov/)
+<b>Note:</b> This module requires an API Key from the [NLR Developer Network](https://developer.nrel.gov/)
 
 ## Installation
 
@@ -157,7 +157,7 @@ updated_scenario_report = reopt_post_processor.run_scenario_report(scenario_repo
 
 First, check out the repository (i.e. git clone this repo).
 
-Next, obtain a developer.nrel.gov API key from the [NREL Developer Network](https://developer.nrel.gov/]). Copy and paste your key in to the _developer_nrel_key_._rb_ file then save the file:
+Next, obtain a developer.nrel.gov API key from the [NLR Developer Network](https://developer.nrel.gov/]). Copy and paste your key in to the _developer_nrel_key_._rb_ file then save the file:
 
     DEVELOPER_NREL_KEY = '<insert your key here>'
 

data/README.md

@@ -9,7 +9,7 @@ REopt is a technoeconomic model which leverages mixed integer linear programming
 See the [example project](https://github.com/urbanopt/urbanopt-example-geojson-reopt-project) for more infomation about usage of this gem.
 
 <b>Note:</b> this module requires an API Key from the
-[NREL Developer Network](https://developer.nrel.gov/)
+[NLR Developer Network](https://developer.nrel.gov/)
 
 [RDoc Documentation](https://urbanopt.github.io/urbanopt-reopt-gem/)
 
@@ -161,7 +161,7 @@ updated_scenario_report = reopt_post_processor.run_scenario_report(scenario_repo
 
 First, check out the repository (i.e. git clone this repo).
 
-Next, obtain a developer.nrel.gov API key from the [NREL Developer Network](https://developer.nrel.gov/]). Copy and paste your key in to the _developer_nrel_key_._rb_ file then save the file:
+Next, obtain a developer.nrel.gov API key from the [NLR Developer Network](https://developer.nrel.gov/]). Copy and paste your key in to the _developer_nrel_key_._rb_ file then save the file:
 
     DEVELOPER_NREL_KEY = '<insert your key here>'
 

data/Rakefile

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2026, Alliance for Energy Innovation, LLC, and other
 # contributors. All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without modification,

data/developer_nrel_key.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# URBANopt (tm), Copyright (c) Alliance for Energy Innovation, LLC.
 # See also https://github.com/urbanopt/urbanopt-reopt-gem/blob/develop/LICENSE.md
 # *********************************************************************************
 

data/doc_templates/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2026, Alliance for Energy Innovation, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/doc_templates/copyright_erb.txt

@@ -1,6 +1,6 @@
 <%
   # *********************************************************************************
-  # URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
+  # URBANopt (tm), Copyright (c) 2019-2026, Alliance for Energy Innovation, LLC, and other
   # contributors. All rights reserved.
 
   # Redistribution and use in source and binary forms, with or without modification,

data/doc_templates/copyright_js.txt

@@ -1,4 +1,4 @@
 /* @preserve
- * URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+ * URBANopt (tm), Copyright (c) Alliance for Energy Innovation, LLC.
  * See also https://github.com/urbanopt/urbanopt-reopt-gem/blob/develop/LICENSE.md
 */

data/doc_templates/copyright_ruby.txt

@@ -1,4 +1,4 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# URBANopt (tm), Copyright (c) Alliance for Energy Innovation, LLC.
 # See also https://github.com/urbanopt/urbanopt-reopt-gem/blob/develop/LICENSE.md
 # *********************************************************************************

data/docs/README.md

@@ -20,7 +20,7 @@ Moreover, the REopt Gem can be run in several modes, either on:
 
 See the <StaticLink target="\_blank" href="https://github.com/urbanopt/urbanopt-example-reopt-project.git">example project</StaticLink> for more infomation about usage of this gem.
 
-<b>Note:</b> This module requires an API Key from the <StaticLink target='blank' href="https://developer.nrel.gov/">NREL Developer Network</StaticLink>.
+<b>Note:</b> This module requires an API Key from the <StaticLink target='blank' href="https://developer.nrel.gov/">NLR Developer Network</StaticLink>.
 
 <StaticLink target="\_blank" href="https://urbanopt.github.io/urbanopt-reopt-gem/">RDoc Documentation</StaticLink>
 
@@ -177,7 +177,7 @@ updated_scenario_report = reopt_post_processor.run_scenario_report(scenario_repo
 
 First, check out the repository (i.e. git clone this repo).
 
-Next, obtain a developer.nrel.gov API key from the [NREL Developer Network](https://developer.nrel.gov/]). Copy and paste your key in to the _developer_nrel_key_._rb_ file then save the file:
+Next, obtain a developer.nrel.gov API key from the [NLR Developer Network](https://developer.nrel.gov/]). Copy and paste your key in to the _developer_nrel_key_._rb_ file then save the file:
 
     DEVELOPER_NREL_KEY = '<insert your key here>'
 

data/docs/package.json

@@ -8,7 +8,7 @@
     "build": "vuepress build",
     "deploy": "gh-pages -d .vuepress/dist"
   },
-  "author": "NREL",
+  "author": "NLR",
   "dependencies": {
     "highlight.js": "^10.4.1",
     "json-schema-ref-parser": "^6.1.0",

data/index.md

@@ -5,7 +5,7 @@ REopt is a technoeconomic model which leverages mixed integer linear programming
 
 See the [example project](https://github.com/urbanopt/urbanopt-example-reopt-project.git) for more infomation about usage of this gem.
 
-<b>Note:</b> This module requires an API Key from the [NREL Developer Network](https://developer.nrel.gov/)
+<b>Note:</b> This module requires an API Key from the [NLR Developer Network](https://developer.nrel.gov/)
 
 ## Installation
 
@@ -157,7 +157,7 @@ updated_scenario_report = reopt_post_processor.run_scenario_report(scenario_repo
 
 First, check out the repository (i.e. git clone this repo).
 
-Next, obtain a developer.nrel.gov API key from the [NREL Developer Network](https://developer.nrel.gov/]). Copy and paste your key in to the _developer_nrel_key_._rb_ file then save the file:
+Next, obtain a developer.nrel.gov API key from the [NLR Developer Network](https://developer.nrel.gov/]). Copy and paste your key in to the _developer_nrel_key_._rb_ file then save the file:
 
     DEVELOPER_NREL_KEY = '<insert your key here>'
 

data/lib/urbanopt/reopt/extension.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# URBANopt (tm), Copyright (c) Alliance for Energy Innovation, LLC.
 # See also https://github.com/urbanopt/urbanopt-reopt-gem/blob/develop/LICENSE.md
 # *********************************************************************************
 

data/lib/urbanopt/reopt/feature_report_adapter.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# URBANopt (tm), Copyright (c) Alliance for Energy Innovation, LLC.
 # See also https://github.com/urbanopt/urbanopt-reopt-gem/blob/develop/LICENSE.md
 # *********************************************************************************
 
@@ -158,8 +158,8 @@ module URBANopt # :nodoc:
       # [*return:*] _URBANopt::Reporting::DefaultReports::FeatureReport_ - Returns an updated FeatureReport.
       ##
       def update_feature_report(feature_report, reopt_output, timeseries_csv_path = nil, resilience_stats = nil)
-        # Check if the \REopt response is valid
-        if reopt_output['status'] != 'optimal'
+        # Check if the REopt response is valid
+        if reopt_output['status'] != 'optimal' && reopt_output['status'] != 'Completed'
           @@logger.error("ERROR cannot update Feature Report #{feature_report.name} #{feature_report.id}  - REopt optimization was non-optimal")
           return feature_report
         end
@@ -182,14 +182,13 @@ module URBANopt # :nodoc:
         feature_report.distributed_generation.year_one_bill_before_tax_bau = reopt_output['outputs']['ElectricTariff']['year_one_bill_before_tax_bau'] || 0
         feature_report.distributed_generation.lifecycle_demand_cost_after_tax_bau = reopt_output['outputs']['ElectricTariff']['lifecycle_demand_cost_after_tax_bau'] || 0
         feature_report.distributed_generation.lifecycle_energy_cost_after_tax_bau = reopt_output['outputs']['ElectricTariff']['lifecycle_energy_cost_after_tax_bau'] || 0
-        if !resilience_stats.nil?
-          feature_report.distributed_generation.resilience_hours_min = resilience_stats['resilience_hours_min']
-          feature_report.distributed_generation.resilience_hours_max = resilience_stats['resilience_hours_max']
-          feature_report.distributed_generation.resilience_hours_avg = resilience_stats['resilience_hours_avg']
-          feature_report.distributed_generation.probs_of_surviving = resilience_stats['probs_of_surviving']
-          feature_report.distributed_generation.probs_of_surviving_by_month = resilience_stats['probs_of_surviving_by_month']
-          feature_report.distributed_generation.probs_of_surviving_by_hour_of_the_day = resilience_stats['probs_of_surviving_by_hour_of_the_day']
-        end
+
+        # Additional Cost Analysis Fields (includes NPV already added above)
+        feature_report.distributed_generation.initial_capital_costs = reopt_output['outputs']['Financial']['initial_capital_costs']
+        feature_report.distributed_generation.initial_capital_costs_after_incentives = reopt_output['outputs']['Financial']['initial_capital_costs_after_incentives']
+        feature_report.distributed_generation.lifecycle_capital_costs = reopt_output['outputs']['Financial']['lifecycle_capital_costs']
+        feature_report.distributed_generation.lifecycle_fuel_costs_after_tax = reopt_output['outputs']['Financial']['lifecycle_fuel_costs_after_tax']
+        feature_report.distributed_generation.lifecycle_elecbill_after_tax = reopt_output['outputs']['Financial']['lifecycle_elecbill_after_tax']
 
         if reopt_output['outputs']['PV'].is_a?(Hash)
           reopt_output['outputs']['PV'] = [reopt_output['outputs']['PV']]