fixed typing and added support to convert switches to pandamodels.

Author: vogt31337

pandapower/converter/pandamodels/to_pm.py

@@ -8,6 +8,7 @@
 import math
 import os
 import tempfile
+from copy import deepcopy
 
 from os import remove
 from os.path import isfile
@@ -25,6 +26,9 @@
 from pandapower.pypower.idx_cost import MODEL, NCOST, COST
 from pandapower.pypower.idx_gen import PG, QG, GEN_BUS, VG, GEN_STATUS, QMAX, QMIN, PMIN, PMAX
 from pandapower.results import init_results, verify_results
+from pandapower.auxiliary import pandapowerNet
+from collections.abc import Callable
+from typing import Literal
 
 
 # const value in branch for tnep
@@ -51,13 +55,31 @@ def default(self, obj):
         return json.JSONEncoder.default(self, obj)
 
 
-def convert_pp_to_pm(net, pm_file_path=None, correct_pm_network_data=True,
-                     calculate_voltage_angles=True,
-                     ac=True, silence=True, trafo_model="t", delta=1e-8, trafo3w_losses="hv",
-                     check_connectivity=True, pp_to_pm_callback=None, pm_model="ACPPowerModel",
-                     pm_solver="ipopt",
-                     pm_mip_solver="cbc", pm_nl_solver="ipopt", opf_flow_lim="S", pm_tol=1e-8,
-                     voltage_depend_loads=False, from_time_step=None, to_time_step=None, init_vm_pu="flat", init_va_degree="flat", **kwargs):
+def convert_pp_to_pm(
+        net: pandapowerNet,
+        pm_file_path: str | None = None,
+        correct_pm_network_data: bool | None = True,
+        calculate_voltage_angles: bool | None = True,
+        ac: bool | None = True,
+        silence: bool | None = True,
+        trafo_model: str | None = "t",
+        delta: float | None = 1e-8,
+        trafo3w_losses: str | None = "hv",
+        check_connectivity: bool | None = True,
+        pp_to_pm_callback: Callable | None = None,
+        pm_model: str | None = "ACPPowerModel",
+        pm_solver: str | None = "ipopt",
+        pm_mip_solver: str | None = "cbc",
+        pm_nl_solver: str | None = "ipopt",
+        opf_flow_lim: str | None = "S",
+        pm_tol: float | None = 1e-8,
+        voltage_depend_loads: bool | None = False,
+        from_time_step: int | None = None,
+        to_time_step: int | None = None,
+        init_vm_pu: Literal["flat", "results"] | float = "flat",
+        init_va_degree: Literal["dc", "flat", "results"] | float = "flat",
+        **kwargs
+):
     """
     Converts a pandapower net to a PowerModels.jl datastructure and saves it to a json file
     INPUT:
@@ -106,6 +128,19 @@ def convert_pp_to_pm(net, pm_file_path=None, correct_pm_network_data=True,
         net.load.const_z_q_percent and net.load.const_i_q_percent are not considered,
         i.e. net.load.p_mw and net.load.q_mvar are considered as constant-power loads.
 
+        **from_time_step** (int, None) - for timeseries calculation / optimization,
+        starting timestep (to_time_step must be also set!).
+
+        **to_time_step** (int, None) - for timeseries calculation / optimization,
+        starting timestep (from_time_step must be also set!).
+
+        **init_vm_pu** (["flat", "results"], float) - Allows to define initialization
+        specifically for voltage magnitudes.
+
+        **init_va_degree** (["dc", "flat", "results"], float) - Allows to define
+        initialization specifically for voltage angles.
+
+
     Returns
     -------
     """
@@ -135,8 +170,13 @@ def convert_pp_to_pm(net, pm_file_path=None, correct_pm_network_data=True,
 logger = logging.getLogger(__name__)
 
 
-def convert_to_pm_structure(net, opf_flow_lim="S", from_time_step=None, to_time_step=None, 
-                            **kwargs):
+def convert_to_pm_structure(
+        net: pandapowerNet,
+        # opf_flow_lim: str = "S", # unused, is saved in net["_opf_options"].
+        from_time_step: int | None = None,
+        to_time_step: int | None = None,
+        **kwargs
+):
     if net["_options"]["voltage_depend_loads"] and not (
             np.allclose(net.load.const_z_p_percent.values, 0) and
             np.allclose(net.load.const_i_p_percent.values, 0) and
@@ -164,7 +204,10 @@ def convert_to_pm_structure(net, opf_flow_lim="S", from_time_step=None, to_time_
     return net, pm, ppc, ppci
 
 
-def dump_pm_json(pm, buffer_file=None):
+def dump_pm_json(
+        pm: dict,
+        buffer_file: str | None = None
+):
     # dump pm dict to buffer_file (*.json)
     if buffer_file is None:
         # if no buffer file is provided a random file name is generated
@@ -256,11 +299,22 @@ def ppc_to_pm(net, ppci):
     # create power models dict. Similar to matpower case file. ne_branch is for a tnep case
     # "per_unit == True" means that the grid data in PowerModels are per-unit values. In this
     # ppc-to-pm process, the grid data schould be transformed according to baseMVA = 1.
-    pm = {"gen": {}, "branch": {}, "bus": {}, "dcline": {}, "load": {},
-          "storage": {},
-          "ne_branch": {}, "switch": {},
-          "baseMVA": ppci["baseMVA"], "source_version": "2.0.0", "shunt": {},
-          "sourcetype": "matpower", "per_unit": True, "name": net.name}
+    pm = {
+        "gen": {},
+        "branch": {},
+        "bus": {},
+        "dcline": {},
+        "load": {},
+        "storage": {},
+        "ne_branch": {},
+        "switch": {},
+        "baseMVA": ppci["baseMVA"],
+        "source_version": "2.0.0",
+        "shunt": {},
+        "sourcetype": "matpower",
+        "per_unit": True,
+        "name": net.name
+    }
     baseMVA = ppci["baseMVA"]
     load_idx = 1
     shunt_idx = 1
@@ -315,8 +369,27 @@ def ppc_to_pm(net, ppci):
             shunt_idx += 1
         pm["bus"][str(idx)] = bus
 
+    # number of bus-bus switches in the network
+    n_bb_switches = net._impedance_bb_switches.sum()
+
     n_lines = net.line.in_service.sum()
     for idx, row in enumerate(ppci["branch"], start=1):
+
+        # the bus-bus switches are added to the end of the ppci, +1 since we use 1-indexing.
+        if idx > (n_lines - n_bb_switches + 1):
+            switch = {
+                "index": idx,
+                "f_bus": int(row[F_BUS].real) + 1,
+                "t_bus": int(row[T_BUS].real) + 1,
+                "status": 1,
+                "state": 1,
+                "thermal_rating": np.inf,
+                "psw": 0.,
+                "qsw": 0.,
+            }
+            pm["switch"][str(idx - n_lines)] = switch
+            continue
+
         branch = {}
         branch["index"] = idx
         branch["transformer"] = bool(idx > n_lines)
@@ -346,6 +419,8 @@ def ppc_to_pm(net, ppci):
         branch["shift"] = math.radians(row[SHIFT].real)
         pm["branch"][str(idx)] = branch
 
+
+
     #### create pm["gen"]
     gen_idxs_pm = [str(i+1) for i in range(len(ppci["gen"]))]
     gen_df = pd.DataFrame(index=gen_idxs_pm)
@@ -562,7 +637,12 @@ def add_params_to_pm(net, pm):
     return pm
 
 
-def add_time_series_to_pm(net, pm, from_time_step, to_time_step):
+def add_time_series_to_pm(
+        net: pandapowerNet,
+        pm: dict,
+        from_time_step: int,
+        to_time_step: int
+):
     from pandapower.control import ConstControl
     if from_time_step is None or to_time_step is None:
         raise ValueError("please define 'from_time_step' " +

pandapower/test/opf/test_pandamodels_runpm.py

@@ -16,7 +16,7 @@
 from pandapower.converter.pandamodels import convert_pp_to_pm
 from pandapower.converter.pandamodels.to_pm import init_ne_line
 from pandapower.create import create_storage, create_shunt, create_pwl_cost, create_poly_cost, create_empty_network, \
-    create_bus, create_line, create_gen, create_load, create_transformer3w_from_parameters, create_sgen, \
+    create_bus, create_line, create_gen, create_load, create_transformer3w_from_parameters, create_sgen, create_switch,\
     create_transformer3w
 from pandapower.networks.cigre_networks import create_cigre_network_mv
 from pandapower.networks.power_system_test_cases import case5, case9, case14, case30, case39, case57, case118, \
@@ -768,5 +768,15 @@ def test_ac_opf_differnt_snmva():
         assert res[i].values.min() - res[i].values.max() < 1e-10
 
 
+@pytest.mark.skipif(not julia_installed, reason="requires julia installation")
+def test_switches():
+    net = case5()
+
+    create_switch(net, bus=0, element=1, et='b')
+    create_switch(net, bus=2, element=1, et='b', z_ohm=1e-3, closed=True, in_ka=1000.)
+    create_switch(net, bus=2, element=3, et='b')
+
+    runpm_ac_opf(net)
+
 if __name__ == '__main__':
     pytest.main([__file__, "-xs"])