remove comments, ready for version 0.12

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

Author: BDonnot

CHANGELOG.rst

@@ -29,7 +29,7 @@ TODO: in `main.cpp` check the returned policy of pybind11 and also the `py::call
 TODO: a cpp class that is able to compute (DC powerflow) ContingencyAnalysis and TimeSeries using PTDF and LODF
 TODO: integration test with pandapower (see `pandapower/contingency/contingency.py` and import `lightsim2grid_installed` and check it's True)
 
-[0.12.0] 2026-01-zz
+[0.12.0] 2026-01-06
 --------------------
 - [BREAKING] for better consistency, and following pypowsybl convention, trafo and lines "side"
   are now called "1" and "2" instead of "hv" / "lv" (for trafo) or "or" / "ex" for powerlines.

docs/conf.py

@@ -22,8 +22,8 @@
 author = 'Benjamin DONNOT'
 
 # The full version, including alpha/beta/rc tags
-release = "0.11.1.dev0"
-version = '0.11'
+release = "0.12.0"
+version = '0.12'
 
 # -- General configuration ---------------------------------------------------
 

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.11.1.dev0"
+__version__ = "0.12.0"
 
 __all__ = [
     "newtonpf",
@@ -22,36 +22,36 @@
 try:
     from lightsim2grid.lightSimBackend import LightSimBackend  # noqa: F401
     __all__.append("LightSimBackend")
-except ImportError as exc_:
+except ImportError as exc_:  # noqa: F841
     # grid2op is not installed, the Backend will not be available
     pass
 
 try:
     from lightsim2grid.physical_law_checker import PhysicalLawChecker  # noqa: F401
     __all__.append("PhysicalLawChecker")
-except ImportError as exc_:
+except ImportError as exc_:  # noqa: F841
     # grid2op is not installed, the PhysicalLawChecker will not be available
     pass
 
 try:
     from lightsim2grid.timeSerie import TimeSerie  # noqa: F401
     __all__.append("TimeSerie")  
     __all__.append("timeSerie")
-except ImportError as exc_:
+except ImportError as exc_:  # noqa: F841
     # grid2op is not installed, the TimeSeries module will not be available
     pass
 
 try:
     from lightsim2grid.contingencyAnalysis import ContingencyAnalysis  # noqa: F401
     __all__.append("contingencyAnalysis")
     __all__.append("ContingencyAnalysis")
-except ImportError as exc_:
+except ImportError as exc_:  # noqa: F841
     # grid2op is not installed, the SecurtiyAnalysis module will not be available
     pass
 
 try:
     from lightsim2grid.rewards import N1ContingencyReward  # noqa: F401
     __all__.append("rewards")
-except ImportError as exc_:
+except ImportError as exc_:  # noqa: F841
     # grid2op is not installed, the SecurtiyAnalysis module will not be available
     pass

lightsim2grid/rewards/n1ContingencyReward.py

@@ -31,6 +31,7 @@ class N1ContingencyReward(BaseReward):
     .. code-block:: python
 
         import grid2op
+        
         from lightsim2grid.rewards import N1ContingencyReward
         l_ids = [0, 1, 7]
         env = grid2op.make("l2rpn_case14_sandbox",
@@ -117,8 +118,6 @@ def initialize(self, env: "grid2op.Environment.Environment"):
                                "without any contingencies !")
         self.reward_min = 0.
         self.reward_max = len(self._l_ids) if not self._normalize else 1.
-        # self._contingecy_analyzer = ContingencyAnalysis(self._backend)
-        # self._contingecy_analyzer.add_multiple_contingencies(self._l_ids)
 
     def __call__(self, action, env, has_error, is_done, is_illegal, is_ambiguous):
         if is_done:
@@ -175,31 +174,6 @@ def __call__(self, action, env, has_error, is_done, is_illegal, is_ambiguous):
         now_3 = time.perf_counter()
         self._timer_post_proc += now_3 - now_2
         self._timer_call += time.perf_counter() - beg
-        # print()
-        # print("sanity check")
-        # print("a_or")
-        # print(f"obs.a_or:\n{env.get_obs().a_or}")
-        # print(f"backend updated state:\n{self._backend.lines_or_info()[3]}")
-        # print("gen_p")
-        # print(f"obs.gen_p:\n{env.get_obs().gen_p}")
-        # print(f"backend updated state:\n{self._backend.generators_info()[0]}")
-        # print("shunt_bus")
-        # print(f"obs._shunt_bus:\n{env.get_obs()._shunt_bus}")
-        # print(f"backend updated state:\n{self._backend.shunt_info()[-1]}")
-        # print(f"env backend shunt bus {env.backend._grid.get_shunts()[0].bus_id}")
-        # print(f"self backend shunt bus {self._backend._grid.get_shunts()[0].bus_id}")
-        # print("shunt_q")
-        # print(f"obs._shunt_q:\n{env.get_obs()._shunt_q}")
-        # print(f"backend updated state:\n{self._backend.shunt_info()[1]}")
-        # print("load_p")
-        # print(f"obs.load_p:\n{env.get_obs().load_p}")
-        # print(f"backend updated state:\n{self._backend.loads_info()[0]}")
-        # print("")
-        # print("reward for 0: ")
-        # print(tmp_res[0])
-        # print("reward for 3: ")
-        # print(tmp_res[3])
-        # print("")
         return res
 
     def reset(self, env: "grid2op.Environment.BaseEnv") -> None:

lightsim2grid/tests/test_n1contingencyrewards.py

@@ -135,29 +135,14 @@ def _aux_test_reward(self, obs, reward, env=None):
         for l_id in self.my_ids:
             sim_obs, sim_r, sim_d, sim_i = obs.simulate(self.env.action_space({"set_line_status": [(l_id, -1)]}),
                                                         time_step=0)
-            # if l_id == 0:
-            #     print("simulate for 0")
-            #     print(sim_obs.a_or)
-            # if l_id == 3:
-            #     print("simulate for 3")
-            #     print(sim_obs.a_or)
             if not self.is_dc():
-                # print(f"for {l_id}: {sim_d = }, {sim_i['exception']}, {(sim_obs.a_or / obs._thermal_limit).max()}")
                 if np.any(sim_obs.a_or > obs._thermal_limit * self.threshold_margin()) or sim_d:
                     unsafe_cont += 1   
                     unsafe_conts.append(l_id)    
             else:
                 if np.any(np.abs(sim_obs.p_or) > th_lim_p) or sim_d:
                     unsafe_cont += 1   
-                    unsafe_conts.append(l_id)    
-        # print(f"testN1ContReward {env._reward_helper.template_reward._debug_unsafe_conts}")
-        # print(f"testN1ContReward {unsafe_conts}")
-        
-        # array([   0.        ,  337.96604781,  122.5834584 ,    0.        ,
-        # 135.9316308 ,  106.3282711 ,  280.89072926,  539.72618504,
-        # 290.85619763,  725.03591688,  180.47842569,  127.51930555,
-        # 433.16050467,   84.59000012,  370.64622793,  113.72360852,
-        #  53.04777249,  162.52315174, 1351.44796185,  779.9985506 ])
+                    unsafe_conts.append(l_id)
 
         assert reward == (len(self.my_ids) - unsafe_cont), f"wrong number of lines {reward} vs {(len(self.my_ids) - unsafe_cont)}"
         assert (env._reward_helper.template_reward._debug_unsafe_conts == unsafe_conts).all(), "wrong line ids on overflow"

setup.py

@@ -14,7 +14,7 @@
 from pybind11.setup_helpers import Pybind11Extension, build_ext
 
 
-__version__ = "0.11.1.dev0"
+__version__ = "0.12.0"
 KLU_SOLVER_AVAILABLE = False
 
 # Try to link against SuiteSparse (if available)

src/BaseConstants.cpp

@@ -1,4 +1,4 @@
-// Copyright (c) 2020, RTE (https://www.rte-france.com)
+// Copyright (c) 2020-2026, 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,

src/BaseConstants.hpp

@@ -1,4 +1,4 @@
-// Copyright (c) 2020, RTE (https://www.rte-france.com)
+// Copyright (c) 2020-2026, 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,

src/ChooseSolver.cpp

@@ -1,4 +1,4 @@
-// Copyright (c) 2020, RTE (https://www.rte-france.com)
+// Copyright (c) 2020-2026, 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,

src/ChooseSolver.hpp

@@ -1,4 +1,4 @@
-// Copyright (c) 2020, RTE (https://www.rte-france.com)
+// Copyright (c) 2020-2026, 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,