rename price signals dispatch to retail rate (#1495)

* rename price signals dispatch to retail rate * additional startup.lk modifications to complete the renaming for hybrids, get self consumption working in a few more configurations
NREL · Oct 16, 2023 · 8bfe926 · 8bfe926
1 parent 7dad239
commit 8bfe926
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/deploy/runtime/startup.lk b/deploy/runtime/startup.lk
@@ -188,7 +188,7 @@ function setup_pages_battery_dispatch_btm()
 	          [ {'name'='Battery Dispatch Grid Power Targets', 'caption'='Grid Power Targets'} ],
 		      [ {'name'='Battery Dispatch Battery Power Targets', 'caption'='Battery Power Targets'}],
 		      [ {'name'='Battery Dispatch Manual', 'caption'='Manual'}],
-		      [ {'name'='Battery Dispatch Price Signal', 'caption'='Price Signal'} ],
+		      [ {'name'='Battery Dispatch Retail Rate', 'caption'='Retail Rate'} ],
 		      [ {'name'='Battery Dispatch Self Consumption', 'caption'='Self Consumption'} ]],
 			    { 'sidebar'='Battery Dispatch', 'help'='battery_dispatch_btm',
 			      'exclusive_var' = 'batt_dispatch_excl',
@@ -201,7 +201,7 @@ function setup_pages_standalone_battery_dispatch_btm()
 	          [ {'name'='Battery Dispatch Grid Power Targets', 'caption'='Grid Power Targets'} ],
 		      [ {'name'='Battery Dispatch Battery Power Targets', 'caption'='Battery Power Targets'}],
 		      [ {'name'='Battery Dispatch Manual', 'caption'='Manual'}],
-		      [ {'name'='Battery Dispatch Price Signal', 'caption'='Price Signal'} ]],
+		      [ {'name'='Battery Dispatch Retail Rate', 'caption'='Retail Rate'} ]],
 			    { 'sidebar'='Battery Dispatch', 'help'='battery_dispatch_btm',
 			      'exclusive_var' = 'batt_dispatch_excl',
 			      'exclusive_header_pages' = ['Battery Dispatch Common', 'Battery Dispatch Standalone Options BTM'], 'exclusive_tabs'=true, 'exclusive_hide'=true, 'bin_name'='Battery'  } );
@@ -1255,7 +1255,7 @@ addpage( [[ {'name'='Battery Dispatch Peak Shaving BTM', 'caption'='Peak Shaving
 		  [ {'name'='Battery Dispatch Grid Power Targets', 'caption'='Grid Power Targets'} ],
 		  [ {'name'='Battery Dispatch Battery Power Targets', 'caption'='Battery Power Targets'}],
 		  [ {'name'='Battery Dispatch Manual', 'caption'='Manual'}],
-		  [ {'name'='Battery Dispatch Price Signal', 'caption'='Price Signal'} ],
+		  [ {'name'='Battery Dispatch Retail Rate', 'caption'='Retail Rate'} ],
 		  [ {'name'='Battery Dispatch Self Consumption', 'caption'='Self Consumption'} ]],
 		 { 'sidebar'='Battery Dispatch', 'help'='battery_dispatch_btm', 'exclusive_var' = 'batt_dispatch_excl', 'exclusive_header_pages' = ['Battery Dispatch Common', 'Battery Dispatch Options BTM'], 'exclusive_tabs'=true, 'exclusive_hide'=true  } );
 addpage( [[ 'Fuel Cell' ]], 
@@ -2850,7 +2850,7 @@ addpage( [[ 'Operating Costs Fuel Cell Hybrid' ]], { 'sidebar'='Fuel Cell Operat
 // battery
 addpage( [[ 'Battery Model', 'Battery Bank Sizing', 'Battery Current and Capacity', 'Battery Configuration', {'name'='Battery Voltage', 'caption'='Battery Voltage', 'collapsible'=true, 'collapsible_var'='battery_voltage_shown'}, {'name'='Battery Ancillary Losses', 'caption'='Battery Losses', 'collapsible'=true, 'collapsible_var'='battery_losses_shown'}, {'name'='Battery Thermal', 'caption'='Battery Thermal', 'collapsible'=true, 'collapsible_var'='battery_thermal_shown'}, 'Battery Standalone Enable', ]], { 'sidebar'='Battery Cell and System', 'help'='battery_storage_btm', 'bin_name'='Battery'  } );
 addpage( [[ {'name'='Battery Life Cycle Calendar', 'caption'='Calendar and Cycle Degradation'}], [{'name'='Battery Life Empty 1','caption'='Li-on NMC/Graphite Degradation'}], [{'name'='Battery Life Empty 2','caption'='Li-ion LMO/LTO Degradation'}]], {'sidebar'='Battery Life', 'help'='battery_life' , 'exclusive_var' = 'batt_life_excl', 'exclusive_header_pages' = ['Battery Replacements','Battery Life Options' ], 'exclusive_tabs' = true, 'exclusive_hide' = true, 'bin_name'='Battery'  } );
-addpage( [[ {'name'='Battery Dispatch Peak Shaving BTM', 'caption'='Peak Shaving'} ], [ {'name'='Battery Dispatch Grid Power Targets', 'caption'='Grid Power Targets'} ], [ {'name'='Battery Dispatch Battery Power Targets', 'caption'='Battery Power Targets'}], [ {'name'='Battery Dispatch Manual', 'caption'='Manual'}], [ {'name'='Battery Dispatch Price Signal', 'caption'='Price Signal'} ]], { 'sidebar'='Battery Dispatch', 'help'='battery_dispatch_btm', 'exclusive_var' = 'batt_dispatch_excl', 'exclusive_header_pages' = ['Battery Dispatch Common', 'Battery Dispatch Options BTM'], 'exclusive_tabs'=true, 'exclusive_hide'=true, 'bin_name'='Battery' } );
+addpage( [[ {'name'='Battery Dispatch Peak Shaving BTM', 'caption'='Peak Shaving'} ], [ {'name'='Battery Dispatch Grid Power Targets', 'caption'='Grid Power Targets'} ], [ {'name'='Battery Dispatch Battery Power Targets', 'caption'='Battery Power Targets'}], [ {'name'='Battery Dispatch Manual', 'caption'='Manual'}], [ {'name'='Battery Dispatch Retail Rate', 'caption'='Retail Rate'} ], [ {'name'='Battery Dispatch Self Consumption', 'caption'='Self Consumption'} ]], { 'sidebar'='Battery Dispatch', 'help'='battery_dispatch_btm', 'exclusive_var' = 'batt_dispatch_excl', 'exclusive_header_pages' = ['Battery Dispatch Common', 'Battery Dispatch Options BTM'], 'exclusive_tabs'=true, 'exclusive_hide'=true, 'bin_name'='Battery' } );
 addpage( [[ 'Standalone Battery Costs', 'Battery Enable' ]],{ 'sidebar'='Battery Installation Costs', 'help'='cc_standalone_battery', 'bin_name'='Battery' } );
 addpage( [[ 'Operating Costs Standalone Battery']],{ 'sidebar'='Battery Operating Costs', 'help'='oc_battery', 'bin_name'='Battery' } );
 // grid
@@ -3159,7 +3159,7 @@ addpage( [[ 'Operating Costs Fuel Cell Hybrid' ]], { 'sidebar'='Fuel Cell Operat
 // battery
 addpage( [[ 'Battery Model', 'Battery Bank Sizing', 'Battery Current and Capacity', 'Battery Configuration', {'name'='Battery Voltage', 'caption'='Battery Voltage', 'collapsible'=true, 'collapsible_var'='battery_voltage_shown'}, {'name'='Battery Ancillary Losses', 'caption'='Battery Losses', 'collapsible'=true, 'collapsible_var'='battery_losses_shown'}, {'name'='Battery Thermal', 'caption'='Battery Thermal', 'collapsible'=true, 'collapsible_var'='battery_thermal_shown'}, 'Battery Standalone Enable', ]], { 'sidebar'='Battery Cell and System', 'help'='battery_storage_btm', 'bin_name'='Battery'  } );
 addpage( [[ {'name'='Battery Life Cycle Calendar', 'caption'='Calendar and Cycle Degradation'}], [{'name'='Battery Life Empty 1','caption'='Li-on NMC/Graphite Degradation'}], [{'name'='Battery Life Empty 2','caption'='Li-ion LMO/LTO Degradation'}]], {'sidebar'='Battery Life', 'help'='battery_life' , 'exclusive_var' = 'batt_life_excl', 'exclusive_header_pages' = ['Battery Replacements','Battery Life Options' ], 'exclusive_tabs' = true, 'exclusive_hide' = true, 'bin_name'='Battery'  } );
-addpage( [[ {'name'='Battery Dispatch Peak Shaving BTM', 'caption'='Peak Shaving'} ], [ {'name'='Battery Dispatch Grid Power Targets', 'caption'='Grid Power Targets'} ], [ {'name'='Battery Dispatch Battery Power Targets', 'caption'='Battery Power Targets'}], [ {'name'='Battery Dispatch Manual', 'caption'='Manual'}], [ {'name'='Battery Dispatch Price Signal', 'caption'='Price Signal'} ]], { 'sidebar'='Battery Dispatch', 'help'='battery_dispatch_btm', 'exclusive_var' = 'batt_dispatch_excl', 'exclusive_header_pages' = ['Battery Dispatch Common', 'Battery Dispatch Options BTM'], 'exclusive_tabs'=true, 'exclusive_hide'=true, 'bin_name'='Battery' } );
+addpage( [[ {'name'='Battery Dispatch Peak Shaving BTM', 'caption'='Peak Shaving'} ], [ {'name'='Battery Dispatch Grid Power Targets', 'caption'='Grid Power Targets'} ], [ {'name'='Battery Dispatch Battery Power Targets', 'caption'='Battery Power Targets'}], [ {'name'='Battery Dispatch Manual', 'caption'='Manual'}], [ {'name'='Battery Dispatch Retail Rate', 'caption'='Retail Rate'} ], [ {'name'='Battery Dispatch Self Consumption', 'caption'='Self Consumption'} ]], { 'sidebar'='Battery Dispatch', 'help'='battery_dispatch_btm', 'exclusive_var' = 'batt_dispatch_excl', 'exclusive_header_pages' = ['Battery Dispatch Common', 'Battery Dispatch Options BTM'], 'exclusive_tabs'=true, 'exclusive_hide'=true, 'bin_name'='Battery' } );
 addpage( [[ 'Standalone Battery Costs', 'Battery Enable' ]],{ 'sidebar'='Battery Installation Costs', 'help'='cc_standalone_battery', 'bin_name'='Battery' } );
 addpage( [[ 'Operating Costs Standalone Battery']],{ 'sidebar'='Battery Operating Costs', 'help'='oc_battery', 'bin_name'='Battery' } );
 // grid

diff --git a/deploy/runtime/ui/Battery Dispatch Options BTM.json b/deploy/runtime/ui/Battery Dispatch Options BTM.json
@@ -282,7 +282,7 @@
                 },
                 "Items": {
                     "Type": 6.0,
-                    "StringList": "Peak shaving|Input grid power targets|Input battery power targets|Manual dispatch|Price signal forecast|Self-consumption"
+                    "StringList": "Peak shaving|Input grid power targets|Input battery power targets|Manual dispatch|Retail rate dispatch|Self-consumption"
                 },
                 "ShowCaptions": {
                     "Type": 2.0,
@@ -586,7 +586,7 @@
             "Label": "Battery dispatch options BTM",
             "Units": " ",
             "Group": "Battery Dispatch",
-            "IndexLabels": "Peak shaving|Input grid power targets|Input battery power targets|Manual dispatch|Price signal forecast|Self-consumption",
+            "IndexLabels": "Peak shaving|Input grid power targets|Input battery power targets|Manual dispatch|Retail rate dispatch|Self-consumption",
             "Flags": 3.0,
             "DefaultValue": 0.0,
             "UIObject": "RadioChoice",

diff --git a/...ime/ui/Battery Dispatch Price Signal.json → ...time/ui/Battery Dispatch Retail Rate.json b/...ime/ui/Battery Dispatch Price Signal.json → ...time/ui/Battery Dispatch Retail Rate.json
@@ -1,5 +1,5 @@
 {
-    "Name": "Battery Dispatch Price Signal",
+    "Name": "Battery Dispatch Retail Rate",
     "Width": 1052.0,
     "Height": 520.0,
     "FormObjects": {
@@ -848,7 +848,7 @@
                 },
                 "Caption": {
                     "Type": 5.0,
-                    "String": "Price Signal Forecast"
+                    "String": "Retail Rate Dispatch"
                 },
                 "Bold": {
                     "Type": 2.0,
@@ -885,7 +885,7 @@
                 },
                 "Caption": {
                     "Type": 5.0,
-                    "String": "The price signal forecast option operates the battery to minimize the electricity bill based on an electricity price estimate that represents the cost to the system owner of purchasing electricity from the grid in each time step."
+                    "String": "The retail rate dispatch option operates the battery to minimize the electricity bill based on an electricity price estimate that represents the cost to the system owner of purchasing electricity from the grid in each time step."
                 },
                 "TextColour": {
                     "Type": 4.0,
@@ -1048,7 +1048,7 @@
     },
     "Equations": [],
     "Callbacks": [
-        "on_load{'Battery Dispatch Price Signal'}=define()",
+        "on_load{'Battery Dispatch Retail Rate'}=define()",
         "{\t",
         "\tvalue('batt_dispatch_choice', 4);",
         "\ttoggle_forecast_standalone_psd();",

diff --git a/deploy/runtime/ui/Battery Dispatch Standalone Options BTM.json b/deploy/runtime/ui/Battery Dispatch Standalone Options BTM.json
@@ -118,7 +118,7 @@
                 },
                 "Items": {
                     "Type": 6.0,
-                    "StringList": "Peak shaving|Input grid power targets|Input battery power targets|Manual dispatch|Price signal forecast"
+                    "StringList": "Peak shaving|Input grid power targets|Input battery power targets|Manual dispatch|Retail rate dispatch"
                 },
                 "ShowCaptions": {
                     "Type": 2.0,
@@ -267,7 +267,7 @@
             "Label": "Battery dispatch choice",
             "Units": " ",
             "Group": "Battery Dispatch",
-            "IndexLabels": "Peak shaving| Input grid power targets| Input battery power targets| Manual dispatch| Price signal forecast",
+            "IndexLabels": "Peak shaving| Input grid power targets| Input battery power targets| Manual dispatch| Retail rate dispatch",
             "Flags": 3.0,
             "DefaultValue": 3.0,
             "UIObject": "RadioChoice",