LightSim2Grid 0.7.6.dev0__tar.gz → 0.8.1__tar.gz

{LightSim2Grid-0.7.6.dev0 → LightSim2Grid-0.8.1/LightSim2Grid.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: LightSim2Grid
-Version: 0.7.6.dev0
+Version: 0.8.1
 Summary: LightSim2Grid implements a c++ backend targeting the Grid2Op platform.
 Home-page: https://github.com/BDonnot/lightsim2grid/
 Author: Benjamin Donnot
@@ -278,7 +278,7 @@ For example: `export PATH_NICSLU=/home/user/Documents/cktso`
 
 #### Enable 03 optimization
 By default, at least on ubuntu, only the "-O2" compiler flags is used. To use the O3 optimization flag, you need
-to specify the `__COMPLILE_O3` environment variable: `set __COMPLILE_O3=1` before the compilation (so before
+to specify the `__O3_OPTIM` environment variable: `set __O3_OPTIM=1` before the compilation (so before
 `python3 setup.py build` or `python -m pip install -e .`)
 
 This compilation argument will increase the compilation time, but will make the package faster.
@@ -324,9 +324,10 @@ cd ..
 
 Some tests are performed automatically on standard platform each time modifications are made in the lightsim2grid code.
 
-These tests include, for now, compilation on gcc (version 8, 10, 11 and 12) and clang (version 11, 13 and 14).
+These tests include, for now, compilation on gcc (version 8, 12 and 13) and clang (version 11, 16 and 17).
 
-**NB** Intermediate versions of clang and gcc (*eg* gcc 9 or clang 12) are not tested regularly, but lightsim2grid used to work on these. We suppose that if it works on *eg* clang 10 and clang 14 then it compiles also on all intermediate versions.
+**NB** Intermediate versions of clang and gcc (*eg* gcc 9 or clang 12) are not tested regularly, but lightsim2grid used to work on these. 
+We suppose that if it works on *eg* clang 10 and clang 14 then it compiles also on all intermediate versions.
 
 **NB** Package might work (we never tested it) on earlier version of these compilers. 
 The only "real" requirement for lightsim2grid is to have a compiler supporting c++11

{LightSim2Grid-0.7.6.dev0 → LightSim2Grid-0.8.1}/LightSim2Grid.egg-info/SOURCES.txt

@@ -477,11 +477,13 @@ eigen/lapack/zlarfb.f
 eigen/lapack/zlarfg.f
 eigen/lapack/zlarft.f
 lightsim2grid/__init__.py
+lightsim2grid/contingencyAnalysis.py
 lightsim2grid/lightSimBackend.py
 lightsim2grid/physical_law_checker.py
 lightsim2grid/securityAnalysis.py
 lightsim2grid/timeSerie.py
 lightsim2grid/_utils/__init__.py
+lightsim2grid/compilation_options/__init__.py
 lightsim2grid/elements/__init__.py
 lightsim2grid/gridmodel/__init__.py
 lightsim2grid/gridmodel/_aux_add_dc_line.py
@@ -499,65 +501,68 @@ lightsim2grid/gridmodel/from_pypowsybl.py
 lightsim2grid/gridmodel/initGridModel.py
 lightsim2grid/newtonpf/__init__.py
 lightsim2grid/newtonpf/newtonpf.py
+lightsim2grid/rewards/__init__.py
+lightsim2grid/rewards/n1ContingencyReward.py
 lightsim2grid/solver/__init__.py
 src/BaseConstants.cpp
 src/BaseConstants.h
-src/BaseFDPFSolver.h
-src/BaseFDPFSolver.tpp
-src/BaseMultiplePowerflow.cpp
-src/BaseMultiplePowerflow.h
-src/BaseNRSolver.h
-src/BaseNRSolver.tpp
-src/BaseNRSolverSingleSlack.h
-src/BaseNRSolverSingleSlack.tpp
-src/BaseSolver.cpp
-src/BaseSolver.h
-src/CKTSOSolver.cpp
-src/CKTSOSolver.h
 src/ChooseSolver.cpp
 src/ChooseSolver.h
-src/Computers.cpp
-src/Computers.h
 src/CustTimer.h
-src/DCSolver.h
-src/DCSolver.tpp
 src/DataConverter.cpp
 src/DataConverter.h
-src/DataDCLine.cpp
-src/DataDCLine.h
-src/DataGen.cpp
-src/DataGen.h
-src/DataGeneric.cpp
-src/DataGeneric.h
-src/DataLine.cpp
-src/DataLine.h
-src/DataLoad.cpp
-src/DataLoad.h
-src/DataSGen.cpp
-src/DataSGen.h
-src/DataShunt.cpp
-src/DataShunt.h
-src/DataTrafo.cpp
-src/DataTrafo.h
-src/GaussSeidelSolver.cpp
-src/GaussSeidelSolver.h
-src/GaussSeidelSynchSolver.cpp
-src/GaussSeidelSynchSolver.h
 src/GridModel.cpp
 src/GridModel.h
 src/IIDMConverter.cpp
 src/IIDMConverter.h
-src/KLUSolver.cpp
-src/KLUSolver.h
-src/NICSLUSolver.cpp
-src/NICSLUSolver.h
-src/SecurityAnalysis.cpp
-src/SecurityAnalysis.h
 src/Solvers.cpp
 src/Solvers.h
-src/SparseLUSolver.cpp
-src/SparseLUSolver.h
+src/Utils.cpp
 src/Utils.h
 src/help_fun_msg.cpp
 src/help_fun_msg.h
-src/main.cpp
+src/main.cpp
+src/batch_algorithm/BaseBatchSolverSynch.cpp
+src/batch_algorithm/BaseBatchSolverSynch.h
+src/batch_algorithm/ContingencyAnalysis.cpp
+src/batch_algorithm/ContingencyAnalysis.h
+src/batch_algorithm/TimeSeries.cpp
+src/batch_algorithm/TimeSeries.h
+src/element_container/DCLineContainer.cpp
+src/element_container/DCLineContainer.h
+src/element_container/GeneratorContainer.cpp
+src/element_container/GeneratorContainer.h
+src/element_container/GenericContainer.cpp
+src/element_container/GenericContainer.h
+src/element_container/LineContainer.cpp
+src/element_container/LineContainer.h
+src/element_container/LoadContainer.cpp
+src/element_container/LoadContainer.h
+src/element_container/SGenContainer.cpp
+src/element_container/SGenContainer.h
+src/element_container/ShuntContainer.cpp
+src/element_container/ShuntContainer.h
+src/element_container/TrafoContainer.cpp
+src/element_container/TrafoContainer.h
+src/linear_solvers/CKTSOSolver.cpp
+src/linear_solvers/CKTSOSolver.h
+src/linear_solvers/KLUSolver.cpp
+src/linear_solvers/KLUSolver.h
+src/linear_solvers/NICSLUSolver.cpp
+src/linear_solvers/NICSLUSolver.h
+src/linear_solvers/SparseLUSolver.cpp
+src/linear_solvers/SparseLUSolver.h
+src/powerflow_algorithm/BaseAlgo.cpp
+src/powerflow_algorithm/BaseAlgo.h
+src/powerflow_algorithm/BaseDCAlgo.h
+src/powerflow_algorithm/BaseDCAlgo.tpp
+src/powerflow_algorithm/BaseFDPFAlgo.h
+src/powerflow_algorithm/BaseFDPFAlgo.tpp
+src/powerflow_algorithm/BaseNRAlgo.h
+src/powerflow_algorithm/BaseNRAlgo.tpp
+src/powerflow_algorithm/BaseNRSingleSlackAlgo.h
+src/powerflow_algorithm/BaseNRSingleSlackAlgo.tpp
+src/powerflow_algorithm/GaussSeidelAlgo.cpp
+src/powerflow_algorithm/GaussSeidelAlgo.h
+src/powerflow_algorithm/GaussSeidelSynchAlgo.cpp
+src/powerflow_algorithm/GaussSeidelSynchAlgo.h

{LightSim2Grid-0.7.6.dev0/LightSim2Grid.egg-info → LightSim2Grid-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: LightSim2Grid
-Version: 0.7.6.dev0
+Version: 0.8.1
 Summary: LightSim2Grid implements a c++ backend targeting the Grid2Op platform.
 Home-page: https://github.com/BDonnot/lightsim2grid/
 Author: Benjamin Donnot
@@ -278,7 +278,7 @@ For example: `export PATH_NICSLU=/home/user/Documents/cktso`
 
 #### Enable 03 optimization
 By default, at least on ubuntu, only the "-O2" compiler flags is used. To use the O3 optimization flag, you need
-to specify the `__COMPLILE_O3` environment variable: `set __COMPLILE_O3=1` before the compilation (so before
+to specify the `__O3_OPTIM` environment variable: `set __O3_OPTIM=1` before the compilation (so before
 `python3 setup.py build` or `python -m pip install -e .`)
 
 This compilation argument will increase the compilation time, but will make the package faster.
@@ -324,9 +324,10 @@ cd ..
 
 Some tests are performed automatically on standard platform each time modifications are made in the lightsim2grid code.
 
-These tests include, for now, compilation on gcc (version 8, 10, 11 and 12) and clang (version 11, 13 and 14).
+These tests include, for now, compilation on gcc (version 8, 12 and 13) and clang (version 11, 16 and 17).
 
-**NB** Intermediate versions of clang and gcc (*eg* gcc 9 or clang 12) are not tested regularly, but lightsim2grid used to work on these. We suppose that if it works on *eg* clang 10 and clang 14 then it compiles also on all intermediate versions.
+**NB** Intermediate versions of clang and gcc (*eg* gcc 9 or clang 12) are not tested regularly, but lightsim2grid used to work on these. 
+We suppose that if it works on *eg* clang 10 and clang 14 then it compiles also on all intermediate versions.
 
 **NB** Package might work (we never tested it) on earlier version of these compilers. 
 The only "real" requirement for lightsim2grid is to have a compiler supporting c++11

{LightSim2Grid-0.7.6.dev0 → LightSim2Grid-0.8.1}/README.md

@@ -222,7 +222,7 @@ For example: `export PATH_NICSLU=/home/user/Documents/cktso`
 
 #### Enable 03 optimization
 By default, at least on ubuntu, only the "-O2" compiler flags is used. To use the O3 optimization flag, you need
-to specify the `__COMPLILE_O3` environment variable: `set __COMPLILE_O3=1` before the compilation (so before
+to specify the `__O3_OPTIM` environment variable: `set __O3_OPTIM=1` before the compilation (so before
 `python3 setup.py build` or `python -m pip install -e .`)
 
 This compilation argument will increase the compilation time, but will make the package faster.
@@ -268,9 +268,10 @@ cd ..
 
 Some tests are performed automatically on standard platform each time modifications are made in the lightsim2grid code.
 
-These tests include, for now, compilation on gcc (version 8, 10, 11 and 12) and clang (version 11, 13 and 14).
+These tests include, for now, compilation on gcc (version 8, 12 and 13) and clang (version 11, 16 and 17).
 
-**NB** Intermediate versions of clang and gcc (*eg* gcc 9 or clang 12) are not tested regularly, but lightsim2grid used to work on these. We suppose that if it works on *eg* clang 10 and clang 14 then it compiles also on all intermediate versions.
+**NB** Intermediate versions of clang and gcc (*eg* gcc 9 or clang 12) are not tested regularly, but lightsim2grid used to work on these. 
+We suppose that if it works on *eg* clang 10 and clang 14 then it compiles also on all intermediate versions.
 
 **NB** Package might work (we never tested it) on earlier version of these compilers. 
 The only "real" requirement for lightsim2grid is to have a compiler supporting c++11

{LightSim2Grid-0.7.6.dev0 → LightSim2Grid-0.8.1}/lightsim2grid/__init__.py

@@ -1,13 +1,13 @@
-# 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,
 # 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.
-__version__ = "0.7.6.dev0"
+__version__ = "0.8.1"
 
-__all__ = ["newtonpf", "SolverType", "ErrorType", "solver"]
+__all__ = ["newtonpf", "SolverType", "ErrorType", "solver", "compilation_options"]
 
 # import directly from c++ module
 from lightsim2grid.solver import SolverType
@@ -39,10 +39,18 @@ except ImportError as exc_:
     print(f"TimeSerie import error: {exc_}")
 
 try:
-    from lightsim2grid.securityAnalysis import SecurityAnalysis
-    __all__.append("SecurityAnalysis")
-    __all__.append("securityAnalysis")
+    from lightsim2grid.contingencyAnalysis import ContingencyAnalysis
+    __all__.append("contingencyAnalysis")
+    __all__.append("ContingencyAnalysis")
 except ImportError as exc_:
     # grid2op is not installed, the SecurtiyAnalysis module will not be available
     pass
-    print(f"SecurityAnalysis import error: {exc_}")
+    print(f"ContingencyAnalysis import error: {exc_}")
+    
+try:
+    from lightsim2grid.rewards import *
+    __all__.append("rewards")
+except ImportError as exc_:
+    # grid2op is not installed, the SecurtiyAnalysis module will not be available
+    pass
+    print(f"rewards import error: {exc_}")

LightSim2Grid-0.8.1/lightsim2grid/compilation_options/__init__.py

@@ -0,0 +1,37 @@
+# Copyright (c) 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,
+# 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__ = ["klu_solver_available",
+           "nicslu_solver_available",
+           "cktso_solver_available",
+           "compiled_march_native",
+           "compiled_o3_optim",
+           "version",
+           "lightsim2grid_lib"]
+
+from lightsim2grid_cpp import klu_solver_available
+from lightsim2grid_cpp import nicslu_solver_available
+from lightsim2grid_cpp import cktso_solver_available
+from lightsim2grid_cpp import compiled_march_native
+from lightsim2grid_cpp import compiled_o3_optim
+from lightsim2grid_cpp import version
+from lightsim2grid_cpp import __file__ as lightsim2grid_lib
+
+try:
+    from lightsim2grid_cpp import nicslu_lib
+    __all__.append("nicslu_lib")
+except ImportError :
+    # NICSLU linear solver is not available
+    pass
+
+try:
+    from lightsim2grid_cpp import cktso_lib
+    __all__.append("cktso_lib")
+except ImportError :
+    # CKTSO linear solver is not available
+    pass

LightSim2Grid-0.7.6.dev0/lightsim2grid/securityAnalysis.py → LightSim2Grid-0.8.1/lightsim2grid/contingencyAnalysis.py

@@ -6,20 +6,25 @@
 # SPDX-License-Identifier: MPL-2.0
 # This file is part of LightSim2grid, LightSim2grid implements a c++ backend targeting the Grid2Op platform.
 
-__all__ = ["SecurityAnalysisCPP", "SecurityAnalysis"]
+__all__ = ["ContingencyAnalysisCPP"]
 
-import os
-import warnings
 import copy
 import numpy as np
 from collections.abc import Iterable
 
-from lightsim2grid.lightSimBackend import LightSimBackend
 from lightsim2grid.solver import SolverType
-from lightsim2grid_cpp import SecurityAnalysisCPP
+from lightsim2grid_cpp import ContingencyAnalysisCPP
 
+try:
+    from lightsim2grid.lightSimBackend import LightSimBackend
+    __all__.append("ContingencyAnalysis")
+    GRID2OP_INSTALLED = True
+except ImportError as exc_:
+    # grid2op is not installed
+    GRID2OP_INSTALLED = False
 
-class SecurityAnalysis(object):
+
+class __ContingencyAnalysis(object):
     """
     This class allows to perform a "security analysis" from a given grid state.
 
@@ -75,10 +80,26 @@ class SecurityAnalysis(object):
     STR_TYPES = (str, np.str_)  # np.str deprecated in numpy 1.20 and earlier versions not supported anyway
         
     def __init__(self, grid2op_env):
-        if not isinstance(grid2op_env.backend, LightSimBackend):
-            raise RuntimeError("This class only works with LightSimBackend")
-        self.grid2op_env = grid2op_env.copy()
-        self.computer = SecurityAnalysisCPP(self.grid2op_env.backend._grid)
+        if not GRID2OP_INSTALLED:
+            raise RuntimeError("Impossible to use the python wrapper `ContingencyAnalysis` "
+                               "when grid2op is not installed. Please fall back to the "
+                               "c++ version (available in python) with:\n"
+                               "\tfrom lightsim2grid.contingencyAnalysis import ContingencyAnalysisCPP\n"
+                               "and refer to the appropriate documentation.")
+        from grid2op.Environment import Environment
+        if isinstance(grid2op_env, Environment):    
+            if not isinstance(grid2op_env.backend, LightSimBackend):
+                raise RuntimeError("This class only works with LightSimBackend")
+            self._ls_backend = grid2op_env.backend.copy()
+        elif isinstance(grid2op_env, LightSimBackend):
+            if hasattr(grid2op_env, "_is_loaded") and not grid2op_env._is_loaded:
+                raise RuntimeError("Impossible to init a `ContingencyAnalysis` "
+                                   "with a backend that has not been initialized.")
+            self._ls_backend = grid2op_env.copy()
+        else:
+            raise RuntimeError("`ContingencyAnalysis` can only be created "
+                               "with a grid2op `Environment` or a `LightSimBackend`")
+        self.computer = ContingencyAnalysisCPP(self._ls_backend._grid)
         self._contingency_order = {}  # key: contingency (as tuple), value: order in which it is entered
         self._all_contingencies = []
         self.__computed = False
@@ -99,16 +120,29 @@ class SecurityAnalysis(object):
         raise RuntimeError("Impossible to add new topologies like this. Please use `add_single_contingency` "
                            "or `add_multiple_contingencies`.")
 
-    def clear(self):
+    # TODO implement that !
+    def __update_grid(self, backend_act):
+        self.clear(with_contlist=False)
+        self._ls_backend.apply_action(backend_act)
+        # run the powerflow
+        self._ls_backend.runpf()
+        # update the computer
+        # self.computer = ContingencyAnalysisCPP(self._ls_backend._grid)
+        # self.computer.update_grid(...)  # not implemented
+        
+    def clear(self, with_contlist=True):
         """
         Clear the list of contingencies to simulate
         """
-        self.computer.clear()
-        self._contingency_order = {}
         self.__computed = False
         self._vs = None
         self._ampss = None
-        self._all_contingencies = []
+        if with_contlist:
+            self.computer.clear()
+            self._contingency_order = {}
+            self._all_contingencies = []
+        else:
+            self.computer.clear_results_only()
 
     def _single_cont_to_li_int(self, single_cont):
         li_disc = []
@@ -117,7 +151,7 @@ class SecurityAnalysis(object):
 
         for stuff in single_cont:
             if isinstance(stuff, type(self).STR_TYPES):
-                stuff = np.where(self.grid2op_env.name_line == stuff)
+                stuff = np.where(type(self._ls_backend).name_line == stuff)
                 stuff = stuff[0]
                 if stuff.size == 0:
                     # name is not found
@@ -232,7 +266,7 @@ class SecurityAnalysis(object):
             for single_cont_id in range(env.n_line):
                 self.add_single_contingency(single_cont_id)
         """
-        for single_cont_id in range(self.grid2op_env.n_line):
+        for single_cont_id in range(type(self._ls_backend).n_line):
             self.add_single_contingency(single_cont_id)
 
     def get_flows(self, *args):
@@ -301,10 +335,10 @@ class SecurityAnalysis(object):
             been entered. Please use `get_flows()` method for easier reading back of the results
 
         """
-        v_init = self.grid2op_env.backend.V
+        v_init = 1. * self._ls_backend.V
         self.computer.compute(v_init,
-                              self.grid2op_env.backend.max_it,
-                              self.grid2op_env.backend.tol)
+                              self._ls_backend.max_it,
+                              self._ls_backend.tol)
         self._vs = self.computer.get_voltages()
         self.__computed = True
         return self._vs
@@ -341,6 +375,10 @@ class SecurityAnalysis(object):
 
     def close(self):
         """permanently close the object"""
-        self.grid2op_env.close()
+        self._ls_backend.close()
         self.clear()
         self.computer.close()
+        
+        
+if GRID2OP_INSTALLED:
+    ContingencyAnalysis = __ContingencyAnalysis

{LightSim2Grid-0.7.6.dev0 → LightSim2Grid-0.8.1}/lightsim2grid/gridmodel/_aux_add_slack.py

@@ -103,8 +103,8 @@ def _aux_add_slack(model, pp_net, pp_to_ls):
             gen_p = np.concatenate((pp_net.gen["p_mw"].values, slack_contrib))
             gen_v = np.concatenate((pp_net.gen["vm_pu"].values, vm_pu))
             gen_bus = np.concatenate((pp_bus_to_ls(pp_net.gen["bus"].values, pp_to_ls), slack_bus_ids))
-            gen_min_q = np.concatenate((pp_net.gen["min_q_mvar"].values, [-999999.]))
-            gen_max_q = np.concatenate((pp_net.gen["max_q_mvar"].values, [+99999.]))
+            gen_min_q = np.concatenate((pp_net.gen["min_q_mvar"].values, [-999999. for _ in range(nb_slack)]))
+            gen_max_q = np.concatenate((pp_net.gen["max_q_mvar"].values, [+99999. for _ in range(nb_slack)]))
             model.init_generators(gen_p, gen_v, gen_min_q, gen_max_q, gen_bus)
 
     # handle the possible distributed slack bus