[DEV-3152] Add EAS Python SDK methods for running opendss export

changelog.md

@@ -12,6 +12,7 @@
 * Added basic client method to run a hosting capacity calibration and method to query its status.
 * Added basic client method to run a hosting capacity work package cost estimation.
 * Added `FixedTimeLoadOverride` and `TimePeriodLoadOverride` class
+* Added basic client method to run a opendss export, query its information and get a download url for the exported model.
 
 ### Enhancements
 * Added work package config documentation.

src/zepben/eas/client/hc_commons.py

@@ -17,35 +17,36 @@
     "BASIC_RESULTS_CONFIG",
 ]
 
-from zepben.eas import StoredResultsConfig, RawResultsConfig, MetricsResultsConfig, ResultsConfig
+from build.lib.zepben.eas.client.work_package import ResultsConfig
+from zepben.eas import StoredResultsConfig, RawResultsConfig, MetricsResultsConfig
 
 STORED_RESULTS_CONFIG_STORE_NONE = StoredResultsConfig(
     energy_meters_raw=False,
     energy_meter_voltages_raw=False,
-    over_loads_raw=False,
+    overloads_raw=False,
     voltage_exceptions_raw=False
 )
 
 STORED_RESULTS_CONFIG_STORE_ALL = StoredResultsConfig(
     energy_meters_raw=True,
     energy_meter_voltages_raw=True,
-    over_loads_raw=True,
+    overloads_raw=True,
     voltage_exceptions_raw=True
 )
 
 RAW_RESULTS_CONFIG_ALL_RAW_VALUES = RawResultsConfig(
     energy_meters_raw=True,
     energy_meter_voltages_raw=True,
     results_per_meter=True,
-    over_loads_raw=True,
+    overloads_raw=True,
     voltage_exceptions_raw=True
 )
 
 RAW_RESULTS_CONFIG_STANDARD = RawResultsConfig(
     energy_meters_raw=True,
     energy_meter_voltages_raw=True,
     results_per_meter=True,
-    over_loads_raw=True,
+    overloads_raw=True,
     voltage_exceptions_raw=True
 )
 
@@ -69,7 +70,7 @@
 STANDARD_RESULTS_CONFIG = ResultsConfig(
     raw_config=RAW_RESULTS_CONFIG_STANDARD,
     metrics_config=METRICS_RESULTS_CONFIG_CALCULATE_PERFORMANCE_METRICS,
-    stored_results_config=StoredResultsConfig(voltage_exceptions_raw=True, over_loads_raw=True)
+    stored_results_config=StoredResultsConfig(voltage_exceptions_raw=True, overloads_raw=True)
 )
 
 BASIC_RESULTS_CONFIG = ResultsConfig(

src/zepben/eas/client/opendss.py

@@ -0,0 +1,61 @@
+#  Copyright 2025 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 datetime import tzinfo
+from enum import Enum
+from typing import Union, Optional, List
+
+from zepben.eas.client.work_package import GeneratorConfig, TimePeriod, FixedTime
+
+__all__ = [
+    "OpenDssConfig",
+    "OpenDssModelState",
+    "GetOpenDssModelsFilterInput",
+    "Order",
+    "GetOpenDssModelsSortCriteriaInput"
+]
+
+
+@dataclass
+class OpenDssConfig:
+    """ A data class representing the configuration for an opendss export """
+    scenario: str
+    year: int
+    feeder: str
+    time_zone: tzinfo
+    load_time: Union[TimePeriod, FixedTime]
+    generator_config: Optional[GeneratorConfig] = None
+    model_name: Optional[str] = None
+    is_public: Optional[bool] = None
+
+
+class OpenDssModelState(Enum):
+    COULD_NOT_START = "COULD_NOT_START"
+    CREATION = "CREATION"
+    COMPLETED = "COMPLETED"
+    FAILED = "FAILED"
+
+
+@dataclass
+class GetOpenDssModelsFilterInput:
+    """ A data class representing the filter to apply to the opendss export run paginated query """
+    name: Optional[str] = None
+    is_public: Optional[int] = None
+    state: Optional[List[OpenDssModelState]] = None
+
+
+class Order(Enum):
+    ASC = "ASC"
+    DESC = "DESC"
+
+
+@dataclass
+class GetOpenDssModelsSortCriteriaInput:
+    """ A data class representing the sort criteria to apply to the opendss export run paginated query """
+    name: Optional[Order] = None
+    created_at: Optional[Order] = None
+    state: Optional[Order] = None
+    is_public: Optional[Order] = None

src/zepben/eas/client/work_package.py

@@ -69,7 +69,6 @@ class SwitchMeterPlacementConfig:
 
 @dataclass
 class FixedTimeLoadOverride:
-
     load_watts: Optional[float]
     """
     The reading to be used to override load watts
@@ -95,7 +94,6 @@ class FixedTimeLoadOverride:
 
 @dataclass
 class TimePeriodLoadOverride:
-
     load_watts: Optional[List[float]]
     """
     A list of readings to be used to override load watts.