LightSim2Grid 0.8.0__tar.gz → 0.8.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: LightSim2Grid
-Version: 0.8.0
+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.

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

@@ -483,6 +483,7 @@ 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
@@ -500,6 +501,8 @@ 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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: LightSim2Grid
-Version: 0.8.0
+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.

{LightSim2Grid-0.8.0 → 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.

{LightSim2Grid-0.8.0 → 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.8.0"
+__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
@@ -46,3 +46,11 @@ except ImportError as exc_:
     # grid2op is not installed, the SecurtiyAnalysis module will not be available
     pass
     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.8.0 → LightSim2Grid-0.8.1}/lightsim2grid/contingencyAnalysis.py

@@ -6,21 +6,25 @@
 # SPDX-License-Identifier: MPL-2.0
 # This file is part of LightSim2grid, LightSim2grid implements a c++ backend targeting the Grid2Op platform.
 
-__all__ = ["ContingencyAnalysisCPP", "ContingencyAnalysis",
-           # deprecated
-           "SecurityAnalysisCPP", "SecurityAnalysis",
-           ]
+__all__ = ["ContingencyAnalysisCPP"]
 
 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 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 ContingencyAnalysis(object):
+
+class __ContingencyAnalysis(object):
     """
     This class allows to perform a "security analysis" from a given grid state.
 
@@ -76,10 +80,26 @@ class ContingencyAnalysis(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 = ContingencyAnalysisCPP(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
@@ -100,16 +120,29 @@ class ContingencyAnalysis(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 = []
@@ -118,7 +151,7 @@ class ContingencyAnalysis(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
@@ -233,7 +266,7 @@ class ContingencyAnalysis(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):
@@ -302,10 +335,10 @@ class ContingencyAnalysis(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
@@ -342,6 +375,10 @@ class ContingencyAnalysis(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.8.0 → LightSim2Grid-0.8.1}/lightsim2grid/gridmodel/from_pypowsybl.py

@@ -78,8 +78,8 @@ def init(net : pypo.network,
     # to handle encoding in 32 bits and overflow when "splitting" the Q values among 
     min_q = df_gen["min_q"].values.astype(np.float32)
     max_q = df_gen["max_q"].values.astype(np.float32)
-    min_q[~np.isfinite(min_q)] = np.finfo(np.float32).min * 0.5 + 1.
-    max_q[~np.isfinite(max_q)] = np.finfo(np.float32).max * 0.5 - 1.
+    min_q[~np.isfinite(min_q)] = np.finfo(np.float32).min * 1e-4 + 1.
+    max_q[~np.isfinite(max_q)] = np.finfo(np.float32).max * 1e-4 - 1.
     gen_bus, gen_disco = _aux_get_bus(bus_df, df_gen)
     model.init_generators_full(df_gen["target_p"].values,
                                df_gen["target_v"].values / voltage_levels.loc[df_gen["voltage_level_id"].values]["nominal_v"].values,

{LightSim2Grid-0.8.0 → LightSim2Grid-0.8.1}/lightsim2grid/gridmodel/initGridModel.py

@@ -15,6 +15,9 @@ __all__ = ["init", "GridModel"]
 import numpy as np
 from numbers import Number
 import warnings
+
+import pandapower
+import lightsim2grid
 from lightsim2grid_cpp import GridModel, PandaPowerConverter
 from lightsim2grid.gridmodel._aux_add_sgen import _aux_add_sgen
 from lightsim2grid.gridmodel._aux_add_load import _aux_add_load
@@ -28,7 +31,7 @@ from lightsim2grid.gridmodel._aux_add_storage import _aux_add_storage
 from lightsim2grid.gridmodel._aux_add_dc_line import _aux_add_dc_line
 
 
-def init(pp_net):
+def init(pp_net: "pandapower.auxiliary.pandapowerNet") -> GridModel:
     """
     Convert a pandapower network as input into a GridModel.
 
@@ -53,7 +56,7 @@ def init(pp_net):
 
     Parameters
     ----------
-    pp_net: :class:`pandapower.grid`
+    pp_net: :class:`pandapower.auxiliary.pandapowerNet`
         The initial pandapower network you want to convert
 
     Returns