Add OpenDss export example

setup.py

@@ -20,7 +20,7 @@
     package_dir={'': 'src'},
     python_requires='>=3.9, <3.13',
     install_requires=[
-        "zepben.eas==0.17.1",
+        "zepben.eas==0.19.0",
         "zepben.evolve==0.48.0",
         "numba==0.60.0",
         "geojson==2.5.0",

src/zepben/examples/export_open_dss_model.py

@@ -0,0 +1,125 @@
+#  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 datetime import datetime
+
+from zepben.eas.client.opendss import OpenDssConfig
+from zepben.eas.client.work_package import GeneratorConfig, ModelConfig, LoadPlacement, FeederScenarioAllocationStrategy, SolveConfig, RawResultsConfig, \
+    MeterPlacementConfig, SwitchMeterPlacementConfig, SwitchClass
+from zepben.eas import EasClient, TimePeriod
+from time import sleep
+import requests
+
+
+def wait_for_export(eas_client: EasClient, model_id: int):
+    # Wait for OpenDss model export to complete
+    wait_limit_seconds = 3000
+    step_seconds = 2
+    total = 0
+    print(f"Waiting for model generation ({wait_limit_seconds} seconds) ", end='')
+    # Retrieve the model information for the model we just requested
+    model = eas_client.get_opendss_model(model_id)
+    while model["state"] != "COMPLETED":
+        model = eas_client.get_opendss_model(model_id)
+        print(".", end='')
+        sleep(step_seconds)
+        total += step_seconds
+        if total > wait_limit_seconds:
+            raise TimeoutError("Timed out waiting for model export to complete.")
+
+
+def download_generated_model(eas_client: EasClient, output_file_name: str, model_id: int):
+    url = eas_client.get_opendss_model_download_url(model_id)
+    if url == f'Model with id {model_id} is still being created':
+        print(url)
+        print("Download failed.")
+        return
+
+    print(f"\nURL (30 second expiry): {url}", )
+
+    file_name = f"{output_file_name}-{model_id}.zip"
+    print(f"Downloading model zip to: {file_name}")
+
+    try:
+        with open(file_name, mode="wb") as file:
+            file.write(requests.get(url).content)
+        print("Download complete.")
+    except Exception as error:
+        print("Download failed.")
+        print(error)
+
+
+def test_open_dss_export(export_file_name: str):
+    eas_client = EasClient(
+        "<EAS_HOSTNAME>",
+        443,
+        access_token="<PERSONAL_ACCESS_TOKEN>"
+    )
+
+    # Run an opendss export
+    print("Sending OpenDss model export request to EAS")
+
+    response = eas_client.run_opendss_export(
+        OpenDssConfig(
+            scenario="Base",
+            year=2024,
+            feeder="<FEEDER_ID>",
+            load_time=TimePeriod(
+                datetime.strptime("2024-04-01T00:00:00", "%Y-%m-%dT%H:%M:%S"),
+                datetime.strptime("2025-04-01T00:00:00", "%Y-%m-%dT%H:%M:%S")
+            ),
+            generator_config=GeneratorConfig(
+                model=ModelConfig(
+                    meter_placement_config=MeterPlacementConfig(
+                        feeder_head=True,
+                        dist_transformers=True,
+                        switch_meter_placement_configs=[SwitchMeterPlacementConfig(
+                            meter_switch_class=SwitchClass.DISCONNECTOR,
+                            name_pattern=".*Circuit Head Switch.*"
+                        )]
+                    ),
+                    vmax_pu=1.2,
+                    vmin_pu=0.8,
+                    p_factor_base_exports=-1,
+                    p_factor_base_imports=1,
+                    p_factor_forecast_pv=0.98,
+                    fix_single_phase_loads=True,
+                    max_single_phase_load=15000.0,
+                    max_load_service_line_ratio=1.0,
+                    max_load_lv_line_ratio=2.0,
+                    max_load_tx_ratio=2.0,
+                    max_gen_tx_ratio=4.0,
+                    fix_overloading_consumers=True,
+                    fix_undersized_service_lines=True,
+                    feeder_scenario_allocation_strategy=FeederScenarioAllocationStrategy.ADDITIVE,
+                    closed_loop_v_reg_enabled=True,
+                    closed_loop_v_reg_set_point=0.9825,
+                    seed=123,
+                ),
+                solve=SolveConfig(step_size_minutes=30.0),
+                raw_results=RawResultsConfig(True, True, True, True, True)
+            ),
+            model_name=export_file_name,
+            is_public=True
+        )
+    )
+    print(f"Raw 'run_opendss_export' response: '{response}'")
+    model_id = response["data"]["createOpenDssModel"]
+    print(f"New OpenDss model export id: {model_id}")
+
+    try:
+        wait_for_export(eas_client, int(model_id))
+
+        # Request a download URL from EAS and download to a local file
+        download_generated_model(eas_client, export_file_name, int(model_id))
+
+    except TimeoutError:
+        print("\nERROR: Timed out waiting for model export to complete.")
+
+    eas_client.close()
+
+
+if __name__ == "__main__":
+    test_open_dss_export("test_export-model")