urbanopt-reopt 0.10.0 → 0.12.0

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

@@ -8,15 +8,19 @@ 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 Lite API (called internally by the gem) are:
 - *latitude*
-- *longitude* 
-- *urdb_response* 	
-	Or one of the following sets: *urdb_label*; *blended_monthly_rates_us_dollars_per_kwh*; *blended_annual_demand_charges_us_dollars_per_kw* **and** *blended_annual_rates_us_dollars_per_kwh*
-
-- *loads_kw* 
-
-	Or one of the following sets: *doe_reference_name* **and** *annual_kwh*, *doe_reference_name* **and** *monthly_totals_kwh*
+- *longitude*
+- *urdb_response* OR one of the following sets:
+	- *urdb_label*
+	- *monthly_energy_rates* **and** *monthly_demand_rates*
+	- *blended_annual_demand_rate* **and** *blended_annual_energy_rate*
+	- *urdb_utility_name* **and** *urdb_rate_name*
+	- *tou_energy_rates_per_kwh*
+
+- *loads_kw* OR one of the following sets:
+	- *doe_reference_name* **and** *annual_kwh*
+	- *doe_reference_name* **and** *monthly_totals_kwh*
 
 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.
 
@@ -24,28 +28,26 @@ Otherwise, all non-required input parameters will be filled in with default valu
 
 
 ```
-{	
-	"Scenario": {
-		"Site":{
-			"latiude":45,
-			"longitude":-110,
-			"ElectricTariff": {
-				"urdb_label":"594976725457a37b1175d089"
-			}, 
-			"LoadProfile":{
-				"doe_reference_name":"Hospital",
-				"annual_kwh":1000000
-			}
-		}
+{
+	"Site":{
+		"latitude":45,
+		"longitude":-110
+	},
+	"ElectricTariff": {
+		"urdb_label":"594976725457a37b1175d089"
+	},
+	"ElectricLoad":{
+		"doe_reference_name":"Hospital",
+		"annual_kwh":1000000
 	}
 }
 ```
 
 ## Setting Custom Assumptions
 
-If you wish to use custom input parameters, other than default values, you have a couple of options. 
+If you wish to use custom input parameters, other than default values, you have a couple of options.
 
-* 1) Custom hashes, formatted as described above, can be directly paramaterized when invoking _reopt_json_from_scenario_report_ or _reopt_jsons_from_scenario_feature_reports_ from a **URBANopt::REopt::ScenarioReportAdapter**, or  _reopt_json_from_feature_report_ from a **URBANopt::REopt::FeatureReportAdapter**. 
+* 1) Custom hashes, formatted as described above, can be directly paramaterized when invoking _reopt_json_from_scenario_report_ or _reopt_jsons_from_scenario_feature_reports_ from a **URBANopt::REopt::ScenarioReportAdapter**, or  _reopt_json_from_feature_report_ from a **URBANopt::REopt::FeatureReportAdapter**.
 
 * 2) Paths to custom hashes, formatted as described above and saved as JSON files in a common folder, can be specified in the input REopt Scenario CSV. See the [example project](https://github.com/TK-23/urbanopt-example-geojson-reopt-project.git) for more information on how to do this.
 

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

@@ -1,6 +1,6 @@
 # REopt Lite Outputs Schema
 
-When the gem calls the REopt Lite APUI it recieves 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 attibute set and timeseries CSV are pulled from the reponse 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 Lite APUI it recieves 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 attibute set and timeseries CSV are pulled from the reponse 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.
 
 ## Data Dictionary
 <ReoptOutputSchema />
@@ -12,12 +12,12 @@ The REopt Lite API updates the distributed_generation attributes of a Scenario o
 
 ```
 	"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,
+	      "lcc": 100000000.0,
+	      "npv": 10000000.0,
+	      "year_one_energy_cost_before_tax": 7000000.0,
+	      "year_one_demand_cost_before_tax": 3000000.0,
+	      "year_one_bill_before_tax": 10000000.0,
+	      "lifecycle_energy_cost_after_tax": 70000000.0,
 	      "solar_pv": {
 	        "size_kw": 30000.0
 	      },

data/index.md

@@ -1,7 +1,7 @@
 # **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 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/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.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.
 
 See the [example project](https://github.com/urbanopt/urbanopt-example-reopt-project.git) for more infomation about usage of this gem.
 
@@ -10,9 +10,9 @@ 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:
-- Ruby 2.2.6
-- Bundler 1.17.0
-- OpenStudio 2.8.1
+- Ruby 2.7.2
+- Bundler 1.21.0
+- OpenStudio 3.7.0
 
 Add this line to your application's Gemfile:
 
@@ -31,16 +31,16 @@ 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 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,
+	      "lcc": 100000000.0,
+	      "npv": 10000000.0,
+	      "year_one_energy_cost_before_tax": 7000000.0,
+	      "year_one_demand_cost_before_tax": 3000000.0,
+	      "year_one_bill_before_tax": 10000000.0,
+	      "lifecycle_energy_cost_after_tax": 70000000.0,
 	      "solar_pv": {
 	        "size_kw": 30000.0
 	      },
@@ -83,9 +83,9 @@ 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/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.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.
 
-<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).
+<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).
 
 
 
@@ -101,19 +101,19 @@ feature_reports_hash = {} # <insert a Feature Report hash here>
 #Create a Feature Report
 feature_report = URBANopt::Reporting::DefaultReports::FeatureReport.new(feature_reports_hash)
 
-#Specify a file name where REopt Lite results will be written in JSON format
+#Specify a file name where REopt 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
+#Specify a file name where the new timeseries CSV will be written after REopt 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
+#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 Lite Post Processor to call the API, note you will need a Developer.nrel.gov API key in this step
+#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)
 
-#Call REopt Lite with the post processor to update the feature's distributed generation attributes and timeseries CSV.
+#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)
 
 ```
@@ -142,13 +142,13 @@ scenario_report = URBANopt::Reporting::DefaultReports::ScenarioReport.new({:dire
   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
+#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 Lite Post Processor to call the API, note you will need a Developer.nrel.gov API key in this step
+#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)
 
-#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.
+#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)
 
 ```