clean a bit commented code, ready for version 0.12.1

Signed-off-by: DONNOT Benjamin <benjamin.donnot@rte-france.com>

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.1]  2026-xx-yy
+[0.12.1]  2026-01-09
 ---------------------
 - [FIXED] phase shift transformers are now properly modeled
   for both pandapower (new in this version) and pypowsybl (already

benchmarks/test_profile.py

@@ -24,7 +24,7 @@
 prng = np.random.default_rng(42)
 
 CASE_NAME = "case9241pegase.json"
-NB_TS = 10
+NB_TS = 1000
 
 
 def my_grid2op_env(case_name, nb_ts, prng):
@@ -88,9 +88,13 @@ def main_gridmodel(case_name=CASE_NAME, nb_ts=NB_TS, reset_algo=True, solver_use
     ls_timer_Va_Vm = 0.
     ls_timer_pre_proc = 0.
     ls_timer_total_nr = 0.
-    
-    with open(f"gridmodel_{case_name}.pickle", "rb") as f:
-        ls_grid = pickle.load(f)
+    try:
+        with open(f"gridmodel_{case_name}.pickle", "rb") as f:
+            ls_grid = pickle.load(f)
+    except FileNotFoundError:
+        raise RuntimeError("You need to comment 'main_gridmodel(...)` in test_profile.py then uncomment `my_grid2op_env(...)`, "
+                           "run it (without perf it's fine). Then uncomment `main_gridmodel` and comment `my_grid2op_env` "
+                           "and run the benchkmark (with perf) again.")
     ls_grid.change_solver(solver_used)
     v_init = ls_grid.dc_pf(np.ones(ls_grid.get_bus_vn_kv().shape[0], dtype=complex) * 1.04, 1, 0.1)
     for _ in range(nb_ts):

docs/conf.py

@@ -22,7 +22,7 @@
 author = 'Benjamin DONNOT'
 
 # The full version, including alpha/beta/rc tags
-release = "0.12.1.dev0"
+release = "0.12.1"
 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.12.1.dev0"
+__version__ = "0.12.1"
 
 __all__ = [
     "newtonpf",

setup.py

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

src/GridModel.cpp

@@ -218,7 +218,7 @@ void GridModel::set_orig_to_ls(const IntVect & orig_to_ls){
     }
 }
 
-void GridModel::set_ls_to_orig_internal(const IntVect & ls_to_orig){
+void GridModel::set_ls_to_orig_internal(const IntVect & ls_to_orig) noexcept{
     if(ls_to_orig.size() == 0){
         _ls_to_orig = IntVect();
         _orig_to_ls = IntVect();

src/GridModel.hpp

@@ -41,7 +41,7 @@
 #include "ChooseSolver.hpp"
 
 //TODO implement a BFS check to make sure the Ymatrix is "connected" [one single component]
-class GridModel final // : public GenericContainer  // TODO remove that inheritance
+class GridModel final
 {
     public:
         typedef Eigen::Array<int, Eigen::Dynamic, Eigen::RowMajor> IntVectRowMaj;
@@ -53,7 +53,6 @@ class GridModel final // : public GenericContainer  // TODO remove that inherita
                 std::vector<int>, // ls_to_orig
                 real_type,  // init_vm_pu
                 real_type, //sn_mva
-                // std::vector<real_type>,  // bus_vn_kv
                 std::vector<bool>,  // bus_status
                 SubstationContainer::StateRes,
                 // powerlines
@@ -1190,11 +1189,6 @@ class GridModel final // : public GenericContainer  // TODO remove that inherita
         real_type get_computation_time() const{ return _solver.get_computation_time();}
         real_type get_dc_computation_time() const{ return _dc_solver.get_computation_time();}
 
-    // private:
-    //     using GenericContainer::update_bus_status;  // to silence clang warnings (overload-virtual)
-    // public:
-    //     void update_bus_status(int nb_bus_before,
-    //                            Eigen::Ref<Eigen::Array<bool, Eigen::Dynamic, 2, Eigen::RowMajor> > active_bus);
         // part dedicated to grid2op backend, optimized for grid2op data representation (for speed)
         // this is not recommended to use it outside of its intended usage within grid2op !
         void update_gens_p(Eigen::Ref<Eigen::Array<bool, Eigen::Dynamic, Eigen::RowMajor> > has_changed,
@@ -1325,21 +1319,13 @@ class GridModel final // : public GenericContainer  // TODO remove that inherita
                                     const SolverControl & solver_control);
 
         //for FDPF
-    // private:
-    //     using GenericContainer::fillBp_Bpp;  // silence clang warning overload-virtual
-    public:
         void fillBp_Bpp(Eigen::SparseMatrix<real_type> & Bp, 
                         Eigen::SparseMatrix<real_type> & Bpp, 
                         FDPFMethod xb_or_bx) const;
-
         void init_fdpf_coeffs(){
             powerlines_.init_fdpf_coeffs();
             trafos_.init_fdpf_coeffs();
         }
-
-    // private:
-    //     using GenericContainer::fillBf_for_PTDF;  // silence clang warning overload-virtual
-    public:
         void fillBf_for_PTDF(Eigen::SparseMatrix<real_type> & Bf, bool transpose=false) const;
 
         Eigen::SparseMatrix<real_type> debug_get_Bp_python(FDPFMethod xb_or_bx){
@@ -1358,13 +1344,7 @@ class GridModel final // : public GenericContainer  // TODO remove that inherita
         }
 
     protected:
-        void set_ls_to_orig_internal(const IntVect & ls_to_orig);  // set both _ls_to_orig and _orig_to_ls
-
-        // compute admittance matrix
-        // dc powerflow
-        // void init_dcY(Eigen::SparseMatrix<real_type> & dcYbus);
-
-        // ac powerflows
+        void set_ls_to_orig_internal(const IntVect & ls_to_orig) noexcept;  // set both _ls_to_orig and _orig_to_ls
 
         // init the Ybus matrix (its size, it is filled up elsewhere) and also the 
         // converter from "my bus id" to the "solver bus id" (id_me_to_solver and id_solver_to_me)
@@ -1489,9 +1469,6 @@ class GridModel final // : public GenericContainer  // TODO remove that inherita
             }
             return res;
         }
-
-    // private:
-    //     using GenericContainer::fillYbus;  // to silence the overload-virtual warning in clang
 
     protected:
         void fillYbus(Eigen::SparseMatrix<cplx_type> & res, bool ac, const std::vector<SolverBusId>& id_me_to_solver);

src/element_container/LineContainer.cpp

@@ -68,41 +68,4 @@ void LineContainer::init(const RealVect & branch_r,
     init_tsc(branch_from_id, branch_to_id, "trafo");
     _update_model_coeffs();
     reset_results();
-    // init_tsc_rxha();
 }
-
-// void LineContainer::_update_model_coeffs()
-// {
-//     const auto my_size = r_.size();
-
-//     yac_11_ = CplxVect::Zero(my_size);
-//     yac_12_ = CplxVect::Zero(my_size);
-//     yac_21_ = CplxVect::Zero(my_size);
-//     yac_22_ = CplxVect::Zero(my_size);
-
-//     ydc_11_ = CplxVect::Zero(my_size);
-//     ydc_12_ = CplxVect::Zero(my_size);
-//     ydc_21_ = CplxVect::Zero(my_size);
-//     ydc_22_ = CplxVect::Zero(my_size);
-//     for(int i = 0; i < my_size; ++i)
-//     {
-//         // for AC
-//         // see https://matpower.org/docs/MATPOWER-manual.pdf eq. 3.2
-//         const cplx_type ys = 1. / cplx_type(r_(i), x_(i));
-//         const cplx_type h_or = h_side_1_(i);
-//         const cplx_type h_ex = h_side_2_(i);
-//         yac_11_(i) = (ys + h_or);
-//         yac_22_(i) = (ys + h_ex);
-//         yac_12_(i) = -ys;
-//         yac_21_(i) = -ys;
-
-//         // for DC
-//         // see https://matpower.org/docs/MATPOWER-manual.pdf eq. 3.21
-//         // except here I only care about the real part, so I remove the "1/j"
-//         cplx_type tmp = 1. / cplx_type(x_(i), 0.);
-//         ydc_11_(i) = tmp;
-//         ydc_22_(i) = tmp;
-//         ydc_21_(i) = -tmp;
-//         ydc_12_(i) = -tmp;
-//     }
-// }

src/element_container/LineContainer.hpp

@@ -88,9 +88,6 @@ class LineContainer : public TwoSidesContainer_rxh_A<OneSideContainer_ForBranch>
 
         // for consistency with trafo, when used for example in BaseMultiplePowerflow...
         Eigen::Ref<const RealVect> dc_x_tau_shift() const {return RealVect();}
-    
-    protected:
-        // void _update_model_coeffs();
 
     protected:
         // physical properties

src/element_container/TrafoContainer.cpp

@@ -67,13 +67,9 @@ void TrafoContainer::init(
     shift_ = trafo_shift_degree / my_180_pi_;  // do not forget conversion degree / rad here !
     is_tap_side1_ = trafo_tap_side1;
     ignore_tap_side_for_shift_ = ignore_tap_side_for_shift;
-    // bus_hv_id_ = trafo_hv_id;
-    // bus_lv_id_ = trafo_lv_id;
-    // status_ = std::vector<bool>(trafo_r.size(), true);
     init_tsc(trafo_hv_id, trafo_lv_id, "trafo");
     _update_model_coeffs();
     reset_results();
-    // init_tsc_rxha();
 }
 
 TrafoContainer::StateRes TrafoContainer::get_state() const
@@ -111,26 +107,6 @@ void TrafoContainer::set_state(TrafoContainer::StateRes & my_state)
     reset_results();
 }
 
-// void TrafoContainer::_update_model_coeffs()
-// {
-//     const Eigen::Index my_size = r_.size();
-
-//     yac_11_ = CplxVect::Zero(my_size);
-//     yac_12_ = CplxVect::Zero(my_size);
-//     yac_21_ = CplxVect::Zero(my_size);
-//     yac_22_ = CplxVect::Zero(my_size);
-
-//     ydc_11_ = CplxVect::Zero(my_size);
-//     ydc_12_ = CplxVect::Zero(my_size);
-//     ydc_21_ = CplxVect::Zero(my_size);
-//     ydc_22_ = CplxVect::Zero(my_size);
-//     dc_x_tau_shift_ = RealVect::Zero(my_size);
-//     for(Eigen::Index i = 0; i < my_size; ++i)
-//     {
-//         _update_model_coeffs_one_el(i);
-//     }
-// }
-
 void TrafoContainer::_update_model_coeffs_one_el(int el_id)
 {
     // for AC
@@ -171,13 +147,6 @@ void TrafoContainer::_update_model_coeffs_one_el(int el_id)
     ydc_12_(el_id) = -tmp;
 
     dc_x_tau_shift_(el_id) = -std::real(tmp) * theta_shift;
-    // if(ignore_tap_side_for_shift_)
-    // {
-    //     dc_x_tau_shift_(el_id) = -std::real(tmp) * theta_shift;
-    // } else {
-    //     if(is_tap_side1_[el_id]) dc_x_tau_shift_(el_id) = -std::real(tmp) * theta_shift;
-    //     else dc_x_tau_shift_(el_id) = std::real(tmp) * theta_shift;
-    // }
 }
 
 void TrafoContainer::hack_Sbus_for_dc_phase_shifter(