LightSim2Grid 0.7.3__tar.gz → 0.7.4.post1__tar.gz

{LightSim2Grid-0.7.3 → LightSim2Grid-0.7.4.post1/LightSim2Grid.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: LightSim2Grid
-Version: 0.7.3
+Version: 0.7.4.post1
 Summary: LightSim2Grid implements a c++ backend targeting the Grid2Op platform.
 Home-page: https://github.com/BDonnot/lightsim2grid/
 Author: Benjamin Donnot
@@ -23,13 +23,33 @@ Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Science/Research
 Classifier: Natural Language :: English
 Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE.md
+License-File: AUTHORS.txt
+Requires-Dist: pandapower>=2.8
+Requires-Dist: pytest
 Provides-Extra: docs
+Requires-Dist: numpydoc>=0.9.2; extra == "docs"
+Requires-Dist: sphinx<7,>=2.4.4; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=0.4.3; extra == "docs"
+Requires-Dist: sphinxcontrib-trio>=1.1.0; extra == "docs"
+Requires-Dist: autodocsumm>=0.1.13; extra == "docs"
+Requires-Dist: grid2op>=1.6.4; extra == "docs"
+Requires-Dist: recommonmark; extra == "docs"
 Provides-Extra: benchmark
+Requires-Dist: tabulate; extra == "benchmark"
+Requires-Dist: grid2op>=1.6.4; extra == "benchmark"
+Requires-Dist: numpy>=1.20; extra == "benchmark"
+Requires-Dist: distro; extra == "benchmark"
+Requires-Dist: py-cpuinfo; extra == "benchmark"
 Provides-Extra: recommended
+Requires-Dist: grid2op>=1.6.4; extra == "recommended"
+Requires-Dist: numba; extra == "recommended"
 Provides-Extra: test
-License-File: LICENSE
-License-File: LICENSE.md
-License-File: AUTHORS.txt
+Requires-Dist: grid2op>=1.6.4; extra == "test"
+Requires-Dist: numba; extra == "test"
+Requires-Dist: pandapower>=2.8.0; extra == "test"
+Requires-Dist: packaging; extra == "test"
 
 # LightSim2Grid
 Provide a fast backend for grid2op using c++ KLU and Eigen librairies. Its primary goal is to serve as a fast
@@ -118,6 +138,10 @@ Pypi packages are available for linux, windows and macos with python versions:
 - 3.8
 - 3.9
 - 3.10 (lightsim2grid >= 0.6.1)
+- 3.11 (lightsim2grid >= 0.7.1)
+
+**NB** on some version of MacOs (thanks Apple !), especially the one using M1 or M2 chip, lightsim2grid is only available
+on pypi starting from version 0.7.3
 
 ## Installation (from source, for more advanced user)
 
@@ -342,5 +366,3 @@ On the clang compiler (default one on MacOS computer) it is sometime require to
 to 2.6.2 to install the package.
 
 You can downgrade pybind11 with: `python -m pip install -U pybind11==2.6.2`
-
-

{LightSim2Grid-0.7.3 → LightSim2Grid-0.7.4.post1}/LightSim2Grid.egg-info/SOURCES.txt

@@ -15,6 +15,7 @@ lightsim2grid/lightSimBackend.py
 lightsim2grid/physical_law_checker.py
 lightsim2grid/securityAnalysis.py
 lightsim2grid/timeSerie.py
+lightsim2grid/_utils/__init__.py
 lightsim2grid/elements/__init__.py
 lightsim2grid/gridmodel/__init__.py
 lightsim2grid/gridmodel/_aux_add_dc_line.py

{LightSim2Grid-0.7.3 → LightSim2Grid-0.7.4.post1}/LightSim2Grid.egg-info/requires.txt

@@ -1,4 +1,4 @@
-pandapower
+pandapower>=2.8
 pytest
 
 [benchmark]
@@ -10,7 +10,7 @@ py-cpuinfo
 
 [docs]
 numpydoc>=0.9.2
-sphinx>=2.4.4
+sphinx<7,>=2.4.4
 sphinx-rtd-theme>=0.4.3
 sphinxcontrib-trio>=1.1.0
 autodocsumm>=0.1.13

{LightSim2Grid-0.7.3/LightSim2Grid.egg-info → LightSim2Grid-0.7.4.post1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: LightSim2Grid
-Version: 0.7.3
+Version: 0.7.4.post1
 Summary: LightSim2Grid implements a c++ backend targeting the Grid2Op platform.
 Home-page: https://github.com/BDonnot/lightsim2grid/
 Author: Benjamin Donnot
@@ -23,13 +23,33 @@ Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Science/Research
 Classifier: Natural Language :: English
 Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE.md
+License-File: AUTHORS.txt
+Requires-Dist: pandapower>=2.8
+Requires-Dist: pytest
 Provides-Extra: docs
+Requires-Dist: numpydoc>=0.9.2; extra == "docs"
+Requires-Dist: sphinx<7,>=2.4.4; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=0.4.3; extra == "docs"
+Requires-Dist: sphinxcontrib-trio>=1.1.0; extra == "docs"
+Requires-Dist: autodocsumm>=0.1.13; extra == "docs"
+Requires-Dist: grid2op>=1.6.4; extra == "docs"
+Requires-Dist: recommonmark; extra == "docs"
 Provides-Extra: benchmark
+Requires-Dist: tabulate; extra == "benchmark"
+Requires-Dist: grid2op>=1.6.4; extra == "benchmark"
+Requires-Dist: numpy>=1.20; extra == "benchmark"
+Requires-Dist: distro; extra == "benchmark"
+Requires-Dist: py-cpuinfo; extra == "benchmark"
 Provides-Extra: recommended
+Requires-Dist: grid2op>=1.6.4; extra == "recommended"
+Requires-Dist: numba; extra == "recommended"
 Provides-Extra: test
-License-File: LICENSE
-License-File: LICENSE.md
-License-File: AUTHORS.txt
+Requires-Dist: grid2op>=1.6.4; extra == "test"
+Requires-Dist: numba; extra == "test"
+Requires-Dist: pandapower>=2.8.0; extra == "test"
+Requires-Dist: packaging; extra == "test"
 
 # LightSim2Grid
 Provide a fast backend for grid2op using c++ KLU and Eigen librairies. Its primary goal is to serve as a fast
@@ -118,6 +138,10 @@ Pypi packages are available for linux, windows and macos with python versions:
 - 3.8
 - 3.9
 - 3.10 (lightsim2grid >= 0.6.1)
+- 3.11 (lightsim2grid >= 0.7.1)
+
+**NB** on some version of MacOs (thanks Apple !), especially the one using M1 or M2 chip, lightsim2grid is only available
+on pypi starting from version 0.7.3
 
 ## Installation (from source, for more advanced user)
 
@@ -342,5 +366,3 @@ On the clang compiler (default one on MacOS computer) it is sometime require to
 to 2.6.2 to install the package.
 
 You can downgrade pybind11 with: `python -m pip install -U pybind11==2.6.2`
-
-

{LightSim2Grid-0.7.3 → LightSim2Grid-0.7.4.post1}/README.md

@@ -85,6 +85,10 @@ Pypi packages are available for linux, windows and macos with python versions:
 - 3.8
 - 3.9
 - 3.10 (lightsim2grid >= 0.6.1)
+- 3.11 (lightsim2grid >= 0.7.1)
+
+**NB** on some version of MacOs (thanks Apple !), especially the one using M1 or M2 chip, lightsim2grid is only available
+on pypi starting from version 0.7.3
 
 ## Installation (from source, for more advanced user)
 

{LightSim2Grid-0.7.3 → LightSim2Grid-0.7.4.post1}/lightsim2grid/__init__.py

@@ -9,7 +9,7 @@
 import faulthandler
 faulthandler.enable()
 
-__version__ = "0.7.3"
+__version__ = "0.7.4.post1"
 
 __all__ = ["newtonpf", "SolverType", "ErrorType", "solver"]
 

LightSim2Grid-0.7.4.post1/lightsim2grid/_utils/__init__.py

@@ -0,0 +1,11 @@
+# this class is defined to avoid circular references when using grid2op -> pandapower -> lightsim2grid -> grid2op
+# this module is lazily imported by the LightSimBackend and should not be used anywhere else, 
+# as the name states
+try:
+    from grid2op.Backend import PandaPowerBackend
+    class _DoNotUseAnywherePandaPowerBackend(PandaPowerBackend):
+        """used to duplicate the class attributes of PandaPowerBackend"""
+        pass
+except ImportError as exc_:
+    # grid2op is not installed, we do not use it.
+    pass

{LightSim2Grid-0.7.3 → LightSim2Grid-0.7.4.post1}/lightsim2grid/lightSimBackend.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2020, RTE (https://www.rte-france.com)
+# Copyright (c) 2020-2024, 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,
@@ -40,31 +40,40 @@ class LightSimBackend(Backend):
                  dist_slack_non_renew: bool=False,  # distribute the slack on non renewable turned on (and with P>0) generators
                  use_static_gen: bool=False, # add the static generators as generator gri2dop side
                  ):
-        try:
-            # for grid2Op >= 1.7.1
-            Backend.__init__(self,
-                             detailed_infos_for_cascading_failures=detailed_infos_for_cascading_failures,
-                             can_be_copied=can_be_copied,
-                             solver_type=solver_type,
-                             max_iter=max_iter,
-                             tol=tol,
-                             turned_off_pv=turned_off_pv,
-                             dist_slack_non_renew=dist_slack_non_renew,
-                             use_static_gen=use_static_gen)
-        except TypeError as exc_:
-            warnings.warn("Please use grid2op >= 1.7.1: with older grid2op versions, "
-                          "you cannot set max_iter, tol nor solver_type arguments.")
-            Backend.__init__(self,
-                             detailed_infos_for_cascading_failures=detailed_infos_for_cascading_failures)
+        self.max_it = max_iter
+        self.tol = tol  # tolerance for the solver
+        self._check_suitable_solver_type(solver_type, check_in_avail_solver=False)
+        self.__current_solver_type = solver_type
+
+        # does the "turned off" generators (including when p=0)
+        # are pv buses
+        self._turned_off_pv = turned_off_pv
+
+        # distributed slack, on non renewable gen with P > 0
+        self._dist_slack_non_renew = dist_slack_non_renew
+
+        # add the static gen to the list of controlable gen in grid2Op
+        self._use_static_gen = use_static_gen  # TODO implement it
+
+        self._aux_init_super(detailed_infos_for_cascading_failures,
+                             can_be_copied,
+                             solver_type,
+                             max_iter,
+                             tol,
+                             turned_off_pv,
+                             dist_slack_non_renew,
+                             use_static_gen)
 
         # lazy loading because it crashes...
-        from grid2op.Backend import PandaPowerBackend
+        from lightsim2grid._utils import _DoNotUseAnywherePandaPowerBackend
         from grid2op.Space import GridObjects  # lazy import
         self.__has_storage = hasattr(GridObjects, "n_storage")
         if not self.__has_storage:
             warnings.warn("Please upgrade your grid2Op to >= 1.5.0. You are using a backward compatibility "
                           "feature that will be removed in further lightsim2grid version.")
 
+        self.shunts_data_available = True  # needs to be self and not type(self) here
+
         self.nb_bus_total = None
         self.initdc = True  # does not really hurt computation time
         self.__nb_powerline = None
@@ -84,17 +93,14 @@ class LightSimBackend(Backend):
 
         self.topo_vect = None
         self.shunt_topo_vect = None
-
         try:
-            self.init_pp_backend = PandaPowerBackend(with_numba=False)
+            self.init_pp_backend = _DoNotUseAnywherePandaPowerBackend(with_numba=False)
         except TypeError as exc_:
             # oldest version of grid2op do not support the kwargs "with_numba"
             # (before 1.9.1)
-            self.init_pp_backend = PandaPowerBackend()
+            self.init_pp_backend = _DoNotUseAnywherePandaPowerBackend()
         
         self.V = None
-        self.max_it = max_iter
-        self.tol = tol  # tolerance for the solver
 
         self.prod_pu_to_kv = None
         self.load_pu_to_kv = None
@@ -146,12 +152,20 @@ class LightSimBackend(Backend):
 
         # available solver in lightsim
         self.available_solvers = []
-        self.comp_time = 0.  # computation time of just the powerflow
+
+        # computation time of just the powerflow (when the grid is formatted
+        # by the gridmodel already)
+        # it takes only into account the time spend in the powerflow algorithm
+        self.comp_time = 0.
+
+        # computation time of the powerflow
+        # it takes into account everything in the gridmodel, including the mapping
+        # to the solver, building of Ybus and Sbus AND the time to solve the powerflow
+        self.timer_gridmodel_xx_pf = 0.
+
         self._timer_postproc = 0.
         self._timer_preproc = 0.
         self._timer_solver = 0.
-        self._check_suitable_solver_type(solver_type, check_in_avail_solver=False)
-        self.__current_solver_type = solver_type
 
         # hack for the storage unit:
         # in grid2op, for simplicity, I suppose that if a storage is alone on a busbar, and
@@ -163,17 +177,34 @@ class LightSimBackend(Backend):
         # TODO and should rather be handled in pandapower backend
         # backend SHOULD not do these kind of stuff
         self._idx_hack_storage = []
-        
-        # does the "turned off" generators (including when p=0)
-        # are pv buses
-        self._turned_off_pv = turned_off_pv
-        
-        # distributed slack, on non renewable gen with P > 0
-        self._dist_slack_non_renew = dist_slack_non_renew
-        
-        # add the static gen to the list of controlable gen in grid2Op
-        self._use_static_gen = use_static_gen  # TODO implement it
-        
+
+    def _aux_init_super(self,
+                        detailed_infos_for_cascading_failures,
+                        can_be_copied,
+                        solver_type,
+                        max_iter,
+                        tol,
+                        turned_off_pv,
+                        dist_slack_non_renew,
+                        use_static_gen):
+        try:
+            # for grid2Op >= 1.7.1
+            Backend.__init__(self,
+                             detailed_infos_for_cascading_failures=detailed_infos_for_cascading_failures,
+                             can_be_copied=can_be_copied,
+                             solver_type=solver_type,
+                             max_iter=max_iter,
+                             tol=tol,
+                             turned_off_pv=turned_off_pv,
+                             dist_slack_non_renew=dist_slack_non_renew,
+                             use_static_gen=use_static_gen
+                             )
+        except TypeError as exc_:
+            warnings.warn("Please use grid2op >= 1.7.1: with older grid2op versions, "
+                          "you cannot set max_iter, tol nor solver_type arguments.")
+            Backend.__init__(self,
+                             detailed_infos_for_cascading_failures=detailed_infos_for_cascading_failures)
+
     def turnedoff_no_pv(self):
         self._turned_off_pv = False
         self._grid.turnedoff_no_pv()
@@ -439,7 +470,7 @@ class LightSimBackend(Backend):
             self.storage_loss = self.init_pp_backend.storage_loss
             self.storage_discharging_efficiency = self.init_pp_backend.storage_discharging_efficiency
             self.storage_charging_efficiency = self.init_pp_backend.storage_charging_efficiency
-
+        
         self.nb_bus_total = self.init_pp_backend._grid.bus.shape[0]
 
         self.thermal_limit_a = copy.deepcopy(self.init_pp_backend.thermal_limit_a)
@@ -477,7 +508,7 @@ class LightSimBackend(Backend):
                                              tmp.reshape(-1, 1)), axis=-1)
 
         self._big_topo_to_obj = [(None, None) for _ in range(self.dim_topo)]
-
+        
         self._compute_pos_big_topo()
 
         # set up the "lightsim grid" accordingly
@@ -591,8 +622,8 @@ class LightSimBackend(Backend):
         """
         # test the results gives the proper size
         super().assert_grid_correct_after_powerflow()
-        self.init_pp_backend.__class__ = self.init_pp_backend.init_grid(self)
-        self._backend_action_class = _BackendAction.init_grid(self)
+        self.init_pp_backend.__class__ = type(self.init_pp_backend).init_grid(type(self))
+        self._backend_action_class = _BackendAction.init_grid(type(self))
         self._init_action_to_set = self._backend_action_class()
         try:
             # feature added in grid2op 1.4 or 1.5
@@ -894,25 +925,37 @@ class LightSimBackend(Backend):
         ####################
         # res = copy.deepcopy(self)  # super slow
         res = type(self).__new__(type(self))
+        # make sure to init the "base class"
+        # in particular with "new" attributes in future grid2op Backend
+        res._aux_init_super(self.detailed_infos_for_cascading_failures,
+                            self._can_be_copied,
+                            self.__current_solver_type,
+                            self.max_it,
+                            self.tol,
+                            self._turned_off_pv,
+                            self._dist_slack_non_renew,
+                            self._use_static_gen)
+        res.comp_time = self.comp_time
+        res.timer_gridmodel_xx_pf = self.timer_gridmodel_xx_pf
 
         # copy the regular attribute
         res.__has_storage = self.__has_storage
-        res.__current_solver_type = self.__current_solver_type
+        res.__current_solver_type = self.__current_solver_type  # forced here because of special `__`
         res.__nb_powerline = self.__nb_powerline
         res.__nb_bus_before = self.__nb_bus_before
-        res._can_be_copied = self._can_be_copied
         res.cst_1 = dt_float(1.0)
-        li_regular_attr = ["detailed_infos_for_cascading_failures", "comp_time", "can_output_theta", "_is_loaded",
+        li_regular_attr = ["comp_time", "can_output_theta", "_is_loaded",
                            "nb_bus_total", "initdc",
-                           "_big_topo_to_obj", "max_it", "tol", "dim_topo",
+                           "_big_topo_to_obj", "dim_topo",
                            "_idx_hack_storage",
                            "_timer_preproc", "_timer_postproc", "_timer_solver",
-                           "_my_kwargs",
-                           "_turned_off_pv", "_dist_slack_non_renew"
+                           "supported_grid_format",
+                           "max_it", "tol", "_turned_off_pv", "_dist_slack_non_renew",
+                           "_use_static_gen"
                            ]
         for attr_nm in li_regular_attr:
             if hasattr(self, attr_nm):
-                # this test is needed for backward compatibility with other grid2op version
+                # this test is needed for backward compatibility with older grid2op version
                 setattr(res, attr_nm, copy.deepcopy(getattr(self, attr_nm)))
 
         # copy the numpy array
@@ -955,7 +998,7 @@ class LightSimBackend(Backend):
                     ] + type(self)._li_attr_disp
 
         for attr_nm in cls_attr:
-            if hasattr(self, attr_nm):
+            if hasattr(self, attr_nm) and not hasattr(type(self), attr_nm):
                 # this test is needed for backward compatibility with other grid2op version
                 setattr(res, attr_nm, copy.deepcopy(getattr(self, attr_nm)))
         ###############

{LightSim2Grid-0.7.3 → LightSim2Grid-0.7.4.post1}/setup.py

@@ -14,7 +14,7 @@ import warnings
 from pybind11.setup_helpers import Pybind11Extension, build_ext
 
 
-__version__ = "0.7.3"
+__version__ = "0.7.4.post1"
 KLU_SOLVER_AVAILABLE = False
 
 # Try to link against SuiteSparse (if available)
@@ -327,7 +327,7 @@ pkgs = {
     "extras": {
         "docs": [
             "numpydoc>=0.9.2",
-            "sphinx>=2.4.4",
+            "sphinx>=2.4.4,<7",
             "sphinx-rtd-theme>=0.4.3",
             "sphinxcontrib-trio>=1.1.0",
             "autodocsumm>=0.1.13",