urbanopt-reopt 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f914ce58eb625102b9e996099d74ad53c12a8db4cd4c169222b04c62983a210
-  data.tar.gz: 1292d94d05fa38dafc702b11b4c50732ed4331e4d1d38f2e949d5c93b6e023c3
+  metadata.gz: 56b147451f96d95e26e2ea20dfb9b408b4677dae6ae8d9233008ce7a07f4cb2d
+  data.tar.gz: 93660c184fdd2dcdfc20386c7230a96b3627ea38b751f08c8774b440fe4794dd
 SHA512:
-  metadata.gz: 4632f539ed5e68dde1dd5ae579f5606b0201a9083b7eaccaf77229f4320230074f0dccce601c1b13418da1900d3a599f4e0a7b79929f3352e86680bc81d1c50c
-  data.tar.gz: 630e01b66eae49563eb947d360c76b889c46f694d464cdf7f31352d5f73f2702917db2fb3545af18e042bd8899ffc502578bd2418296c8ec15d730984bf71a31
+  metadata.gz: 502fabf84a4d43b93ba7b91ebe206f55eb7b117b310809592dc5190821bc7e36804feab7bee916b38ee9b7a66781cd23c0db95f8d373b03f68baff96ab9a8f52
+  data.tar.gz: 8049c39934e712e76db8d9dd6c4ac54b0c7788bc6f0129ec92cab1d929b15e253f6ff2df51893e995578107a91975e86f742a06a6d145aebd7ba1747c7487059

data/.gitignore

@@ -19,6 +19,8 @@
 spec/files/run/baseline_scenario_ghe/reopt_ghp/
 
 developer_nrel_key.rb
+developer_api_key.rb
+
 # rspec failure tracking
 .rspec_status
 

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # URBANopt REopt Gem
 
+## Version 1.3.0
+* Updates for developer.nlr.gov URL change
+* Timeseries shift bug fix
+* Added Domestic Hot Water to baseline load
+
 ## Version 1.2.0
 
 * Updates for name change and license

data/CONTRIBUTING.md

@@ -50,7 +50,7 @@ For further questions or information:
 
 - Ben Polly\
 URBANopt Project Management\
-ben.polly@nrel.gov\
+ben.polly@nlr.gov\
 (303) 384-7429
 
 URBANopt is funded by the U.S. Department of Energy (DOE) and managed by the National Laboratory of the Rockies (NLR).

data/RDOC_MAIN.md

@@ -1,11 +1,11 @@
 # **URBANopt REopt Gem**
 
-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](https://reopt.nrel.gov/tool) decision support platform.
-REopt 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/v2/](https://developer.nrel.gov/docs/energy-optimization/reopt/v2/) 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](https://reopt.nlr.gov/tool) decision support platform.
+REopt 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.nlr.gov/docs/energy-optimization/reopt/v2/](https://developer.nlr.gov/docs/energy-optimization/reopt/v2/) 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 [NLR Developer Network](https://developer.nrel.gov/)
+<b>Note:</b> This module requires an API Key from the [NLR Developer Network](https://developer.nlr.gov/)
 
 ## Installation
 
@@ -83,7 +83,7 @@ Moreover, the following optimal dispatch fields are added to its timeseries CSV.
 | ElectricityProduced:Wind:ToGrid          | kWh     |
 ```
 
-The REopt 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/v2/](https://developer.nrel.gov/docs/energy-optimization/reopt/v2/) for more detailed information on input parameters and default assumptions.
+The REopt has default values for all non-required input parameters that are used unless the user specifies custom assumptions. See [https://developer.nlr.gov/docs/energy-optimization/reopt/v2/](https://developer.nlr.gov/docs/energy-optimization/reopt/v2/) 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 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).
 
@@ -110,8 +110,8 @@ timeseries_output_file = File.join(feature_report.directory_name, 'feature_repor
 #Specify non-default REopt 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 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)
+#Create a REopt Post Processor to call the API, note you will need a Developer.nlr.gov API key in this step
+reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(nil, nil, nil, DEVELOPER_API_KEY)
 
 #Call REopt 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)
@@ -145,8 +145,8 @@ end
 #Specify non-default REopt 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 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)
+#Create a REopt Post Processor to call the API, note you will need a Developer.nlr.gov API key in this step
+reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(scenario_report, reopt_assumptions_file, nil, DEVELOPER_API_KEY)
 
 #Call REopt 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)
@@ -157,9 +157,9 @@ 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 [NLR 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.nlr.gov API key from the [NLR Developer Network](https://developer.nlr.gov/]). Copy and paste your key in to the _developer_api_key_._rb_ file then save the file:
 
-    DEVELOPER_NREL_KEY = '<insert your key here>'
+    DEVELOPER_API_KEY = '<insert your key here>'
 
 Finally, execute:
 

data/README.md

@@ -3,13 +3,13 @@
 [![Coverage Status](https://coveralls.io/repos/github/urbanopt/urbanopt-reopt-gem/badge.svg?branch=develop)](https://coveralls.io/github/urbanopt/urbanopt-reopt-gem?branch=develop)
 [![nightly_build](https://github.com/urbanopt/urbanopt-reopt-gem/actions/workflows/nightly_ci_build.yml/badge.svg)](https://github.com/urbanopt/urbanopt-reopt-gem/actions/workflows/nightly_ci_build.yml)
 
-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](https://reopt.nrel.gov/tool) decision support platform.
-REopt 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/v2/](https://developer.nrel.gov/docs/energy-optimization/reopt/v2/) 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](https://reopt.nlr.gov/tool) decision support platform.
+REopt 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.nlr.gov/docs/energy-optimization/reopt/v2/](https://developer.nlr.gov/docs/energy-optimization/reopt/v2/) 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
-[NLR Developer Network](https://developer.nrel.gov/)
+[NLR Developer Network](https://developer.nlr.gov/)
 
 [RDoc Documentation](https://urbanopt.github.io/urbanopt-reopt-gem/)
 
@@ -88,7 +88,7 @@ Moreover, the following optimal dispatch fields are added to its timeseries CSV.
 | ElectricityProduced:Wind:ToGrid          | kWh     |
 
 
-The REopt 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/v2/">https://developer.nrel.gov/docs/energy-optimization/reopt/v2/</StaticLink> for more detailed information on input parameters and default assumptions.
+The REopt 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.nlr.gov/docs/energy-optimization/reopt/v2/">https://developer.nlr.gov/docs/energy-optimization/reopt/v2/</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 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).
 
@@ -115,8 +115,8 @@ timeseries_output_file = File.join(feature_report.directory_name, 'feature_repor
 #Specify non-default REopt 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 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)
+#Create a REopt Post Processor to call the API, note you will need a Developer.nlr.gov API key in this step
+reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(nil, nil, nil, DEVELOPER_API_KEY)
 
 #Call REopt 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)
@@ -149,8 +149,8 @@ end
 #Specify non-default REopt 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 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)
+#Create a REopt Post Processor to call the API, note you will need a Developer.nlr.gov API key in this step
+reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(scenario_report, reopt_assumptions_file, nil, DEVELOPER_API_KEY)
 
 #Call REopt 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)
@@ -161,9 +161,60 @@ 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 [NLR 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.nlr.gov API key from the [NLR Developer Network](https://developer.nlr.gov/]). Copy and paste your key in to the _developer_api_key.rb_ file then save the file:
 
-    DEVELOPER_NREL_KEY = '<insert your key here>'
+    DEVELOPER_API_KEY = '<insert your key here>'
+
+## Configuration
+
+### API Key Setup
+
+The gem supports multiple ways to provide your developer API key:
+
+1. **Environment Variable (Recommended):**
+   ```bash
+   export GEM_DEVELOPER_KEY=your_api_key_here
+   # Then API instances automatically use this key
+   api = URBANopt::REopt::REoptAPI.new()
+   ```
+
+2. **Direct Parameter:**
+   ```ruby
+   api = URBANopt::REopt::REoptAPI.new('your_api_key_here')
+   ```
+
+3. **Edit developer_api_key.rb file:**
+   ```ruby
+   DEVELOPER_API_KEY = 'your_api_key_here'
+   ```
+
+### Environment Variables
+
+You can customize the REopt API endpoints using environment variables:
+
+- `REOPT_BASE_URL`: Override the default base URL for all REopt API endpoints.
+  - Default: `https://developer.nlr.gov/api/reopt/v3`
+  - Example: `export REOPT_BASE_URL=https://test.example.com/api/reopt/v3`
+
+- `GEM_DEVELOPER_KEY`: Set the developer API key via environment variable instead of editing the source file.
+  - Example: `export GEM_DEVELOPER_KEY=your_api_key_here`
+  - This automatically becomes available as `DEVELOPER_API_KEY` constant in the code
+
+### Localhost Development
+
+For development against a local REopt instance, use the `REOPT_BASE_URL` environment variable:
+
+```bash
+# Use localhost (no API key needed)
+export REOPT_BASE_URL=http://127.0.0.1:8000/v3
+
+# Then create API instances normally
+api = URBANopt::REopt::REoptAPI.new()
+```
+
+Note: When using custom URLs via `REOPT_BASE_URL`, API keys are automatically bypassed for non-official endpoints.
+
+## Running Tests
 
 Finally, execute:
 

data/{developer_nrel_key.rb → developer_api_key.rb}

@@ -3,4 +3,4 @@
 # See also https://github.com/urbanopt/urbanopt-reopt-gem/blob/develop/LICENSE.md
 # *********************************************************************************
 
-DEVELOPER_NREL_KEY = (ENV['GEM_DEVELOPER_KEY'] || '< your key here https://developer.nrel.gov/signup >')
+DEVELOPER_API_KEY = (ENV['GEM_DEVELOPER_KEY'] || '< your key here https://developer.nlr.gov/signup >')

data/docs/README.md

@@ -2,8 +2,8 @@
 
 ### <StaticLink target="\_blank" href="rdoc/">Rdocs</StaticLink>
 
-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</StaticLink> decision support platform.
-REopt 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/v2/">https://developer.nrel.gov/docs/energy-optimization/reopt/v2/</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.nlr.gov/tool">REopt</StaticLink> decision support platform.
+REopt 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.nlr.gov/docs/energy-optimization/reopt/v2/">https://developer.nlr.gov/docs/energy-optimization/reopt/v2/</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):
 
@@ -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/">NLR Developer Network</StaticLink>.
+<b>Note:</b> This module requires an API Key from the <StaticLink target='blank' href="https://developer.nlr.gov/">NLR Developer Network</StaticLink>.
 
 <StaticLink target="\_blank" href="https://urbanopt.github.io/urbanopt-reopt-gem/">RDoc Documentation</StaticLink>
 
@@ -99,7 +99,7 @@ Moreover, the following optimal dispatch fields are added to its timeseries CSV.
 | ElectricityProduced:Wind:ToGrid          | kWh     |
 
 
-The REopt 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/v2/">https://developer.nrel.gov/docs/energy-optimization/reopt/v2/</StaticLink> for more detailed information on input parameters and default assumptions.
+The REopt 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.nlr.gov/docs/energy-optimization/reopt/v2/">https://developer.nlr.gov/docs/energy-optimization/reopt/v2/</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).
 
@@ -112,7 +112,7 @@ The code below shows how to run the REopt API on a single Feature Report hash us
 ```ruby
 require 'urbanopt/reopt'
 
-DEVELOPER_NREL_KEY = "" # <insert a valid API key from https://developer.nrel.gov/signup >
+DEVELOPER_API_KEY = "" # <insert a valid API key from https://developer.nlr.gov/signup >
 
 #Load a Feature Report Hash
 feature_reports_hash = {} # <insert a valid Feature Report hash here with latitude and longitude filled in>
@@ -129,8 +129,8 @@ timeseries_output_file = File.join(feature_report.directory_name, 'feature_repor
 #Specify non-default REopt 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 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)
+#Create a REopt Post Processor to call the API, note you will need a Developer.nlr.gov API key in this step
+reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(nil, nil, nil, DEVELOPER_API_KEY)
 
 #Call REopt 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)
@@ -140,7 +140,7 @@ updated_feature_report = reopt_post_processor.run_feature_report(feature_report,
 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'
-DEVELOPER_NREL_KEY = "" # <insert a valid API key from https://developer.nrel.gov/signup >
+DEVELOPER_API_KEY = "" # <insert a valid API key from https://developer.nlr.gov/signup >
 
 #Create a Scenario Report
 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') }})
@@ -165,8 +165,8 @@ end
 #Specify non-default REopt 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 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)
+#Create a REopt Post Processor to call the API, note you will need a Developer.nlr.gov API key in this step
+reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(scenario_report, reopt_assumptions_file, nil, DEVELOPER_API_KEY)
 
 #Call REopt 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)
@@ -177,9 +177,9 @@ 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 [NLR 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.nlr.gov API key from the [NLR Developer Network](https://developer.nlr.gov/]). Copy and paste your key in to the _developer_api_key_._rb_ file then save the file:
 
-    DEVELOPER_NREL_KEY = '<insert your key here>'
+    DEVELOPER_API_KEY = '<insert your key here>'
 
 Finally, execute:
 

data/docs/schemas/reopt-input-schema.md

@@ -1,6 +1,6 @@
-# REopt Lite Inputs Schema
+# REopt Inputs Schema
 
-The following shows the complete set of inputs to the REopt Lite AP which is called internally by the REopt Gem. You may refer to the data dictionary below in creating similarly formatted .json files containing alternatives to the defaults for optional parameters (i.e. specific utility rate, installed cost assumptions, solar PV losses, ...). The URBANopt REopt Gem will overwrite latitude, longitude, land_acres, roof_squarefeet, and loads_kw where possible from attributes of a Scenario Report and FeatureReports.
+The following shows the complete set of inputs to the REopt API which is called internally by the REopt Gem. You may refer to the data dictionary below in creating similarly formatted .json files containing alternatives to the defaults for optional parameters (i.e. specific utility rate, installed cost assumptions, solar PV losses, ...). The URBANopt REopt Gem will overwrite latitude, longitude, land_acres, roof_squarefeet, and loads_kw where possible from attributes of a Scenario Report and FeatureReports.
 
 ## Data Dictionary
 
@@ -8,7 +8,7 @@ The following shows the complete set of inputs to the REopt Lite AP which is cal
 
 ## Required Inputs
 
-The only required parameters to the REopt Lite API (called internally by the gem) are:
+The only required parameters to the REopt API (called internally by the gem) are:
 - *latitude*
 - *longitude*
 - *urdb_response* OR one of the following sets:
@@ -24,7 +24,7 @@ The only required parameters to the REopt Lite API (called internally by the gem
 
 The gem sources *latitude*, *longitude* and *loads_kw* from a Feature or Scenario Report directly. If no specific *urdb_response* or *urdb_label* is specified as an custom assumption (see below), then a constant rate of $0.13/kWh with no demand charge is provided by the gem as a default to the REopt API.
 
-Otherwise, all non-required input parameters will be filled in with default values unless otherwise specified. For an example of a minimally viable REopt Lite input, see:
+Otherwise, all non-required input parameters will be filled in with default values unless otherwise specified. For an example of a minimally viable REopt input, see:
 
 
 ```

data/docs/schemas/reopt-output-schema.md

@@ -1,6 +1,6 @@
-# REopt Lite Outputs Schema
+# REopt Outputs Schema
 
-When the gem calls the REopt Lite APUI it receives the following complete set of results described in the data dictionary below. Only those needed to update a Feature or Scenario Report's distributed_generation attribute set and timeseries CSV are pulled from the response and transferred to the Feature or Scenario Report. You may choose to modify the code to include more or less of the full REopt Lite response.
+When the gem calls the REopt API it receives the following complete set of results described in the data dictionary below. Only those needed to update a Feature or Scenario Report's distributed_generation attribute set and timeseries CSV are pulled from the response and transferred to the Feature or Scenario Report. You may choose to modify the code to include more or less of the full REopt response.
 
 ## Data Dictionary
 <ReoptOutputSchema />
@@ -8,7 +8,7 @@ When the gem calls the REopt Lite APUI it receives the following complete set of
 ## Updated from the Data Dictionary
 
 ### Distributed Generation Attributes
-The REopt Lite API updates the distributed_generation attributes of a Scenario or Feature Report as shown in an example below.
+The REopt API updates the distributed_generation attributes of a Scenario or Feature Report as shown in an example below.
 
 ```
 	"distributed_generation": {
@@ -35,7 +35,7 @@ The REopt Lite API updates the distributed_generation attributes of a Scenario o
 ```
 
 ### Timeseries CSV
-REopt Lite API responses also map dispatches to the following columns in an updated timeseries CSV for a Feature or Scenario Report.
+REopt API responses also map dispatches to the following columns in an updated timeseries CSV for a Feature or Scenario Report.
 
 |            output                        |  unit   |
 | -----------------------------------------| ------- |
@@ -62,5 +62,5 @@ REopt Lite API responses also map dispatches to the following columns in an upda
 <style type="text/css">
 .content { max-width: 1200px !important; }
 span.default { color: yellow !important; }
-.description { color: #E0E0E0		 !important; }
+.description { color: #E0E0E0 !important; }
 </style>

data/index.md

@@ -1,11 +1,11 @@
 # **URBANopt REopt Gem**
 
-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](https://reopt.nrel.gov/tool) decision support platform.
-REopt 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/v2/](https://developer.nrel.gov/docs/energy-optimization/reopt/v2/) 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](https://reopt.nlr.gov/tool) decision support platform.
+REopt 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.nlr.gov/docs/energy-optimization/reopt/v2/](https://developer.nlr.gov/docs/energy-optimization/reopt/v2/) 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 [NLR Developer Network](https://developer.nrel.gov/)
+<b>Note:</b> This module requires an API Key from the [NLR Developer Network](https://developer.nlr.gov/)
 
 ## Installation
 
@@ -83,7 +83,7 @@ Moreover, the following optimal dispatch fields are added to its timeseries CSV.
 | ElectricityProduced:Wind:ToGrid          | kWh     |
 ```
 
-The REopt 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/v2/](https://developer.nrel.gov/docs/energy-optimization/reopt/v2/) for more detailed information on input parameters and default assumptions.
+The REopt has default values for all non-required input parameters that are used unless the user specifies custom assumptions. See [https://developer..gov/docs/energy-optimization/reopt/v3/](https://developer.nlr.gov/docs/energy-optimization/reopt/v3/) 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 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).
 
@@ -110,8 +110,8 @@ timeseries_output_file = File.join(feature_report.directory_name, 'feature_repor
 #Specify non-default REopt 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 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)
+#Create a REopt Post Processor to call the API, note you will need a Developer.nlr.gov API key in this step
+reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(nil, nil, nil, DEVELOPER_API_KEY)
 
 #Call REopt 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)
@@ -145,8 +145,8 @@ end
 #Specify non-default REopt 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 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)
+#Create a REopt Post Processor to call the API, note you will need a Developer.nlr.gov API key in this step
+reopt_post_processor = URBANopt::REopt::REoptPostProcessor.new(scenario_report, reopt_assumptions_file, nil, DEVELOPER_API_KEY)
 
 #Call REopt 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)
@@ -157,9 +157,9 @@ 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 [NLR 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.nlr.gov API key from the [NLR Developer Network](https://developer.nlr.gov/]). Copy and paste your key in to the _developer_api_key_._rb_ file then save the file:
 
-    DEVELOPER_NREL_KEY = '<insert your key here>'
+    DEVELOPER_API_KEY = '<insert your key here>'
 
 Finally, execute:
 

data/lib/urbanopt/reopt/feature_report_adapter.rb

@@ -453,12 +453,23 @@ module URBANopt # :nodoc:
 
         old_data = CSV.open(feature_report.timeseries_csv.path).read
         start_date = Time.parse(old_data[1][0])
-        start_ts = (
-                      (
-                        ((start_date.yday - 1) * 60.0 * 60.0 * 24) +
-                        ((start_date.hour - 1) * 60.0 * 60.0) +
-                        (start_date.min * 60.0) + start_date.sec) / ((60 / feature_report.timesteps_per_hour) * 60)
-                    ).to_int
+        ## the commented part was causing aggregation error when running anything other than hourly (issue: 164) : hardcodes backing up by one hour which is wrong
+        #start_ts = (
+        #              (
+        #                ((start_date.yday - 1) * 60.0 * 60.0 * 24) +
+        #                ((start_date.hour - 1) * 60.0 * 60.0) +
+        #                (start_date.min * 60.0) + start_date.sec) / ((60 / feature_report.timesteps_per_hour) * 60)
+        #            ).to_int
+
+        # bug fix : issue #164 
+        start_ts = reopt_timeseries_start_index(start_date, feature_report.timesteps_per_hour)
+        # start_ts = (
+        #               (
+        #                 ((start_date.yday - 1) * 60.0 * 60.0 * 24) +
+        #                 (start_date.hour * 60.0 * 60.0) +
+        #                 (start_date.min * 60.0) + start_date.sec) / ((60 / feature_report.timesteps_per_hour) * 60)
+        #             ).to_int - 1
+
 
         mod_data = old_data.map.with_index do |x, i|
           if i > 0