urbanopt-reopt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee9ebcdfb84f8014a57ba10b922de59989801a03
+  data.tar.gz: f382a27f0219f10d01b20d09b2cfdd41d48cd223
+SHA512:
+  metadata.gz: 0edee439c2cc7bff0cc349de7511ab20c163c3ba803a0dbb4bca4291a6a6439aa2737e5c91077ea10316d23c32a80d5ed37dbe4138c0d992c7b08baddfe7db68
+  data.tar.gz: 28026ba4c576ece08adb4a1084eb64e36ce533400c5b2b66ab0b8290fa8de76c39b8d0aaa5afe7591463db93fd23392144f32167e97fd72ab32b8ef5783bdaf7

data/.gitignore

@@ -0,0 +1,27 @@
+/.bundle/
+/.yardoc
+/.ruby-version
+/Gemfile.lock
+/gems
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/test/
+/tmp/
+/test/
+/lib/measures/test_results
+/lib/measures/.rubocop*
+developer_nrel_key.rb
+# rspec failure tracking
+.rspec_status
+
+# Ignore IDE files
+/.idea
+*.rubocop-http*
+
+# measures tests
+lib/measures/.rubocop.yml
+lib/measures/test_results/*
+lib/measures/*/tests/output/*

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taskId="rake" /></Settings>

data/.rdoc_options

@@ -0,0 +1,37 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+- lib
+charset: UTF-8
+exclude:
+- doc_templates
+- docs
+- lib/measures
+- node_modules
+- spec
+- test
+- Gemfile
+- Gemfile.lock
+- Jenkinsfile
+- LICENSE.md
+- README.md
+- Rakefile
+- urbanopt-scenario-gem.gemspec
+- JSON
+- Object
+hyperlink_all: false
+line_numbers: false
+locale:
+locale_dir: locale
+locale_name:
+main_page: RDOC_MAIN.md
+markup: markdown
+output_decoration: true
+op_dir: ./docs/.vuepress/public/rdoc
+show_hash: false
+tab_width: 8
+template_stylesheets: ["./docs/.vuepress/public/custom_rdoc_styles.css"]
+title:
+visibility: :protected
+webcvs:

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Exclude:
+    - gems/**/*
+    - measures/**/*
+    - spec/files/**/measures/**/*
+
+
+inherit_from:
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop.yml

data/.travis.yml

@@ -0,0 +1,22 @@
+---
+sudo: false
+language: ruby
+#cache: bundler
+rvm:
+  - 2.2.4
+matrix:
+  include:
+  - env: OPENSTUDIO_VERSION=2.7.0 && OPENSTUDIO_SHA=544f363db5 && RUBYLIB=/usr/local/openstudio-2.7.0/Ruby:/usr/Ruby
+before_install: 
+  - gem install bundler -v '1.17'
+  - gem install bundler -v '~> 1.17'
+install: 
+  - bundle install
+before_script:
+  - curl -sLO https://raw.githubusercontent.com/NREL/OpenStudio-server/develop/docker/deployment/scripts/install_openstudio.sh
+  - chmod +x install_openstudio.sh
+  - sudo ./install_openstudio.sh $OPENSTUDIO_VERSION $OPENSTUDIO_SHA  
+  - sudo ./install_openstudio.sh $OPENSTUDIO_VERSION $OPENSTUDIO_SHA  
+script:
+  - bundle exec rake 
+  - bundle exec rake 

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# URBANopt REopt Gem
+ 
+## Version 0.1.0 
+
+* Initial release of URBANopt REopt Gem. 

data/Gemfile

@@ -0,0 +1,67 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in urbanopt-scenario-gem.gemspec
+gemspec
+
+# Local gems are useful when developing and integrating the various dependencies.
+# To favor the use of local gems, set the following environment variable:
+#   Mac: export FAVOR_LOCAL_GEMS=1
+#   Windows: set FAVOR_LOCAL_GEMS=1
+# Note that if allow_local is true, but the gem is not found locally, then it will
+# checkout the latest version (develop) from github.
+allow_local = ENV['FAVOR_LOCAL_GEMS']
+
+# Uncomment the extension, common measures, core gems if you need to test local development versions. Otherwise
+# these are included in the model articulation and urbanopt 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: 'develop'
+# end
+#
+# 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: 'develop'
+# end
+#
+# 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: 'develop'
+# end
+#
+# if allow_local && File.exist?('../openstudio-model-articulation-gem')
+#   # gem 'openstudio-model-articulation', github: 'NREL/openstudio-model-articulation-gem', branch: 'develop'
+#   gem 'openstudio-model-articulation', path: '../openstudio-model-articulation-gem'
+# elsif allow_local
+#   gem 'openstudio-model-articulation', github: 'NREL/openstudio-model-articulation-gem', branch: 'develop'
+# else
+#   gem 'openstudio-model-articulation', '0.1.0'
+# end
+
+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: 'post_process'
+else
+  gem 'urbanopt-scenario', '0.1.1'
+end
+
+if allow_local && File.exists?('../urbanopt-geojson-gem')
+  # gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'develop'
+  gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
+elsif allow_local
+  gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
+else
+  gem 'urbanopt-geojson', '0.1.0'
+end
+
+# simplecov has an unnecessary dependency on native json gem, use fork that does not require this
+gem 'simplecov', github: 'NREL/simplecov'
+
+# Support requests in windows
+gem 'certified'
+
+gem 'rdoc', '4.3.0'

data/Jenkinsfile

@@ -0,0 +1,10 @@
+//Jenkins pipelines are stored in shared libaries. Please see: https://github.com/tijcolem/nrel_cbci_jenkins_libs 
+ 
+@Library('cbci_shared_libs') _
+
+// Build for PR to develop branch only. 
+if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) { // check if set
+
+  urbanopt_reopt_gem()
+    
+}

data/LICENSE.md

@@ -0,0 +1,27 @@
+OpenStudio(R), Copyright (c) 2008-2018, 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:
+
+(1) Redistributions of source code must retain the above copyright notice, this list of conditions 
+and the following disclaimer.
+
+(2) 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.
+
+(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse 
+or promote products derived from this software without specific prior written permission from the 
+respective party.
+
+(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other 
+derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar 
+designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
+
+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, THE UNITED STATES GOVERNMENT, 
+OR ANY 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.

data/RDOC_MAIN.md

@@ -0,0 +1,176 @@
+# **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. 
+
+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/)
+
+## Installation
+
+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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'urbanopt-reopt'
+```
+
+And then execute:
+
+    $ bundle install
+    $ bundle update
+
+Or install it yourself as:
+
+    $ gem install 'urbanopt-reopt'
+
+## 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: 
+
+```
+	"distributed_generation": {
+	      "lcc_us_dollars": 100000000.0,
+	      "npv_us_dollars": 10000000.0,
+	      "year_one_energy_cost_us_dollars": 7000000.0,
+	      "year_one_demand_cost_us_dollars": 3000000.0,
+	      "year_one_bill_us_dollars": 10000000.0,
+	      "total_energy_cost_us_dollars": 70000000.0,
+	      "solar_pv": {
+	        "size_kw": 30000.0
+	      },
+	      "wind": {
+	        "size_kw": 0.0
+	      },
+	      "generator": {
+	        "size_kw": 0.0
+	      },
+	      "storage": {
+	        "size_kw": 2000.0,
+	        "size_kwh": 5000.0
+	      }
+	    }
+```
+
+Moreover, the following optimal dispatch fields are added to its timeseries CSV. Where no system component is recommended the dispatch will be all zero (i.e. if no solar PV is recommended ElectricityProduced:PV:Total will be always be zero)
+
+```
+|            output                        |  unit   |
+| -----------------------------------------| ------- |
+| ElectricityProduced:Total                | kWh     |
+| Electricity:Load:Total                   | kWh     |
+| Electricity:Grid:ToLoad                  | kWh     |
+| Electricity:Grid:ToBattery               | kWh     |
+| Electricity:Storage:ToLoad               | kWh     |
+| Electricity:Storage:ToGrid               | kWh     |
+| Electricity:Storage:StateOfCharge        | kWh     |
+| ElectricityProduced:Generator:Total      | kWh     |
+| ElectricityProduced:Generator:ToBattery  | kWh     |
+| ElectricityProduced:Generator:ToLoad     | kWh     |
+| ElectricityProduced:Generator:ToGrid     | kWh     |
+| ElectricityProduced:PV:Total             | kWh     |
+| ElectricityProduced:PV:ToBattery         | kWh     |
+| ElectricityProduced:PV:ToLoad            | kWh     |
+| ElectricityProduced:PV:ToGrid            | kWh     |
+| ElectricityProduced:Wind:Total           | kWh     |
+| 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 [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).
+
+
+
+## Getting Started
+
+The code below shows how to run the REopt API on a single Feature Report hash using this gem:
+
+```ruby
+require 'urbanopt/reopt'
+#Load a Feature Report Hash
+feature_reports_hash = {} # <insert a Feature Report hash here>
+
+#Create a Feature Report
+feature_report = URBANopt::Scenario::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')
+
+#Specify a file name where the new timeseries CSV will be written after REopt Lite has determined cost optimal dispatch
+timeseries_output_file = File.join(feature_report.directory_name, 'feature_report_timeseries1.csv')
+
+#Specify non-default REopt Lite assumptions, saved in JSON format, to be used in calling the API
+reopt_assumptions_file = File.join(File.dirname(__FILE__), '../files/reopt_assumptions_basic.json')
+
+#Create a REopt Lite Post Processor to call the API, note you will need a Developer.nrel.gov API key in this step
+reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(nil, nil, nil, DEVELOPER_NREL_KEY)
+
+#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') }})
+
+#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")
+
+  feature_reports_hash = nil
+  File.open(feature_reports_path, 'r') do |file|
+    feature_reports_hash = JSON.parse(file.read, symbolize_names: true)
+  end
+
+  feature_report = URBANopt::Scenario::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
+
+  scenario_report.add_feature_report(feature_report)
+end
+
+#Specify non-default REopt Lite assumptions, saved in JSON format, to be used in calling the API
+reopt_assumptions_file = File.join(File.dirname(__FILE__), '../files/reopt_assumptions_basic.json')
+
+#Create a REopt Lite Post Processor to call the API, note you will need a Developer.nrel.gov API key in this step
+reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(scenario_report, reopt_assumptions_file, nil, DEVELOPER_NREL_KEY)
+
+#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
+
+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:
+
+    DEVELOPER_NREL_KEY = '<insert your key here>'
+
+Finally, execute:
+
+    $ bundle install
+    $ bundle update    
+    $ bundle exec rake
+
+
+## Releasing
+
+* Update change log
+* Update version in `/lib/urbanopt/reopt/version.rb`
+* Merge down to master
+* run `rake release` from master

data/README.md

@@ -0,0 +1,177 @@
+# 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. 
+
+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/)
+
+[RDoc Documentation](https://urbanopt.github.io/urbanopt-reopt-gem/)
+
+
+## Installation
+
+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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'urbanopt-reopt'
+```
+
+And then execute:
+
+    $ bundle install
+    $ bundle update
+
+Or install it yourself as:
+
+    $ gem install 'urbanopt-reopt'
+
+## 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: 
+```
+	"distributed_generation": {
+	      "lcc_us_dollars": 100000000.0,
+	      "npv_us_dollars": 10000000.0,
+	      "year_one_energy_cost_us_dollars": 7000000.0,
+	      "year_one_demand_cost_us_dollars": 3000000.0,
+	      "year_one_bill_us_dollars": 10000000.0,
+	      "total_energy_cost_us_dollars": 70000000.0,
+	      "solar_pv": {
+	        "size_kw": 30000.0
+	      },
+	      "wind": {
+	        "size_kw": 0.0
+	      },
+	      "generator": {
+	        "size_kw": 0.0
+	      },
+	      "storage": {
+	        "size_kw": 2000.0,
+	        "size_kwh": 5000.0
+	      }
+	    }
+```
+
+Moreover, the following optimal dispatch fields are added to its timeseries CSV. Where no system component is recommended the dispatch will be all zero (i.e. if no solar PV is recommended ElectricityProduced:PV:Total will be always be zero)
+
+|            output                        |  unit   |
+| -----------------------------------------| ------- |
+| ElectricityProduced:Total                | kWh     |
+| Electricity:Load:Total                   | kWh     |
+| Electricity:Grid:ToLoad                  | kWh     |
+| Electricity:Grid:ToBattery               | kWh     |
+| Electricity:Storage:ToLoad               | kWh     |
+| Electricity:Storage:ToGrid               | kWh     |
+| Electricity:Storage:StateOfCharge        | kWh     |
+| ElectricityProduced:Generator:Total      | kWh     |
+| ElectricityProduced:Generator:ToBattery  | kWh     |
+| ElectricityProduced:Generator:ToLoad     | kWh     |
+| ElectricityProduced:Generator:ToGrid     | kWh     |
+| ElectricityProduced:PV:Total             | kWh     |
+| ElectricityProduced:PV:ToBattery         | kWh     |
+| ElectricityProduced:PV:ToLoad            | kWh     |
+| ElectricityProduced:PV:ToGrid            | kWh     |
+| ElectricityProduced:Wind:Total           | kWh     |
+| 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. 
+
+<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).
+
+
+
+## Getting Started
+
+The code below shows how to run the REopt API on a single Feature Report hash using this gem:
+
+```ruby
+require 'urbanopt/reopt'
+#Load a Feature Report Hash
+feature_reports_hash = {} # <insert a Feature Report hash here>
+
+#Create a Feature Report
+feature_report = URBANopt::Scenario::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')
+
+#Specify a file name where the new timeseries CSV will be written after REopt Lite has determined cost optimal dispatch
+timeseries_output_file = File.join(feature_report.directory_name, 'feature_report_timeseries1.csv')
+
+#Specify non-default REopt Lite assumptions, saved in JSON format, to be used in calling the API
+reopt_assumptions_file = File.join(File.dirname(__FILE__), '../files/reopt_assumptions_basic.json')
+
+#Create a REopt Lite Post Processor to call the API, note you will need a Developer.nrel.gov API key in this step
+reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(nil, nil, nil, DEVELOPER_NREL_KEY)
+
+#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') }})
+
+#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")
+
+  feature_reports_hash = nil
+  File.open(feature_reports_path, 'r') do |file|
+    feature_reports_hash = JSON.parse(file.read, symbolize_names: true)
+  end
+
+  feature_report = URBANopt::Scenario::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
+
+  scenario_report.add_feature_report(feature_report)
+end
+
+#Specify non-default REopt Lite assumptions, saved in JSON format, to be used in calling the API
+reopt_assumptions_file = File.join(File.dirname(__FILE__), '../files/reopt_assumptions_basic.json')
+
+#Create a REopt Lite Post Processor to call the API, note you will need a Developer.nrel.gov API key in this step
+reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(scenario_report, reopt_assumptions_file, nil, DEVELOPER_NREL_KEY)
+
+#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
+
+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:
+
+    DEVELOPER_NREL_KEY = '<insert your key here>'
+
+Finally, execute:
+
+    $ bundle install
+    $ bundle update    
+    $ bundle exec rake
+
+
+## Releasing
+
+* Update change log
+* Update version in `/lib/urbanopt/reopt/version.rb`
+* Merge down to master
+* run `rake release` from master

data/Rakefile

@@ -0,0 +1,30 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+# Load in the rake tasks from the base openstudio-extension gem
+require 'openstudio/extension/rake_task'
+require 'urbanopt/reopt/extension'
+os_extension = OpenStudio::Extension::RakeTask.new
+os_extension.set_extension_class(URBANopt::REopt::Extension)
+
+desc 'CLI OpenSSL test'
+task :cli_openssl_test do
+  runner = OpenStudio::Extension::Runner.new(URBANopt::REopt::Extension.new.root_dir)
+
+  cli = OpenStudio.getOpenStudioCLI
+  the_call = "#{cli} --verbose --bundle '#{runner.gemfile_path}' --bundle_path '#{runner.bundle_install_path}' ./spec/cli_openssl_test.rb"
+
+  puts 'SYSTEM CALL:'
+  puts the_call
+  STDOUT.flush
+  result = runner.run_command(the_call)
+  puts "DONE, result = #{result}"
+  STDOUT.flush
+end
+
+task default: :spec

data/deploy_docs.sh

@@ -0,0 +1,5 @@
+set -e
+bundle exec rdoc --template-stylesheets ./docs/.vuepress/public/custom_rdoc_styles.css
+npm run build --prefix docs
+#npm run dev --prefix docs
+npm run deploy --prefix docs

data/developer_nrel_key.rb

@@ -0,0 +1,31 @@
+# *********************************************************************************
+# 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,
+# 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.
+# *********************************************************************************
+
+DEVELOPER_NREL_KEY = (ENV['GEM_DEVELOPER_KEY'] || '< your key here https://developer.nrel.gov/signup >')