urbanopt-reopt 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ee9ebcdfb84f8014a57ba10b922de59989801a03
-  data.tar.gz: f382a27f0219f10d01b20d09b2cfdd41d48cd223
+SHA256:
+  metadata.gz: a4f6687c61a1902f3982215b12944c8551f892e7ea489412b9df174941ceb48d
+  data.tar.gz: 639bf269508f322975cc831d0541edb72e4537b891fee104edb34cf769481a78
 SHA512:
-  metadata.gz: 0edee439c2cc7bff0cc349de7511ab20c163c3ba803a0dbb4bca4291a6a6439aa2737e5c91077ea10316d23c32a80d5ed37dbe4138c0d992c7b08baddfe7db68
-  data.tar.gz: 28026ba4c576ece08adb4a1084eb64e36ce533400c5b2b66ab0b8290fa8de76c39b8d0aaa5afe7591463db93fd23392144f32167e97fd72ab32b8ef5783bdaf7
+  metadata.gz: 9a9fa7e3d39dfac3c87fff10dc9a6530f73893cdc5a25de4786b223b2079b97488758387a10cb30c31e01fe65ef1c5ddba8732fb73766929d41aea6542429034
+  data.tar.gz: 834ee49b279c9361c79e9f479addbcf17b02d9ac31b7e2281fec8fe200cf8494068d0510b3e1b812c3b9d1b3e53547082c38547e7a6fc40b826cfc0b22eac263

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+---
+
+**Expected behavior**
+_A clear and concise description of what you expected to happen._
+
+**Actual behavior**
+_A clear and concise description of what actually happens._
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+1. Enter '...'
+1. Enter '...'
+
+### Additional context
+
+_E.g.: Windows, Mac, Linux? Are you behind a firewall? Do you have additional security constraints?_

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+---
+
+**Is your feature request related to a problem?**
+A clear and concise description of what the problem is: _I'm frustrated when [...]_
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen
+
+**Alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered
+
+**Additional context**
+Add any other context or screenshots about the feature request here

data/.github/pull_request_template.md

@@ -0,0 +1,13 @@
+### Addresses #[issue number here]
+
+### Pull Request Description
+
+[description here]
+
+### Checklist (Delete lines that don't apply)
+
+- [ ] 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
+- [ ] This branch is up-to-date with develop

data/.gitignore

@@ -1,3 +1,5 @@
+*.DS_Store
+/vendor/
 /.bundle/
 /.yardoc
 /.ruby-version
@@ -13,6 +15,9 @@
 /test/
 /lib/measures/test_results
 /lib/measures/.rubocop*
+# test files
+spec/run/
+
 developer_nrel_key.rb
 # rspec failure tracking
 .rspec_status
@@ -24,4 +29,4 @@ developer_nrel_key.rb
 # measures tests
 lib/measures/.rubocop.yml
 lib/measures/test_results/*
-lib/measures/*/tests/output/*
+lib/measures/*/tests/output/*

data/.rdoc_options

@@ -17,7 +17,7 @@ exclude:
 - LICENSE.md
 - README.md
 - Rakefile
-- urbanopt-scenario-gem.gemspec
+- urbanopt-reopt-gem.gemspec
 - JSON
 - Object
 hyperlink_all: false

data/.rubocop.yml

@@ -6,4 +6,4 @@ AllCops:
 
 
 inherit_from:
-  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop.yml
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v3.yml

data/CHANGELOG.md

@@ -1,5 +1,44 @@
 # URBANopt REopt Gem
  
+## 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
+
+## Version 0.2.1 
+* Corrects code checking PV size that fails on multi PV
+* Corrects parsing of site energy at timesteps other than 1 per hour
+
+
+## Version 0.2.0 
+
+* Handles multiple PV systems in the REopt Lite assumptions
+* Changes REoptPostProcessor run_scenario and run_scenario_features methods to save feature and scenario reports with custom names
+* Parses date from timeseries CSV when creating load profile for REopt job and when parsing optimized results
+* Renames REopt timeseries CSV columns to include 'REopt' and units
+
+
 ## Version 0.1.0 
 
 * Initial release of URBANopt REopt Gem. 

data/CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# URBANopt Contribution Policy
+
+## Version 1.0
+
+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:
+
+## 1. Send consent email
+
+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.*
+
+Once we have your consent on file, you’ll only need to redo it if conditions change (e.g. a change of employer).
+
+## 2. Scope agreement and timeline commitment
+
+If your contribution is small (e.g. a bug fix), simply submit your contribution via GitHub. If you find a bug, first make sure it is not an already known issue, then report it in the GitHub [issue tracker](https://github.com/urbanopt/urbanopt-reopt-gem/issues) for this repository. If your contribution is larger (e.g. a new feature or new functionality/capability), we’ll need to evaluate your proposed contribution first. We may ask you to revise your materials and make changes to it, which we will then re-review.
+
+## 3. Technical contribution process
+
+We want URBANopt to adhere to our established quality standards. Smaller, non-code contributions may not require as much review as code contributions, but all contributions will be reviewed. Code contributions will initially be in a source control branch, and then will be merged into the official URBANopt repository after review and approval. Any bugs, either discovered by you, us, or any users will be tracked in our issue tracker. We request that you take full responsibility for correcting bugs. Be aware that, unless notified otherwise, the correction of bugs takes precedence over the submission or creation of new code.
+
+### Release Schedule
+
+Contributions should be aligned with the URBANopt release schedule. The URBANopt SDK is currently released publicly two times each year (approximately on the last workday of March and October). There are cutoff dates for when new contributions are allowed for the upcoming release (approximately two weeks before release date). If your contribution is incomplete or comes in past the cutoff date for a release, we reserve the right to hold your code for a later release.
+
+### Coding Standards
+
+Make sure you read and follow the coding standards when writing URBANopt SDK code. Although these standards are not complete or very detailed, they should give you an idea of the style that we would like you to adopt. New additions to the URBANopt SDK must be written using object-oriented programming techniques and practices. Please also look at the URBANopt SDK code itself as an example of the preferred coding style.
+
+### Code Reviews
+
+You will be working and testing your code in a source control branch. When a piece of functionality is complete, tested and working, let us know and we will review your code. If the functionality that you contributed is complex, we may ask you for a written design document as well. We want your code to follow coding standards, be clear, readable, and maintainable, and of course it should do what it is supposed to do. We will look for errors, style issues, comments (or lack thereof), and any other issues in your code. We will inform you of our comments and we expect you to make the recommended changes. New re-reviews may be expected until the code complies with our required processes.
+
+### Unit Tests
+
+We ask that you supply unit tests along with the code that you have written. A unit test is a program that exercises your code in isolation to verify that it does what it is supposed to do. Your unit tests are very important to us. First, they give an indication that your code works according to its intended functionality. Second, we execute your unit tests automatically along with our unit tests to verify that the overall URBANopt SDK code continues to work.
+
+### Code Coverage
+
+We require that your unit tests provide an adequate coverage of the source code you are submitting. You will need to design your unit tests in such a way that all critical parts of the code (at least) are tested and verified.
+
+### Documentation
+
+Proper documentation is crucial for our users, without it users will not know how to use your contribution. We require that you create user documentation so that end users know how to use your new functionality.
+
+For further questions or information:
+
+- Ben Polly\
+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 developed in collaboration with NREL, LBNL, and private firms.

data/Gemfile

@@ -1,6 +1,6 @@
 source 'http://rubygems.org'
 
-# Specify your gem's dependencies in urbanopt-scenario-gem.gemspec
+# Specify your gem's dependencies in urbanopt-reopt-gem.gemspec
 gemspec
 
 # Local gems are useful when developing and integrating the various dependencies.
@@ -41,27 +41,22 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 #   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
+# 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'
+# end
 
-# simplecov has an unnecessary dependency on native json gem, use fork that does not require this
-gem 'simplecov', github: 'NREL/simplecov'
+# if allow_local && File.exists?('../urbanopt-geojson-gem')
+#   gem 'urbanopt-geojson', path: '../urbanopt-geojson-gem'
+# elsif allow_local
+#   gem 'urbanopt-geojson', github: 'URBANopt/urbanopt-geojson-gem', branch: 'develop'
+# end
 
 # Support requests in windows
-gem 'certified'
+# 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