adding possibility to pickle / unpickle each gridmodel container independantly

Signed-off-by: DONNOT Benjamin <[email protected]>

Author: BDonnot

CHANGELOG.rst

@@ -34,6 +34,9 @@ TODO: integration test with pandapower (see `pandapower/contingency/contingency.
 - [FIXED] phase shift transformers are now properly modeled
   for both pandapower (new in this version) and pypowsybl (already
   the case in previous version)
+- [ADDED] possibility to pickle independantly all part of the grid (*eg* gridmodel.get_lines()
+  can be pickled independantly from anything else) **NB** pickling and un-pickling 
+  lightsim2grid objects can only be used for the same lightsim2grid version.
 
 [0.12.0] 2026-01-06
 --------------------

env_compile_all.sh

@@ -0,0 +1,4 @@
+export __COMPILE_MARCHNATIVE=1
+export __O3_OPTIM=1
+export PATH_CKTSO=`pwd`/cktso
+export PATH_NICSLU=`pwd`/nicslu/nicslu202110

lightsim2grid/gridmodel/from_pandapower/_aux_add_trafo.py

@@ -80,7 +80,7 @@ def _aux_add_trafo(
         if np.any(pp_net.trafo3w["tap_changer_type"].values == "Ideal"):
             raise RuntimeError("Ideal phase shifters are not modeled. Please remove all 3-winding trafos "
                                "with \"tap_changer_type\" set to \"Ideal\".")
-
+            
     tap_angles_ = 1.0 * pp_net.trafo["tap_step_degree"].values
     if np.any(~np.isfinite(tap_angles_)):
         warnings.warn("There were some Nan in the pp_net.trafo[\"tap_step_degree\"], they have been replaced by 0")
@@ -133,6 +133,7 @@ def _aux_add_trafo(
                                           )
 
     # initialize the grid
+    do_ignore_tap_side_for_phase_shift = True
     model.init_trafo_pandapower(trafo_r,
                                 trafo_x,
                                 trafo_b,
@@ -141,7 +142,8 @@ def _aux_add_trafo(
                                 shift_,
                                 is_tap_hv_side,
                                 pp_bus_to_ls(pp_net.trafo["hv_bus"].values, pp_to_ls),
-                                pp_bus_to_ls(pp_net.trafo["lv_bus"].values, pp_to_ls))
+                                pp_bus_to_ls(pp_net.trafo["lv_bus"].values, pp_to_ls),
+                                do_ignore_tap_side_for_phase_shift)
 
     for tr_id, is_connected in enumerate(pp_net.trafo["in_service"].values):
         if not is_connected:

lightsim2grid/gridmodel/from_pypowsybl/_from_pypowsybl.py

@@ -361,15 +361,16 @@ def init(net : pypo.network.Network,
     ratio_tap_changer = net_pu.get_ratio_tap_changers()
 
     if 'alpha' in df_trafo_pu:
-        shift_ = -np.rad2deg(df_trafo_pu['alpha'].values)  # given in radian by pypowsybl
+        shift_ = np.rad2deg(df_trafo_pu['alpha'].values)  # given in radian by pypowsybl
     else:
         if net.get_phase_tap_changers().shape[0] > 0:
             raise RuntimeError("Phase tap changer are not handled by the pypowsybl converter "
                                "when not accessible using the 'alpha' columns "
                                "of the net (once per unit). Please upgrade pypowsybl."
                                "NB: phase tap change are handled by lightsim2grid)")
         shift_ = np.zeros(df_trafo.shape[0])
-    is_tap_hv_side = np.zeros(df_trafo.shape[0], dtype=bool)  # TODO    
+    # tap is side 2 in IIDM
+    is_tap_side1 = np.zeros(df_trafo.shape[0], dtype=bool)   
     trafo_r = df_trafo_pu["r"].values
     trafo_x = df_trafo_pu["x"].values
     trafo_h = (df_trafo_pu["g"].values + 1j * df_trafo_pu["b"].values)
@@ -398,9 +399,11 @@ def init(net : pypo.network.Network,
                      trafo_h,
                      ratio,
                      shift_,  # in degree !
-                     is_tap_hv_side,
+                     is_tap_side1,
                      tor_bus,
-                     tex_bus)    
+                     tex_bus,
+                     False,  # ignore_tap_side_for_phase_shift is False for pypowsybl
+                     )    
     for t_id, (is_or_disc, is_ex_disc) in enumerate(zip(tor_disco, tex_disco)):
         if is_or_disc or is_ex_disc:
             model.deactivate_trafo(t_id)

lightsim2grid/tests/old_pickle/save_data.py

@@ -0,0 +1,30 @@
+import os
+import pickle
+import warnings
+import grid2op
+from lightsim2grid import LightSimBackend
+
+
+def main():    
+    with warnings.catch_warnings():
+        warnings.filterwarnings("ignore")
+        env = grid2op.make("l2rpn_idf_2023", test=True, backend=LightSimBackend())    
+    gridmodel = env.backend._grid
+    
+    with open(os.path.join("test_pickle.pickle"), "wb") as f:
+        pickle.dump(gridmodel, f)
+        
+    for fun_name in [
+        "get_loads",
+        "get_lines",
+        "get_trafos",
+        "get_storages",
+        "get_generators",
+        "get_shunts",
+        "get_substations",
+        ]:
+        with open(os.path.join(f"test_pickle_{fun_name}.pickle"), "wb") as f:
+                pickle.dump(getattr(gridmodel, fun_name)(), f)
+                
+if __name__ == "__main__":
+    main()