Added forecast portion to FeederLoadAnalysisInput so examples can utilize it to pass through scenarios.

Signed-off-by: Jimmy Tung <jimmy.tung@zepben.com>

Author: Esaotuelr

changelog.md

@@ -13,6 +13,12 @@
   * `rating_threshold`
   * `simplify_plsi_threshold`
   * `emerg_amp_scaling`
+* Added `fla_forecast_config` to `FeederLoadAnalysisInput` which holds the config for forecast portion of feeder-load-analysis studies.
+  * `scenario_id` : The id of forecast scenario
+  * `year`: The year for forecast model
+  * `pv_upgrade_threshold`: Watts threshold to indicate if a customer site will gain additional pv during scenario application (Default to 5000).
+  * `bess_upgrade_threshold`: Watts threshold to indicate if a customer site will gain additional battery during scenario application (Default to 5000).
+  * `seed`: Seed for scenario application (Default to 123).
 
 ### Enhancements
 * None.

src/zepben/eas/client/feeder_load_analysis_input.py

@@ -10,23 +10,13 @@
     "FeederLoadAnalysisInput"
 ]
 
+from zepben.eas.client.fla_forecast_config import FlaForecastConfig
+
 
 @dataclass
 class FeederLoadAnalysisInput:
     """ A data class representing the configuration for a feeder load analysis study """
 
-    feeders: Optional[List[str]]
-    """The mRIDs of feeders to solve for feeder load analysis"""
-
-    substations: Optional[List[str]]
-    """The mRIDs of substations to solve for feeder load analysis"""
-
-    sub_geographical_regions: Optional[List[str]]
-    """The mRIDs of sub-Geographical Region to solve for feeder load analysis"""
-
-    geographical_regions: Optional[List[str]]
-    """The mRIDs of Geographical Region to solve for feeder load analysis"""
-
     start_date: str
     """Start date for this analysis"""
 
@@ -47,3 +37,18 @@ class FeederLoadAnalysisInput:
 
     output: str
     """The file name of the resulting study"""
+
+    feeders: Optional[List[str]] = None
+    """The mRIDs of feeders to solve for feeder load analysis"""
+
+    substations: Optional[List[str]] = None
+    """The mRIDs of substations to solve for feeder load analysis"""
+
+    sub_geographical_regions: Optional[List[str]] = None
+    """The mRIDs of sub-Geographical Region to solve for feeder load analysis"""
+
+    geographical_regions: Optional[List[str]] = None
+    """The mRIDs of Geographical Region to solve for feeder load analysis"""
+
+    fla_forecast_config: Optional[FlaForecastConfig] = None
+    """The forecast configuration for this fla study"""

src/zepben/eas/client/fla_forecast_config.py

@@ -0,0 +1,31 @@
+#  Copyright 2020 Zeppelin Bend Pty Ltd
+#
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+from dataclasses import dataclass
+from typing import Optional
+
+__all__ = [
+    "FlaForecastConfig"
+]
+
+
+@dataclass
+class FlaForecastConfig:
+    """ A data class representing the configuration for a forecast portion of a feeder load analysis study """
+
+    scenario_id: str
+    """The id of forecast scenario"""
+
+    year: int
+    """The year for forecast model"""
+
+    pv_upgrade_threshold: Optional[int] = 5000
+    """Watts threshold to indicate if a customer site will gain additional pv during scenario application (Default to 5000)."""
+
+    bess_upgrade_threshold: Optional[int] = 5000
+    """Watts threshold to indicate if a customer site will gain additional battery during scenario application (Default to 5000)."""
+
+    seed: Optional[int] = 123
+    """Seed for scenario application (Default to 123)."""

test/test_feeder_load_analysis_input.py

@@ -0,0 +1,43 @@
+from zepben.eas.client.feeder_load_analysis_input import FeederLoadAnalysisInput
+from zepben.eas.client.fla_forecast_config import FlaForecastConfig
+
+
+def test_feeder_load_analysis_constructor():
+    feeder_load_analysis_input = FeederLoadAnalysisInput(
+        feeders=["feeder123"],
+        substations=["sub1"],
+        sub_geographical_regions=["sgr1"],
+        geographical_regions=["gr1"],
+        start_date="2022-04-01",
+        end_date="2022-12-31",
+        fetch_lv_network=True,
+        process_feeder_loads=True,
+        process_coincident_loads=True,
+        aggregate_at_feeder_level=False,
+        output="Test",
+        fla_forecast_config=FlaForecastConfig(
+            scenario_id="1",
+            year=2030,
+            pv_upgrade_threshold=8000,
+            bess_upgrade_threshold=8000,
+            seed=64513
+        )
+    )
+
+    assert feeder_load_analysis_input is not None
+    assert feeder_load_analysis_input.feeders == ["feeder123"]
+    assert feeder_load_analysis_input.substations == ["sub1"]
+    assert feeder_load_analysis_input.sub_geographical_regions == ["sgr1"]
+    assert feeder_load_analysis_input.geographical_regions == ["gr1"]
+    assert feeder_load_analysis_input.start_date == "2022-04-01"
+    assert feeder_load_analysis_input.end_date == "2022-12-31"
+    assert feeder_load_analysis_input.fetch_lv_network == True
+    assert feeder_load_analysis_input.process_feeder_loads == True
+    assert feeder_load_analysis_input.process_coincident_loads == True
+    assert feeder_load_analysis_input.aggregate_at_feeder_level == False
+    assert feeder_load_analysis_input.output == "Test"
+    assert feeder_load_analysis_input.fla_forecast_config.scenario_id == "1"
+    assert feeder_load_analysis_input.fla_forecast_config.year == 2030
+    assert feeder_load_analysis_input.fla_forecast_config.pv_upgrade_threshold == 8000
+    assert feeder_load_analysis_input.fla_forecast_config.bess_upgrade_threshold == 8000
+    assert feeder_load_analysis_input.fla_forecast_config.seed == 64513