LightSim2Grid 0.10.0__tar.gz → 0.10.1__tar.gz

{lightsim2grid-0.10.0 → lightsim2grid-0.10.1/LightSim2Grid.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: LightSim2Grid
-Version: 0.10.0
+Version: 0.10.1
 Summary: LightSim2Grid implements a c++ backend targeting the Grid2Op platform.
 Home-page: https://github.com/grid2op/lightsim2grid/
 Author: Benjamin Donnot
@@ -32,6 +32,7 @@ Requires-Dist: pip
 Requires-Dist: pybind11
 Requires-Dist: scipy
 Requires-Dist: numpy
+Requires-Dist: packaging
 Provides-Extra: docs
 Requires-Dist: numpydoc>=0.9.2; extra == "docs"
 Requires-Dist: sphinx<7,>=2.4.4; extra == "docs"
@@ -54,8 +55,19 @@ Provides-Extra: test
 Requires-Dist: grid2op>=1.6.4; extra == "test"
 Requires-Dist: numba; extra == "test"
 Requires-Dist: pandapower>=2.14.0; extra == "test"
-Requires-Dist: packaging; extra == "test"
 Requires-Dist: pypowsybl; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: platform
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 # LightSim2Grid
 Provide a fast backend for grid2op using c++ KLU and Eigen librairies. Its primary goal is to serve as a fast

{lightsim2grid-0.10.0 → lightsim2grid-0.10.1}/LightSim2Grid.egg-info/SOURCES.txt

@@ -503,7 +503,11 @@ lightsim2grid/gridmodel/from_pandapower/initGridModel.py
 lightsim2grid/gridmodel/from_pypowsybl/__init__.py
 lightsim2grid/gridmodel/from_pypowsybl/_from_pypowsybl.py
 lightsim2grid/newtonpf/__init__.py
-lightsim2grid/newtonpf/newtonpf.py
+lightsim2grid/pandapower_compat/__init__.py
+lightsim2grid/pandapower_compat/dcpf/__init__.py
+lightsim2grid/pandapower_compat/dcpf/_dcpf.py
+lightsim2grid/pandapower_compat/newtonpf/__init__.py
+lightsim2grid/pandapower_compat/newtonpf/_newtonpf.py
 lightsim2grid/rewards/__init__.py
 lightsim2grid/rewards/n1ContingencyReward.py
 lightsim2grid/solver/__init__.py

{lightsim2grid-0.10.0/LightSim2Grid.egg-info → lightsim2grid-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: LightSim2Grid
-Version: 0.10.0
+Version: 0.10.1
 Summary: LightSim2Grid implements a c++ backend targeting the Grid2Op platform.
 Home-page: https://github.com/grid2op/lightsim2grid/
 Author: Benjamin Donnot
@@ -32,6 +32,7 @@ Requires-Dist: pip
 Requires-Dist: pybind11
 Requires-Dist: scipy
 Requires-Dist: numpy
+Requires-Dist: packaging
 Provides-Extra: docs
 Requires-Dist: numpydoc>=0.9.2; extra == "docs"
 Requires-Dist: sphinx<7,>=2.4.4; extra == "docs"
@@ -54,8 +55,19 @@ Provides-Extra: test
 Requires-Dist: grid2op>=1.6.4; extra == "test"
 Requires-Dist: numba; extra == "test"
 Requires-Dist: pandapower>=2.14.0; extra == "test"
-Requires-Dist: packaging; extra == "test"
 Requires-Dist: pypowsybl; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: platform
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 # LightSim2Grid
 Provide a fast backend for grid2op using c++ KLU and Eigen librairies. Its primary goal is to serve as a fast

{lightsim2grid-0.10.0 → lightsim2grid-0.10.1}/lightsim2grid/__init__.py

@@ -6,7 +6,7 @@
 # SPDX-License-Identifier: MPL-2.0
 # This file is part of LightSim2grid, LightSim2grid implements a c++ backend targeting the Grid2Op platform.
 
-__version__ = "0.10.0"
+__version__ = "0.10.1"
 
 __all__ = ["newtonpf", "SolverType", "ErrorType", "solver", "compilation_options"]
 

{lightsim2grid-0.10.0 → lightsim2grid-0.10.1}/lightsim2grid/gridmodel/from_pandapower/_aux_add_trafo.py

@@ -61,9 +61,18 @@ def _aux_add_trafo(converter, model, pp_net, pp_to_ls):
         warnings.warn("There were some Nan in the pp_net.trafo[\"tap_side\"], they have been replaced by \"hv\"")
     is_tap_hv_side[~np.isfinite(is_tap_hv_side)] = True
 
-    if np.any(pp_net.trafo["tap_phase_shifter"].values):
-        raise RuntimeError("ideal phase shifter are not modeled. Please remove all trafo with "
-                           "pp_net.trafo[\"tap_phase_shifter\"] set to True.")
+    if "tap_phase_shifter" in pp_net.trafo:
+        if np.any(pp_net.trafo["tap_phase_shifter"].values):
+            raise RuntimeError("Ideal phase shifters are not modeled. Please remove all trafos with "
+                               "pp_net.trafo[\"tap_phase_shifter\"] set to True.")
+    elif "tap_changer_type" in pp_net.trafo:
+        if np.any(pp_net.trafo["tap_changer_type"].values == "Ideal"):
+            raise RuntimeError("Ideal phase shifters are not modeled. Please remove all 2-winding trafos "
+                               "with \"tap_changer_type\" set to \"Ideal\".")
+    elif "tap_changer_type" in pp_net.trafo3w:
+        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_)):

lightsim2grid-0.10.1/lightsim2grid/newtonpf/__init__.py

@@ -0,0 +1,11 @@
+# Copyright (c) 2020-2025, RTE (https://www.rte-france.com)
+# See AUTHORS.txt
+# This Source Code Form is subject to the terms of the Mozilla Public License, version 2.0.
+# If a copy of the Mozilla Public License, version 2.0 was not distributed with this file,
+# you can obtain one at http://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+# This file is part of LightSim2grid, LightSim2grid implements a c++ backend targeting the Grid2Op platform.
+
+__all__ = ["newtonpf", "newtonpf_new", "newtonpf_old"]
+
+from lightsim2grid.pandapower_compat import newtonpf, newtonpf_new, newtonpf_old

lightsim2grid-0.10.1/lightsim2grid/pandapower_compat/__init__.py

@@ -0,0 +1,12 @@
+# Copyright (c) 2025, RTE (https://www.rte-france.com)
+# See AUTHORS.txt
+# This Source Code Form is subject to the terms of the Mozilla Public License, version 2.0.
+# If a copy of the Mozilla Public License, version 2.0 was not distributed with this file,
+# you can obtain one at http://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+# This file is part of LightSim2grid, LightSim2grid implements a c++ backend targeting the Grid2Op platform.
+
+__all__ = ["newtonpf", "newtonpf_new", "newtonpf_old", "dcpf"]
+
+from lightsim2grid.pandapower_compat.newtonpf import newtonpf, newtonpf_new, newtonpf_old
+from lightsim2grid.pandapower_compat.dcpf import dcpf

lightsim2grid-0.10.1/lightsim2grid/pandapower_compat/dcpf/__init__.py

@@ -0,0 +1,11 @@
+# Copyright (c) 2025, RTE (https://www.rte-france.com)
+# See AUTHORS.txt
+# This Source Code Form is subject to the terms of the Mozilla Public License, version 2.0.
+# If a copy of the Mozilla Public License, version 2.0 was not distributed with this file,
+# you can obtain one at http://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+# This file is part of LightSim2grid, LightSim2grid implements a c++ backend targeting the Grid2Op platform.
+
+__all__ = ["dcpf"]
+
+from lightsim2grid.pandapower_compat.dcpf._dcpf import dcpf

lightsim2grid-0.10.1/lightsim2grid/pandapower_compat/dcpf/_dcpf.py

@@ -0,0 +1,65 @@
+# Copyright (c) 2020, RTE (https://www.rte-france.com)
+# See AUTHORS.txt
+# This Source Code Form is subject to the terms of the Mozilla Public License, version 2.0.
+# If a copy of the Mozilla Public License, version 2.0 was not distributed with this file,
+# you can obtain one at http://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+# This file is part of LightSim2grid, LightSim2grid implements a c++ backend targeting the Grid2Op platform.
+
+import numpy as np
+from scipy import sparse
+
+from lightsim2grid.solver import DCSolver
+
+try:
+    from lightsim2grid.solver import KLUDCSolver
+    KLU_solver_available = True
+except ImportError:
+    KLU_solver_available = False
+
+
+def _isolate_slack_ids(Sbus, pv, pq):
+    # extract the slack bus
+    ref = set(np.arange(Sbus.shape[0])) - set(pv) - set(pq)
+    ref = np.array(list(ref))
+    # build the slack weights
+    slack_weights = np.zeros(Sbus.shape[0])
+    slack_weights[ref] = 1.0 / ref.shape[0]
+    return ref, slack_weights
+
+
+def _get_valid_solver(options, Bbus):
+    # initialize the solver
+    # TODO have that in options maybe (can use GaussSeidel, and NR with KLU -faster- or SparseLU)
+    solver = KLUDCSolver() if KLU_solver_available else DCSolver()
+
+    if not sparse.isspmatrix_csc(Bbus):
+        Bbus = sparse.csc_matrix(Bbus)
+
+    if not Bbus.has_canonical_format:
+        Bbus.sum_duplicates()
+        if not Bbus.has_canonical_format:
+            raise RuntimeError("Your matrix should be in a canonical format. See "
+                            "https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.csc_matrix.has_canonical_format.html"
+                            " for more information.")
+    
+    return solver
+
+
+def dcpf(B, Pbus, Va0, ref, pv, pq):
+    """
+    Implementation (using lightsim2grid) of the `dcpf` function of pandapower
+    that allows to perform DC powerflow.
+    
+    It is meant to be used from inside pandapower and not directly.
+    """
+    # initialize the solver and perform some sanity checks
+    solver = _get_valid_solver(None, B)
+    
+    # do the newton raphson algorithm
+    slack_weights = np.ones(len(ref), dtype=float)
+    slack_weights /= slack_weights.sum()
+    solver.solve(B, np.cos(Va0) + 1j * np.sin(Va0), Pbus, ref, slack_weights, pv, pq, 1, 1e-8)
+    # extract the results
+    Va = solver.get_Va()
+    return Va

{lightsim2grid-0.10.0/lightsim2grid → lightsim2grid-0.10.1/lightsim2grid/pandapower_compat}/newtonpf/__init__.py

@@ -8,4 +8,4 @@
 
 __all__ = ["newtonpf", "newtonpf_new", "newtonpf_old"]
 
-from lightsim2grid.newtonpf.newtonpf import newtonpf, newtonpf_new, newtonpf_old
+from lightsim2grid.pandapower_compat.newtonpf._newtonpf import newtonpf, newtonpf_new, newtonpf_old

lightsim2grid-0.10.0/lightsim2grid/newtonpf/newtonpf.py → lightsim2grid-0.10.1/lightsim2grid/pandapower_compat/newtonpf/_newtonpf.py

@@ -7,18 +7,24 @@
 # This file is part of LightSim2grid, LightSim2grid implements a c++ backend targeting the Grid2Op platform.
 
 import warnings
+from packaging import version
+try:
+    from importlib.metadata import version as version_metadata
+except ImportError:
+    # for compat with python 3.7 ...
+    version_metadata = None
 import numpy as np
 from scipy import sparse
 
-from lightsim2grid_cpp import SparseLUSolver, SparseLUSolverSingleSlack
+from lightsim2grid.solver import SparseLUSolver, SparseLUSolverSingleSlack
 
 try:
-    from lightsim2grid_cpp import KLUSolver, KLUSolverSingleSlack
+    from lightsim2grid.solver import KLUSolver, KLUSolverSingleSlack
     KLU_solver_available = True
 except ImportError:
     KLU_solver_available = False
 
-_PP_VERSION_MAX = "2.7.0"
+_PP_VERSION_MAX = version.parse("2.7.0")
 
 
 def _isolate_slack_ids(Sbus, pv, pq):
@@ -43,10 +49,11 @@ def _get_valid_solver(options, Ybus):
         Ybus = sparse.csc_matrix(Ybus)
 
     if not Ybus.has_canonical_format:
-        raise RuntimeError("Your matrix should be in a canonical format. See "
-                           "https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.csc_matrix.has_canonical_format.html"
-                           " for more information.")
-    
+        Ybus.sum_duplicates()
+        if not Ybus.has_canonical_format:
+            raise RuntimeError("Your matrix should be in a canonical format. See "
+                            "https://docs.scipy.org/doc/scipy/reference/generated/scipy.sparse.csc_matrix.has_canonical_format.html"
+                            " for more information.")
     return solver
 
 
@@ -73,17 +80,23 @@ def newtonpf(*args, **kwargs):
 
     .. code-block::
 
-        from lightsim2grid.newtonpf import newtonpf
+        from lightsim2grid.pandapower_compat import newtonpf
 
-        # when pandapower version <= 2.7.0
+        # with pandapower version <= 2.7.0
         V, converged, iterations, J, Vm_it, Va_it = newtonpf(Ybus, Sbus, V0, pv, pq, ppci, options)
 
-        # when pandapower version > 2.7.0
+        # with pandapower version > 2.7.0
         V, converged, iterations, J, Vm_it, Va_it = newtonpf(Ybus, Sbus, V0, ref, pv, pq, ppci, options)
 
     """
-    import pandapower as pp
-    if pp.__version__ <= _PP_VERSION_MAX:
+    if version_metadata is not None:
+        pp_ver = version_metadata("pandapower")
+    else:
+        # for compat with python 3.7
+        import pandapower as pp
+        pp_ver = pp.__version__
+        
+    if version.parse(pp_ver) <= _PP_VERSION_MAX:
         try:
             # should be the old version
             return newtonpf_old(*args, **kwargs)

{lightsim2grid-0.10.0 → lightsim2grid-0.10.1}/setup.py

@@ -14,7 +14,7 @@ import warnings
 from pybind11.setup_helpers import Pybind11Extension, build_ext
 
 
-__version__ = "0.10.0"
+__version__ = "0.10.1"
 KLU_SOLVER_AVAILABLE = False
 
 # Try to link against SuiteSparse (if available)
@@ -322,7 +322,8 @@ req_pkgs = [
     "pip",
     "pybind11",
     "scipy",
-    "numpy"
+    "numpy",
+    "packaging", 
         # "pandapower" if sys.version_info < (3, 10) else "pandapower>=2.8",
         # "pytest",  # for pandapower see https://github.com/e2nIEE/pandapower/issues/1988
     ]
@@ -363,7 +364,6 @@ pkgs = {
             "grid2op>=1.6.4",
             "numba",
             "pandapower>=2.14.0",  # interface changed for pandapower, not backward compatible
-            "packaging", 
             "pypowsybl"
         ]
     }

{lightsim2grid-0.10.0 → lightsim2grid-0.10.1}/LightSim2Grid.egg-info/requires.txt

@@ -3,6 +3,7 @@ pip
 pybind11
 scipy
 numpy
+packaging
 
 [benchmark]
 tabulate
@@ -29,5 +30,4 @@ numba
 grid2op>=1.6.4
 numba
 pandapower>=2.14.0
-packaging
 pypowsybl