urbanopt-reopt 0.3.0 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b8c1ac7b139511b12d9072845a021f0d2ff3cff83c7196745d59c7551ed860f
-  data.tar.gz: dab8c9d42333c9f8c65ea9a65dcc7809a379e09abe8f82c3eeae0b2695dce9a9
+  metadata.gz: 6f0f86844f3e29a25c87ebff9c818f5dc4a4554b80c0b455ddaae85f98c47093
+  data.tar.gz: d439583ce26cb0c236186e20549310bb557b0c0a9c6348844198427c931f7774
 SHA512:
-  metadata.gz: 3f7da7475d7698b59fc7f09ac7f8d6f740176b5c6df6e17e2f0b379c3141bdcd74e75e254d23b5aeb7a7774501c25e290978921fb193788ccfaf6070ab1a8ae2
-  data.tar.gz: f48084345aabcfaf04f898337e071c47a4c57db03da4c0e7a98758704e438eb6429ece50f3362239f88e74af4c426de23aa5ad075619831b2857b5a29af7f2b6
+  metadata.gz: 6bc02806faa4366ed1dbb0eb53baa221b0d06b8a096f0a3bb8d9833c51d3c4846853f5b4fc477082baf546925365f25d4dc5b507bc4f6e6da820631f03f35bb8
+  data.tar.gz: 2fab1cd48a34c055adb4ea0e66aaf69b0e81c51e26b0bca8bdee30e4b5b454ae944f8e00175f0a5dc8f66b319377bcde1e0bdb4030525c9bb00a6e33e4dc7f3a

data/.github/pull_request_template.md

@@ -1,4 +1,4 @@
-### Addresses #[issue number here]
+### Resolves #[issue number here]
 
 ### Pull Request Description
 
@@ -9,5 +9,5 @@
 - [ ] Unit tests have been added or updated
 - [ ] Documentation has been modified appropriately
 - [ ] All ci tests pass (green)
-- [ ] An [ISSUE](https://github.com/urbanopt/urbanopt-cli/issues) has been created that this is addressing. Issues will get added to the Change Log when the change_log.rb script is run
+- [ ] An [issue](https://github.com/urbanopt/urbanopt-reopt-gem/issues) has been created (which will be used for the changelog)
 - [ ] This branch is up-to-date with develop

data/.gitignore

@@ -15,6 +15,9 @@
 /test/
 /lib/measures/test_results
 /lib/measures/.rubocop*
+# test files
+spec/run/
+
 developer_nrel_key.rb
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -1,5 +1,78 @@
 # URBANopt REopt Gem
+
+## Version 0.5.5
+
+Date range: 2/8/21 - 3/12/21
+* Fixes a bug that shifts REopt Lite timeseries data by 24 hours in **Feature** and **Scenario Report** CSV's
+
+## Version 0.5.4
+
+Date range: 2/8/21 - 2/25/21
+* Converts **Feature** and **Scenario Report** native timeseries data (i.e. load profile, optimized dispatches) to/from the specified **REopt Lite** time series resolution (defaulted to 1 timestep per hour), such that **OpenStudio** can be run at 10-minute intervals and **REopt Lite** at 1-hour or 15-minute intervals.
+
+
+## Version 0.5.3
+
+Date range: 1/21/21 - 2/8/21
+* **Storage** should not be considered in total production CSV series
+* **coincident_peak_load_charge_us_dollars_per_kw** should be defaulted to 0
+
+## Version 0.5.2
+
+Date range: 1/08/21 - 1/21/21
+* Adds default coincident peak load (top 100 hours) if not specified in assumptions file to a REopt Lite post
+* Specifies coincident peak price as 0 in test assumptions file to turn it off
+* Allows default roof area, land area and timesteps per hour to be overwritten by assumptions file when creating a REopt Lite post
+
+
+## Version 0.5.1
+
+Date range: 12/11/20 - 1/08/21
+
+* Extend polling time for resilience results
+* Do not error out if there are no resilience results
+* Handle renamed available_roof_area_sqft parameter (had been available_roof_area)
+
+
+## Version 0.5.0
+
+Date range: 11/13/20 - 12/11/20
+
+* Updates to support OpenStudio 3.1  
+
  
+## Version 0.4.1
+
+Date range: 9/23/20 - 11/12/20
+
+* PR template now automatically closes issue on merge
+* Remove unnecessary require statement
+* Reporting bugfix
+* Working with reporting gem updates
+
+
+## Version 0.4.0
+
+Date range: 6/5/20 - 9/22/20
+
+* Changes to support the new reporting gem
+* Parsing additional results from the REopt Lite API: 
+  - lcc_bau_us_dollars
+  - year_one_energy_cost_bau_us_dollars
+  - year_one_demand_cost_bau_us_dollars
+  - year_one_bill_bau_us_dollars
+  - total_energy_cost_bau_us_dollars
+  - total_demand_cost_us_dollars
+  - total_demand_cost_bau_us_dollars
+* Makes separate calls to the REopt Lite API for new resilience statistics:
+  - resilience_hours_min
+  - resilience_hours_max
+  - resilience_hours_avg
+  - probs_of_surviving
+  - probs_of_surviving_by_month
+  - probs_of_surviving_by_hour_of_the_day
+
+
 ## Version 0.3.0
 
 * Updating to support OpenStudio 3.0 and Ruby 2.5

data/CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 ## Version 1.0
 
-The URBANopt team welcomes your contribution to the project. You can contribute to the URBANopt project in several ways: by using the software, reporting issues, contributing documentation, or contributing code back to the project. The GitHub [Contributing to Open Source](https://opensource.guide/how-to-contribute/) guide provides a good overview. If you contribute code, you agree that your contribution may be incorporated into the URBANopt Software Development Kit (SDK) and made available under the URBANopt SDK license.
+The URBANopt<sup>&trade;</sup> team welcomes your contribution to the project. You can contribute to the URBANopt project in several ways: by using the software, reporting issues, contributing documentation, or contributing code back to the project. The GitHub [Contributing to Open Source](https://opensource.guide/how-to-contribute/) guide provides a good overview. If you contribute code, you agree that your contribution may be incorporated into the URBANopt Software Development Kit (SDK) and made available under the URBANopt SDK license.
 
 The contribution process for URBANopt is composed of three steps:
 

data/Gemfile

@@ -44,7 +44,7 @@ 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: 'develop'
+#  gem 'urbanopt-scenario', github: 'URBANopt/urbanopt-scenario-gem', branch: 'develop'
 # end
 
 # if allow_local && File.exists?('../urbanopt-geojson-gem')
@@ -53,7 +53,4 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 #   gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
 # end
 
-# Support requests in windows
-# gem 'certified'
-
-gem 'rdoc', '4.3.0'
+# gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'

data/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC. All rights reserved.
+URBANopt<sup>&trade;</sup>, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted 
 provided that the following conditions are met:

data/RDOC_MAIN.md

@@ -1,7 +1,7 @@
 # **URBANopt REopt Gem**
 
-The **URBANopt REopt Gem** extends **URBANopt::Scenario::DefaultReports::ScenarioReport** and **URBANopt::Scenario::DefaultReports::FeatureReport** with the ability to derive cost-optimal distributed energy resource (DER) technology sizes and annual dispatch strageties via the [REopt Lite](https://reopt.nrel.gov/tool) decision support platform. 
-REopt Lite is a technoeconomic model which leverages mixed integer linear programming to identify the cost-optimal sizing of solar PV, Wind, Storage and/or diesel generation given an electric load profile, a utility rate tariff and other technoeconomic parameters. See [https://developer.nrel.gov/docs/energy-optimization/reopt-v1/](https://developer.nrel.gov/docs/energy-optimization/reopt-v1/) for more detailed information on input parameters and default assumptions. 
+The **URBANopt™ REopt Gem** extends **URBANopt::Reporting::DefaultReports::ScenarioReport** and **URBANopt::Reporting::DefaultReports::FeatureReport** with the ability to derive cost-optimal distributed energy resource (DER) technology sizes and annual dispatch strageties via the [REopt Lite](https://reopt.nrel.gov/tool) decision support platform.
+REopt Lite is a technoeconomic model which leverages mixed integer linear programming to identify the cost-optimal sizing of solar PV, Wind, Storage and/or diesel generation given an electric load profile, a utility rate tariff and other technoeconomic parameters. See [https://developer.nrel.gov/docs/energy-optimization/reopt-v1/](https://developer.nrel.gov/docs/energy-optimization/reopt-v1/) for more detailed information on input parameters and default assumptions.
 
 See the [example project](https://github.com/urbanopt/urbanopt-example-reopt-project.git) for more infomation about usage of this gem.
 
@@ -9,7 +9,7 @@ See the [example project](https://github.com/urbanopt/urbanopt-example-reopt-pro
 
 ## Installation
 
-See [https://docs.urbanopt.net/installation/installation.html](https://docs.urbanopt.net/installation/installation.html) for instructions on prerequiste software, including: 
+See [https://docs.urbanopt.net/installation/installation.html](https://docs.urbanopt.net/installation/installation.html) for instructions on prerequiste software, including:
 - Ruby 2.2.6
 - Bundler 1.17.0
 - OpenStudio 2.8.1
@@ -31,7 +31,7 @@ Or install it yourself as:
 
 ## Functionality
 
-This gem is used to call the REopt Lite API on a Scenario Report or Feature Report to update the object's Distributed Generation attributes (including system financial and sizing metrics) as shown in an example below: 
+This gem is used to call the REopt Lite API on a Scenario Report or Feature Report to update the object's Distributed Generation attributes (including system financial and sizing metrics) as shown in an example below:
 
 ```
 	"distributed_generation": {
@@ -83,7 +83,7 @@ Moreover, the following optimal dispatch fields are added to its timeseries CSV.
 | ElectricityProduced:Wind:ToGrid          | kWh     |
 ```
 
-The REopt Lite has default values for all non-required input parameters that are used unless the user specifies custom assumptions. See [https://developer.nrel.gov/docs/energy-optimization/reopt-v1/](https://developer.nrel.gov/docs/energy-optimization/reopt-v1/) for more detailed information on input parameters and default assumptions. 
+The REopt Lite has default values for all non-required input parameters that are used unless the user specifies custom assumptions. See [https://developer.nrel.gov/docs/energy-optimization/reopt-v1/](https://developer.nrel.gov/docs/energy-optimization/reopt-v1/) for more detailed information on input parameters and default assumptions.
 
 <b>Note:</b> Required attributes for a REopt run include latitude and longitude. If no utility rate is specified in your REopt Lite assumption settings, then a constant default rate of $0.13 is assumed without demand charges. Also, by default, only solar PV and storage are considered in the analysis (i.e. Wind and Generators are excluded from consideration).
 
@@ -99,7 +99,7 @@ require 'urbanopt/reopt'
 feature_reports_hash = {} # <insert a Feature Report hash here>
 
 #Create a Feature Report
-feature_report = URBANopt::Scenario::DefaultReports::FeatureReport.new(feature_reports_hash)
+feature_report = URBANopt::Reporting::DefaultReports::FeatureReport.new(feature_reports_hash)
 
 #Specify a file name where REopt Lite results will be written in JSON format
 reopt_output_file = File.join(feature_report.directory_name, 'feature_report_reopt_run1.json')
@@ -115,7 +115,7 @@ reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(nil, nil, nil, DE
 
 #Call REopt Lite with the post processor to update the feature's distributed generation attributes and timeseries CSV.
 updated_feature_report = reopt_post_processor.run_feature_report(feature_report,reopt_assumptions_file,reopt_output_file,timeseries_output_file)
-    
+
 ```
 
 More commonly, this gem can be used to run REopt a collection of features stored in a Scenario Report as show here:
@@ -123,9 +123,9 @@ More commonly, this gem can be used to run REopt a collection of features stored
 ```ruby
 require 'urbanopt/reopt'
 #Create a Scenario Report
-scenario_report = URBANopt::Scenario::DefaultReports::ScenarioReport.new({:directory_name => File.join(File.dirname(__FILE__), '../run/example_scenario'), :timeseries_csv => {:path => File.join(File.dirname(__FILE__), '../run/example_scenario/timeseries.csv') }})
+scenario_report = URBANopt::Reporting::DefaultReports::ScenarioReport.new({:directory_name => File.join(File.dirname(__FILE__), '../run/example_scenario'), :timeseries_csv => {:path => File.join(File.dirname(__FILE__), '../run/example_scenario/timeseries.csv') }})
 
-#Load Feature Reports into the Scenario Report     
+#Load Feature Reports into the Scenario Report
 (1..2).each do |i|
   feature_reports_path = File.join(File.dirname(__FILE__), "../run/example_scenario/#{i}/010_default_feature_reports/default_feature_reports.json")
 
@@ -134,8 +134,8 @@ scenario_report = URBANopt::Scenario::DefaultReports::ScenarioReport.new({:direc
     feature_reports_hash = JSON.parse(file.read, symbolize_names: true)
   end
 
-  feature_report = URBANopt::Scenario::DefaultReports::FeatureReport.new(feature_reports_hash)
-  
+  feature_report = URBANopt::Reporting::DefaultReports::FeatureReport.new(feature_reports_hash)
+
   feature_report_dir = File.join(File.dirname(__FILE__), "../run/example_scenario/#{i}")
   feature_report.directory_name = feature_report_dir
 
@@ -150,7 +150,7 @@ reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(scenario_report,
 
 #Call REopt Lite with the post processor once on the sceanrio's aggregated load to update the scenario's distributed generation attributes and timeseries CSV.
 updated_scenario_report = reopt_post_processor.run_scenario_report(scenario_report)
-    
+
 ```
 
 ## Testing
@@ -164,7 +164,7 @@ Next, obtain a developer.nrel.gov API key from the [NREL Developer Network](http
 Finally, execute:
 
     $ bundle install
-    $ bundle update    
+    $ bundle update
     $ bundle exec rake
 
 

data/README.md

@@ -1,11 +1,11 @@
 # URBANopt REopt Gem
 
-The **URBANopt REopt Gem** extends **URBANopt::Scenario::DefaultReports::ScenarioReport** and **URBANopt::Scenario::DefaultReports::FeatureReport** with the ability to derive cost-optimal distributed energy resource (DER) technology sizes and annual dispatch strageties via the [REopt Lite](https://reopt.nrel.gov/tool) decision support platform. 
-REopt Lite is a technoeconomic model which leverages mixed integer linear programming to identify the cost-optimal sizing of solar PV, Wind, Storage and/or diesel generation given an electric load profile, a utility rate tariff and other technoeconomic parameters. See [https://developer.nrel.gov/docs/energy-optimization/reopt-v1/](https://developer.nrel.gov/docs/energy-optimization/reopt-v1/) for more detailed information on input parameters and default assumptions. 
+The **URBANopt<sup>&trade;</sup> REopt Gem** extends **URBANopt::Reporting::DefaultReports::ScenarioReport** and **URBANopt::Reporting::DefaultReports::FeatureReport** with the ability to derive cost-optimal distributed energy resource (DER) technology sizes and annual dispatch strageties via the [REopt Lite](https://reopt.nrel.gov/tool) decision support platform.
+REopt Lite is a technoeconomic model which leverages mixed integer linear programming to identify the cost-optimal sizing of solar PV, Wind, Storage and/or diesel generation given an electric load profile, a utility rate tariff and other technoeconomic parameters. See [https://developer.nrel.gov/docs/energy-optimization/reopt-v1/](https://developer.nrel.gov/docs/energy-optimization/reopt-v1/) for more detailed information on input parameters and default assumptions.
 
 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 
+<b>Note:</b> this module requires an API Key from the
 [NREL Developer Network](https://developer.nrel.gov/)
 
 [RDoc Documentation](https://urbanopt.github.io/urbanopt-reopt-gem/)
@@ -13,7 +13,7 @@ See the [example project](https://github.com/urbanopt/urbanopt-example-geojson-r
 
 ## Installation
 
-See [https://docs.urbanopt.net/installation/installation.html](https://docs.urbanopt.net/installation/installation.html) for instructions on prerequiste software, including: 
+See [https://docs.urbanopt.net/installation/installation.html](https://docs.urbanopt.net/installation/installation.html) for instructions on prerequiste software, including:
 - Ruby 2.2.6
 - Bundler 1.17.0
 - OpenStudio 2.8.1
@@ -35,7 +35,7 @@ Or install it yourself as:
 
 ## Functionality
 
-This gem is used to call the REopt Lite API on a Scenario Report or Feature Report to update the object's Distributed Generation attributes (including system financial and sizing metrics) as shown in an example below: 
+This gem is used to call the REopt Lite API on a Scenario Report or Feature Report to update the object's Distributed Generation attributes (including system financial and sizing metrics) as shown in an example below:
 ```
 	"distributed_generation": {
 	      "lcc_us_dollars": 100000000.0,
@@ -83,9 +83,9 @@ Moreover, the following optimal dispatch fields are added to its timeseries CSV.
 | ElectricityProduced:Wind:ToBattery       | kWh     |
 | ElectricityProduced:Wind:ToLoad          | kWh     |
 | ElectricityProduced:Wind:ToGrid          | kWh     |
-    
 
-The REopt Lite has default values for all non-required input parameters that are used unless the user specifies custom assumptions. See <StaticLink target="\_blank" href="https://developer.nrel.gov/docs/energy-optimization/reopt-v1/">https://developer.nrel.gov/docs/energy-optimization/reopt-v1/</StaticLink> for more detailed information on input parameters and default assumptions. 
+
+The REopt Lite has default values for all non-required input parameters that are used unless the user specifies custom assumptions. See <StaticLink target="\_blank" href="https://developer.nrel.gov/docs/energy-optimization/reopt-v1/">https://developer.nrel.gov/docs/energy-optimization/reopt-v1/</StaticLink> for more detailed information on input parameters and default assumptions.
 
 <b>Note:</b> Required attributes for a REopt run include latitude and longitude. If no utility rate is specified in your REopt Lite assumption settings, then a constant default rate of $0.13 is assumed without demand charges. Also, by default, only solar PV and storage are considered in the analysis (i.e. Wind and Generators are excluded from consideration).
 
@@ -101,7 +101,7 @@ require 'urbanopt/reopt'
 feature_reports_hash = {} # <insert a Feature Report hash here>
 
 #Create a Feature Report
-feature_report = URBANopt::Scenario::DefaultReports::FeatureReport.new(feature_reports_hash)
+feature_report = URBANopt::Reporting::DefaultReports::FeatureReport.new(feature_reports_hash)
 
 #Specify a file name where REopt Lite results will be written in JSON format
 reopt_output_file = File.join(feature_report.directory_name, 'feature_report_reopt_run1.json')
@@ -117,16 +117,16 @@ reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(nil, nil, nil, DE
 
 #Call REopt Lite with the post processor to update the feature's distributed generation attributes and timeseries CSV.
 updated_feature_report = reopt_post_processor.run_feature_report(feature_report,reopt_assumptions_file,reopt_output_file,timeseries_output_file)
-    
+
 ```
 
 More commonly, this gem can be used to run REopt a collection of features stored in a Scenario Report as show here:
 ```ruby
 require 'urbanopt/reopt'
 #Create a Scenario Report
-scenario_report = URBANopt::Scenario::DefaultReports::ScenarioReport.new({:directory_name => File.join(File.dirname(__FILE__), '../run/example_scenario'), :timeseries_csv => {:path => File.join(File.dirname(__FILE__), '../run/example_scenario/timeseries.csv') }})
+scenario_report = URBANopt::Reporting::DefaultReports::ScenarioReport.new({:directory_name => File.join(File.dirname(__FILE__), '../run/example_scenario'), :timeseries_csv => {:path => File.join(File.dirname(__FILE__), '../run/example_scenario/timeseries.csv') }})
 
-#Load Feature Reports into the Scenario Report     
+#Load Feature Reports into the Scenario Report
 (1..2).each do |i|
   feature_reports_path = File.join(File.dirname(__FILE__), "../run/example_scenario/#{i}/010_default_feature_reports/default_feature_reports.json")
 
@@ -135,8 +135,8 @@ scenario_report = URBANopt::Scenario::DefaultReports::ScenarioReport.new({:direc
     feature_reports_hash = JSON.parse(file.read, symbolize_names: true)
   end
 
-  feature_report = URBANopt::Scenario::DefaultReports::FeatureReport.new(feature_reports_hash)
-  
+  feature_report = URBANopt::Reporting::DefaultReports::FeatureReport.new(feature_reports_hash)
+
   feature_report_dir = File.join(File.dirname(__FILE__), "../run/example_scenario/#{i}")
   feature_report.directory_name = feature_report_dir
 
@@ -151,7 +151,7 @@ reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(scenario_report,
 
 #Call REopt Lite with the post processor once on the sceanrio's aggregated load to update the scenario's distributed generation attributes and timeseries CSV.
 updated_scenario_report = reopt_post_processor.run_scenario_report(scenario_report)
-    
+
 ```
 
 ## Testing
@@ -165,7 +165,7 @@ Next, obtain a developer.nrel.gov API key from the [NREL Developer Network](http
 Finally, execute:
 
     $ bundle install
-    $ bundle update    
+    $ bundle update
     $ bundle exec rake
 
 

data/Rakefile

@@ -1,3 +1,33 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/doc_templates/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other 
+URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, 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, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+  # URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, 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, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
+ * URBANopt™, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
  * Use of this source code is governed by the BSD 3-Clause license.
 */

data/doc_templates/copyright_ruby.txt

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

data/docs/README.md

@@ -2,8 +2,8 @@
 
 ### <StaticLink target="\_blank" href="rdoc/">Rdocs</StaticLink>
 
-The **URBANopt REopt Gem** extends a **URBANopt::Scenario::DefaultReports::ScenarioReport** and **URBANopt::Scenario::DefaultReports::FeatureReport** with the ability to derive cost-optimal distributed energy resource (DER) technology sizes and annual dispatch strageties via the <StaticLink target="\_blank" href="https://reopt.nrel.gov/tool">REopt Lite</StaticLink> decision support platform. 
-REopt Lite is a technoeconomic model which leverages mixed integer linear programming to identify the cost-optimal sizing of solar PV, Wind, Storage and/or diesel generation given an electric load profile, a utility rate tariff and other technoeconomic parameters. See <StaticLink target="\_blank" href="https://developer.nrel.gov/docs/energy-optimization/reopt-v1/">https://developer.nrel.gov/docs/energy-optimization/reopt-v1/</StaticLink> for more detailed information on input parameters and default assumptions. 
+The **URBANopt<sup>&trade;</sup> REopt Gem** extends a **URBANopt::Reporting::DefaultReports::ScenarioReport** and **URBANopt::Reporting::DefaultReports::FeatureReport** with the ability to derive cost-optimal distributed energy resource (DER) technology sizes and annual dispatch strageties via the <StaticLink target="\_blank" href="https://reopt.nrel.gov/tool">REopt Lite</StaticLink> decision support platform.
+REopt Lite is a technoeconomic model which leverages mixed integer linear programming to identify the cost-optimal sizing of solar PV, Wind, Storage and/or diesel generation given an electric load profile, a utility rate tariff and other technoeconomic parameters. See <StaticLink target="\_blank" href="https://developer.nrel.gov/docs/energy-optimization/reopt-v1/">https://developer.nrel.gov/docs/energy-optimization/reopt-v1/</StaticLink> for more detailed information on input parameters and default assumptions.
 
 The REopt Gem accomplishes three basic functions (described more below in the _Functionality_ section):
 
@@ -13,8 +13,8 @@ The REopt Gem accomplishes three basic functions (described more below in the _F
 
 Moreover, the REopt Gem can be run in several modes, either on:
 
- * A Feature Report, 
- * A collection of Feature Reports 
+ * A Feature Report,
+ * A collection of Feature Reports
  * All the features in a Scenario Report before aggregating results at the scenario level
  * The collection of features in aggregate as summarized in a Scenario Report
 
@@ -27,7 +27,7 @@ See the <StaticLink target="\_blank" href="https://github.com/urbanopt/urbanopt-
 
 ## Installation
 
-See [https://docs.urbanopt.net/installation/installation.html](https://docs.urbanopt.net/installation/installation.html) for instructions on prerequiste software, including: 
+See [https://docs.urbanopt.net/installation/installation.html](https://docs.urbanopt.net/installation/installation.html) for instructions on prerequiste software, including:
 - Ruby 2.2.6
 - Bundler 1.17.0
 - OpenStudio 2.8.1
@@ -49,7 +49,7 @@ Or install it yourself as:
 
 ## Functionality
 
-This gem is used to call the REopt Lite API on a Scenario Report or Feature Report to update the object's Distributed Generation attributes (including system financial and sizing metrics) as shown in an example below: 
+This gem is used to call the REopt Lite API on a Scenario Report or Feature Report to update the object's Distributed Generation attributes (including system financial and sizing metrics) as shown in an example below:
 ```
 	"distributed_generation": {
 	      "lcc_us_dollars": 100000000.0,
@@ -97,9 +97,9 @@ Moreover, the following optimal dispatch fields are added to its timeseries CSV.
 | ElectricityProduced:Wind:ToBattery       | kWh     |
 | ElectricityProduced:Wind:ToLoad          | kWh     |
 | ElectricityProduced:Wind:ToGrid          | kWh     |
-    
 
-The REopt Lite has default values for all non-required input parameters that are used unless the user specifies custom assumptions. See <StaticLink target="\_blank" href="https://developer.nrel.gov/docs/energy-optimization/reopt-v1/">https://developer.nrel.gov/docs/energy-optimization/reopt-v1/</StaticLink> for more detailed information on input parameters and default assumptions. 
+
+The REopt Lite has default values for all non-required input parameters that are used unless the user specifies custom assumptions. See <StaticLink target="\_blank" href="https://developer.nrel.gov/docs/energy-optimization/reopt-v1/">https://developer.nrel.gov/docs/energy-optimization/reopt-v1/</StaticLink> for more detailed information on input parameters and default assumptions.
 
 <b>Note:</b> Required attributes for a REopt run include latitude and longitude, parsed from the Feature or Scenario Report attributes. If no utility rate is specified in your assumptions, then a constant rate of $0.13 is assumed without demand charges. Also, by default, only solar PV and storage are considered in the analysis (i.e. Wind and Generators are excluded from consideration).
 
@@ -118,7 +118,7 @@ DEVELOPER_NREL_KEY = "" # <insert a valid API key from https://developer.nrel.go
 feature_reports_hash = {} # <insert a valid Feature Report hash here with latitude and longitude filled in>
 
 #Create a Feature Report
-feature_report = URBANopt::Scenario::DefaultReports::FeatureReport.new(feature_reports_hash)
+feature_report = URBANopt::Reporting::DefaultReports::FeatureReport.new(feature_reports_hash)
 
 #Specify a file name where REopt Lite results will be written in JSON format
 reopt_output_file = File.join(feature_report.directory_name, 'feature_report_reopt_run.json')
@@ -134,7 +134,7 @@ reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(nil, nil, nil, DE
 
 #Call REopt Lite with the post processor to update the feature's distributed generation attributes and timeseries CSV.
 updated_feature_report = reopt_post_processor.run_feature_report(feature_report,reopt_assumptions_file,reopt_output_file,timeseries_output_file)
-    
+
 ```
 
 More commonly, this gem can be used to run REopt a collection of features stored in a Scenario Report as show here:
@@ -143,9 +143,9 @@ require 'urbanopt/reopt'
 DEVELOPER_NREL_KEY = "" # <insert a valid API key from https://developer.nrel.gov/signup >
 
 #Create a Scenario Report
-scenario_report = URBANopt::Scenario::DefaultReports::ScenarioReport.new({:directory_name => File.join(File.dirname(__FILE__), 'run/example_scenario'), :timeseries_csv => {:path => File.join(File.dirname(__FILE__), 'run/example_scenario/timeseries.csv') }})
+scenario_report = URBANopt::Reporting::DefaultReports::ScenarioReport.new({:directory_name => File.join(File.dirname(__FILE__), 'run/example_scenario'), :timeseries_csv => {:path => File.join(File.dirname(__FILE__), 'run/example_scenario/timeseries.csv') }})
 
-#Load Feature Reports into the Scenario Report     
+#Load Feature Reports into the Scenario Report
 (1..2).each do |i|
   feature_reports_path = File.join(File.dirname(__FILE__), "run/example_scenario/#{i}/010_default_feature_reports/default_feature_reports.json")
 
@@ -154,8 +154,8 @@ scenario_report = URBANopt::Scenario::DefaultReports::ScenarioReport.new({:direc
     feature_reports_hash = JSON.parse(file.read, symbolize_names: true)
   end
 
-  feature_report = URBANopt::Scenario::DefaultReports::FeatureReport.new(feature_reports_hash)
-  
+  feature_report = URBANopt::Reporting::DefaultReports::FeatureReport.new(feature_reports_hash)
+
   feature_report_dir = File.join(File.dirname(__FILE__), "run/example_scenario/#{i}")
   feature_report.directory_name = feature_report_dir
 
@@ -170,7 +170,7 @@ reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(scenario_report,
 
 #Call REopt Lite with the post processor once on the sceanrio's aggregated load to update the scenario's distributed generation attributes and timeseries CSV.
 updated_scenario_report = reopt_post_processor.run_scenario_report(scenario_report)
-    
+
 ```
 
 ## Testing
@@ -184,7 +184,7 @@ Next, obtain a developer.nrel.gov API key from the [NREL Developer Network](http
 Finally, execute:
 
     $ bundle install
-    $ bundle update    
+    $ bundle update
     $ bundle exec rake