refactored utils functions into multiple modules for better maintenance (#62)

Author: KapilDuwadi

examples/explore_distance.ipynb

@@ -10,15 +10,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "id": "9d22e256",
    "metadata": {},
    "outputs": [],
    "source": [
     "# 📦 Imports & Setup\n",
     "from pathlib import Path\n",
     "import matplotlib.pyplot as plt\n",
-    "from grid_reducer.utils import get_ckt_from_opendss_model\n",
+    "from grid_reducer.opendss import OpenDSS\n",
     "from grid_reducer.reducer import OpenDSSModelReducer\n",
     "from grid_reducer.add_differential_privacy import (\n",
     "    LowPrivacyConfig,\n",
@@ -28,7 +28,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "id": "bfae5523",
    "metadata": {},
    "outputs": [],
@@ -39,7 +39,7 @@
     "master_dss_path = Path(\"../tests/data/smartds/Master.dss\")\n",
     "\n",
     "# Load the circuit object from the OpenDSS model\n",
-    "ckt = get_ckt_from_opendss_model(master_dss_path)\n"
+    "ckt = OpenDSS(master_dss_path).get_circuit()\n"
    ]
   },
   {

examples/explore_graph.ipynb

@@ -19,14 +19,14 @@
     "from pathlib import Path\n",
     "import geopandas as gpd\n",
     "import pandas as pd\n",
-    "from grid_reducer.utils import get_ckt_from_opendss_model\n",
+    "from grid_reducer.opendss import OpenDSS\n",
     "from grid_reducer.network import get_graph_from_circuit\n",
     "from grid_reducer.plot import graph_to_geo_dataframe"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": null,
    "id": "bfae5523",
    "metadata": {},
    "outputs": [
@@ -46,7 +46,7 @@
     "master_dss_path = Path(\"../tests/data/smartds/Master.dss\")\n",
     "\n",
     "# Load the circuit object from the OpenDSS model\n",
-    "ckt = get_ckt_from_opendss_model(master_dss_path)\n",
+    "ckt = OpenDSS(master_dss_path).get_circuit()\n",
     "\n",
     "# Create a NetworkX graph from the circuit\n",
     "graph = get_graph_from_circuit(ckt)\n",
@@ -803,7 +803,7 @@
     "\n",
     "# Load a second circuit (e.g., a modified version for comparison)\n",
     "master_dss_path2 = Path(\"../tests/data/smartds/Master.dss\")\n",
-    "ckt2 = get_ckt_from_opendss_model(master_dss_path2)\n",
+    "ckt2 = OpenDSS(master_dss_path2).get_circuit()\n",
     "graph2 = get_graph_from_circuit(ckt2)\n",
     "gdf2 = graph_to_geo_dataframe(graph2)\n",
     "\n",

examples/explore_noise_options.ipynb

@@ -19,7 +19,7 @@
     "from pathlib import Path\n",
     "import geopandas as gpd\n",
     "import pandas as pd\n",
-    "from grid_reducer.utils import get_ckt_from_opendss_model\n",
+    "from grid_reducer.opendss import OpenDSS\n",
     "from grid_reducer.network import get_graph_from_circuit\n",
     "from grid_reducer.plot import graph_to_geo_dataframe\n",
     "from grid_reducer.reducer import OpenDSSModelReducer\n",
@@ -341,7 +341,7 @@
     "master_dss_path = Path(\"../tests/data/smartds/Master.dss\")\n",
     "\n",
     "# Load the circuit object from the OpenDSS model\n",
-    "ckt = get_ckt_from_opendss_model(master_dss_path)\n",
+    "ckt = OpenDSS(master_dss_path).get_circuit()\n",
     "reducer = OpenDSSModelReducer(master_dss_file=master_dss_path)\n",
     "reduced_ckt1 = reducer.reduce(transform_coordinate=False, noise_config=None)\n",
     "reduced_ckt2 = reducer.reduce(transform_coordinate=False, noise_config=LowPrivacyConfig)\n",

examples/explore_switch_connected_buses.ipynb

@@ -19,7 +19,7 @@
     "from pathlib import Path\n",
     "import geopandas as gpd\n",
     "import pandas as pd\n",
-    "from grid_reducer.utils import get_ckt_from_opendss_model\n",
+    "from grid_reducer.opendss import OpenDSS\n",
     "from grid_reducer.network import get_graph_from_circuit\n",
     "from grid_reducer.plot import graph_to_geo_dataframe\n",
     "from grid_reducer.smartds import download_s3_folder\n",
@@ -46,7 +46,7 @@
     "master_dss_path = Path(\"../tests/data/smartds/Master.dss\")\n",
     "\n",
     "# Load the circuit object from the OpenDSS model\n",
-    "ckt = get_ckt_from_opendss_model(master_dss_path)\n"
+    "ckt = OpenDSS(master_dss_path).get_circuit()\n"
    ]
   },
   {

src/grid_reducer/aggregate_secondary.py

@@ -22,11 +22,11 @@
     Fuse,
 )
 from grid_reducer.network import get_graph_from_circuit, get_source_connected_component
-from grid_reducer.utils import (
-    get_bus_connected_assets,
+from grid_reducer.utils.ckt import (
     get_circuit_bus_name,
-    get_normally_open_switches,
+    get_bus_connected_assets,
     get_open_lines,
+    get_normally_open_switches,
 )
 from grid_reducer.aggregators.registry import AGGREGATION_FUNC_REGISTRY
 from grid_reducer.summary import SecondaryAssetSummary, SecondaryAssetSummaryItem

src/grid_reducer/aggregators/generators.py

@@ -7,13 +7,13 @@
     Generator_Common,
     BusConnection,
 )
-from grid_reducer.utils import (
+from grid_reducer.utils.data import (
     generate_short_name,
-    get_number_of_phases_from_bus,
+    group_objects_excluding_fields,
     get_extra_param_values,
     sum_or_none,
-    group_objects_excluding_fields,
 )
+from grid_reducer.utils.parser import get_number_of_phases_from_bus
 from grid_reducer.aggregators.registry import register_aggregator
 
 

src/grid_reducer/aggregators/line.py

@@ -5,7 +5,7 @@
 
 from grid_reducer.altdss.altdss_models import Bus, Line_Common, LengthUnit
 from grid_reducer.similarity.line import LineSimilarity
-from grid_reducer.utils import generate_short_name
+from grid_reducer.utils.data import generate_short_name
 
 T = TypeVar("T")
 

src/grid_reducer/aggregators/loads.py

@@ -3,12 +3,12 @@
 from typing import Type
 
 from grid_reducer.altdss.altdss_models import Load_kWkvar, Load_kVAPF, Load_kWPF, BusConnection
-from grid_reducer.utils import (
-    get_number_of_phases_from_bus,
-    get_extra_param_values,
+from grid_reducer.utils.data import (
     generate_short_name,
     group_objects_excluding_fields,
+    get_extra_param_values,
 )
+from grid_reducer.utils.parser import get_number_of_phases_from_bus
 from grid_reducer.aggregators.registry import register_aggregator
 
 

src/grid_reducer/aggregators/pvsystems.py

@@ -7,14 +7,14 @@
     PVSystem_Common,
     BusConnection,
 )
-from grid_reducer.utils import (
+from grid_reducer.utils.data import (
     generate_short_name,
-    get_number_of_phases_from_bus,
+    group_objects_excluding_fields,
     get_extra_param_values,
     sum_or_none,
     weighted_average_or_none,
-    group_objects_excluding_fields,
 )
+from grid_reducer.utils.parser import get_number_of_phases_from_bus
 from grid_reducer.aggregators.registry import register_aggregator
 
 

src/grid_reducer/aggregators/storages.py

@@ -7,13 +7,13 @@
     Storage_Common,
     BusConnection,
 )
-from grid_reducer.utils import (
+from grid_reducer.utils.data import (
     generate_short_name,
-    get_number_of_phases_from_bus,
+    group_objects_excluding_fields,
     get_extra_param_values,
     sum_or_none,
-    group_objects_excluding_fields,
 )
+from grid_reducer.utils.parser import get_number_of_phases_from_bus
 from grid_reducer.aggregators.registry import register_aggregator