Merge pull request #694 from BDonnot/bd_dev

Bd dev

Author: BDonnot

CHANGELOG.rst

@@ -25,6 +25,7 @@ General grid2op improvments:
 - Code and test the "load from disk" method
 - add a "plot action" method
 - does not read every data of the backend if not used
+- backend converter: now test it properly with pandapower / lightsim2grid and pypowsybl2grid
 
 Better multi processing support: 
 
@@ -96,6 +97,8 @@ Native multi agents support:
 
 - cf ad-hoc branch (dev-multiagents)
 - properly model interconnecting powerlines
+- add detachment
+- add change_bus / set_bus
 
 [1.11.0] - 202x-yy-zz
 -----------------------
@@ -112,6 +115,15 @@ Native multi agents support:
 - [BREAKING] the way actions is serialized has been changed with respect to the `from_vect` /
   `to_vect` method. This might introduce some issues when loading previously saved actions
   with this methods.
+- [BREAKING] first kwargs of `backend.apply_action` method is now spelled `backend_action` 
+  (instead of backendAction)
+- [BREAKING] (not yet) rationalization of the backend public / private API part. The 
+  environment (and simulator, forecast env etc.) will always call the method `_public` 
+  for example `load_grid_public`, `reset_public`, `copy_public` and `apply_action_public`. 
+  These function of the base `Backend` should NOT be overriden, and will internally call 
+  the functions `load_grid`, `reset`, `copy` and `apply_action` which were part of the public
+  API. These last member functions will be renamed (in a later version) `_load_grid`,
+  `_reset`, `_copy` and `_apply_action` to reflect this change. NOT for this version however !
 - [FIXED] issue https://github.com/Grid2op/grid2op/issues/657
 - [FIXED] missing an import on the `MaskedEnvironment` class
 - [FIXED] a bug when trying to set the load_p, load_q, gen_p, gen_v by names.
@@ -143,6 +155,7 @@ Native multi agents support:
 - [FIXED] a powerflow is run when the environment is first created even before the initial "env.step"
   function is called. This is to ensure proper behaviour if env is used without being reset.
 - [FIXED] no error was catched if the backend could not properly apply the action sent by the environment.
+- [FIXED] an issue in the AAA tests: when backend does not support storages, some tests were skipped not correctly
 - [ADDED] possibility to set the "thermal limits" when calling `env.reset(..., options={"thermal limit": xxx})`
 - [ADDED] possibility to retrieve some structural information about elements with
   with `gridobj.get_line_info(...)`, `gridobj.get_load_info(...)`, `gridobj.get_gen_info(...)` 
@@ -187,7 +200,8 @@ Native multi agents support:
   that allows not to recompute it over and over again (this is internal API please do not change 
   it... unless you know what you are doing)
 - [IMPROVED] `ForecastEnv` is now part of the public API.
-    
+- [IMPROVED] no need to call `self._compute_pos_big_top()` at the end of the implementation of `backend.load_grid()`
+
 [1.10.5] - 2025-03-07
 ------------------------
 - [FIXED] force pandapower < 3 otherwise pandapower backend does not work and 

docs/conf.py

@@ -22,7 +22,7 @@
 author = 'Benjamin Donnot'
 
 # The full version, including alpha/beta/rc tags
-release = '1.11.0.dev4'
+release = '1.11.0.dev5'
 version = '1.11'
 
 

grid2op/Action/_backendAction.py

@@ -522,6 +522,12 @@ def __init__(self):
         self._lines_or_bus = None
         self._lines_ex_bus = None
         self._storage_bus = None
+        
+        #: .. versionadded: 1.11.0
+        self._is_cached = False
+        self._injections_cached = None
+        self._topo_cached = None
+        self._shunts_cached = None
 
     def __deepcopy__(self, memodict={}) -> Self:
 
@@ -818,7 +824,8 @@ def __iadd__(self, other : BaseAction) -> Self:
         The updated state of `self` after the new action `other` has been added to it.
         
         """
-
+        self._is_cached = False  # TODO speed here: if no modification does not invalidate the cache
+        
         set_status = 1 * other._set_line_status
         switch_status = other._switch_line_status
         set_topo_vect = 1 * other._set_topo_vect
@@ -944,20 +951,24 @@ def apply_action(self, backendAction: Union["grid2op.Action._backendAction._Back
           position in the `topo_vect` vector)
         
         """
+        if self._is_cached:
+            return self.activated_bus, self._injections_cached, self._topo_cached, self._shunts_cached
+        
         self._assign_0_to_disco_el()
-        injections = (
+        self._injections_cached = (
             self.prod_p,
             self.prod_v,
             self.load_p,
             self.load_q,
             self.storage_power,
         )
-        topo = self.current_topo
-        shunts = None
+        self._topo_cached = self.current_topo
+        self._shunts_cached = None
         if type(self).shunts_data_available:
-            shunts = self.shunt_p, self.shunt_q, self.shunt_bus
+            self._shunts_cached = self.shunt_p, self.shunt_q, self.shunt_bus
         self._get_active_bus()
-        return self.activated_bus, injections, topo, shunts
+        self._is_cached = True
+        return self.activated_bus, self._injections_cached, self._topo_cached, self._shunts_cached
 
     def get_loads_bus(self) -> ValueStore:
         """

grid2op/Action/actionSpace.py

@@ -21,7 +21,7 @@ class ActionSpace(SerializableActionSpace):
     :class:`ActionSpace` should be created by an :class:`grid2op.Environment.Environment`
     with its parameters coming from a properly
     set up :class:`grid2op.Backend.Backend` (ie a Backend instance with a loaded powergrid.
-    See :func:`grid2op.Backend.Backend.load_grid` for
+    See :func:`grid2op.Backend.Backend.load_grid_public` for
     more information).
 
     It will allow, thanks to its :func:`ActionSpace.__call__` method to create valid :class:`BaseAction`. It is the