Merge pull request #686 from BDonnot/bd_dev

BDonnot · web-flow · commit e7713f5dc3fb · 2025-02-26T13:48:34.000+01:00
Some fixes for the detachment feature
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -86,7 +86,7 @@ jobs:
           ls ./dist/*.whl
 
       - name: Upload wheel
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: grid2op-wheel-${{ matrix.config.name }}-${{ matrix.python.name }}
           path: dist/*.whl
diff --git a/docs/conf.py b/docs/conf.py
@@ -22,7 +22,7 @@
 author = 'Benjamin Donnot'
 
 # The full version, including alpha/beta/rc tags
-release = '1.11.0.dev3'
+release = '1.11.0.dev4'
 version = '1.11'
 
 
diff --git a/getting_started/grid2op b/getting_started/grid2op
diff --git a/grid2op/Action/baseAction.py b/grid2op/Action/baseAction.py
@@ -23,7 +23,7 @@
 from grid2op.typing_variables import DICT_ACT_TYPING
 from grid2op.dtypes import dt_int, dt_bool, dt_float
 from grid2op.Exceptions import *
-from grid2op.Space import GridObjects
+from grid2op.Space import GridObjects, GRID2OP_CURRENT_VERSION_STR
 
 # TODO time delay somewhere (eg action is implemented after xxx timestep, and not at the time where it's proposed)
 
@@ -2425,7 +2425,7 @@ def _digest_storage(self, dict_):
             except IllegalAction as exc_:
                 cls = type(self)
                 # only raise the error if I am not in compat mode
-                if cls.glop_version == grid2op.__version__:
+                if cls.glop_version == GRID2OP_CURRENT_VERSION_STR:
                     raise exc_
                 else:
                     # TODO be more specific on the version
@@ -2439,7 +2439,7 @@ def _digest_curtailment(self, dict_):
             except IllegalAction as exc_:
                 cls = type(self)
                 # only raise the error if I am not in compat mode
-                if cls.glop_version == grid2op.__version__:
+                if cls.glop_version == GRID2OP_CURRENT_VERSION_STR:
                     raise exc_
                 else:
                     # TODO be more specific on the version
diff --git a/grid2op/Environment/baseEnv.py b/grid2op/Environment/baseEnv.py
@@ -3170,6 +3170,7 @@ def _update_alert_properties(self, action, lines_attacked, subs_attacked):
         # self._is_alert_illegal
     
     def _aux_register_env_converged(self, disc_lines, action, init_line_status, new_p) -> Optional[Grid2OpException]:
+        cls = type(self)
         beg_res = time.perf_counter()
         # update the thermal limit, for DLR for example
         self.backend.update_thermal_limit(self)  
@@ -3224,7 +3225,6 @@ def _aux_register_env_converged(self, disc_lines, action, init_line_status, new_
             self._gen_activeprod_t[:] = tmp_gen_p
         else:
             # I need to check whether all generators meet the constraints
-            cls = type(self)
             if tmp_gen_p[cls.gen_redispatchable] > cls.gen_pmax[cls.gen_redispatchable] + self._tol_poly:
                 gen_ko = (tmp_gen_p[cls.gen_redispatchable] > cls.gen_pmax[cls.gen_redispatchable]).nonzero()[0]
                 gen_ko_nms = cls.name_gen[cls.gen_redispatchable][gen_ko]
@@ -3245,6 +3245,16 @@ def _aux_register_env_converged(self, disc_lines, action, init_line_status, new_
                 return SomeGeneratorBelowRampmin(f"Especially generators {gen_ko_nms}")
             
             self._gen_activeprod_t[:] = tmp_gen_p
+        
+        # set the status of the other elements (if the backend 
+        # disconnect them)
+        if cls.detachment_is_allowed:
+            gen_detached_user = self._backend_action.get_gen_detached()
+            topo_ = self.backend.get_topo_vect()
+            self._backend_action.current_topo.values[:] = topo_
+            self._aux_update_detachment_info()
+        else:
+            gen_detached_user = np.zeros(cls.n_gen, dtype=dt_bool)
             
         # problem with the gen_activeprod_t above, is that the slack bus absorbs alone all the losses
         # of the system. So basically, when it's too high (higher than the ramp) it can
@@ -3253,11 +3263,11 @@ def _aux_register_env_converged(self, disc_lines, action, init_line_status, new_
 
         # set the line status
         self._line_status[:] = self.backend.get_line_status()
-
+            
         # for detachment remember previous loads and generation
         self._prev_load_p[:], self._prev_load_q[:], *_ = self.backend.loads_info()
         self._delta_gen_p[:] = self._gen_activeprod_t - self._gen_activeprod_t_redisp
-        self._delta_gen_p[self._gens_detached] = 0.
+        self._delta_gen_p[gen_detached_user] = 0.  # when the backend disconnect it it should not be set to 0.
         self._prev_gen_p[:] = self._gen_activeprod_t
         
         # finally, build the observation (it's a different one at each step, we cannot reuse the same one)
@@ -3272,11 +3282,7 @@ def _backend_next_grid_state(self):
         """overlaoded in MaskedEnv"""
         return self.backend.next_grid_state(env=self, is_dc=self._env_dc)
     
-    def _aux_run_pf_after_state_properly_set(
-        self, action, init_line_status, new_p, except_
-    ):
-        has_error = True
-        detailed_info = None
+    def _aux_update_detachment_info(self):
         cls = type(self)
         if cls.detachment_is_allowed:
             self._loads_detached[:] = self._backend_action.get_load_detached()
@@ -3297,6 +3303,12 @@ def _aux_run_pf_after_state_properly_set(
             self._storage_p_detached[mask_chgt] = self._backend_action.storage_power.values[mask_chgt]
             self._storage_p_detached[~self._storages_detached] = 0.
             
+    def _aux_run_pf_after_state_properly_set(
+        self, action, init_line_status, new_p, except_
+    ):
+        has_error = True
+        detailed_info = None
+            
         try:
             # compute the next _grid state
             beg_pf = time.perf_counter()
diff --git a/grid2op/Environment/environment.py b/grid2op/Environment/environment.py
@@ -32,7 +32,7 @@
 from grid2op.Environment.baseEnv import BaseEnv
 from grid2op.Opponent import BaseOpponent, NeverAttackBudget
 from grid2op.operator_attention import LinearAttentionBudget
-from grid2op.Space import DEFAULT_N_BUSBAR_PER_SUB, DEFAULT_ALLOW_DETACHMENT
+from grid2op.Space import DEFAULT_N_BUSBAR_PER_SUB, DEFAULT_ALLOW_DETACHMENT, GRID2OP_CURRENT_VERSION_STR
 from grid2op.typing_variables import RESET_OPTIONS_TYPING, N_BUSBAR_PER_SUB_TYPING
 from grid2op.MakeEnv.PathUtils import USE_CLASS_IN_FILE
 
@@ -647,7 +647,7 @@ def _helper_action_player(self):
     def _handle_compat_glop_version(self, need_process_backend):
         if (
             self._compat_glop_version is not None
-            and self._compat_glop_version != grid2op.__version__
+            and self._compat_glop_version != GRID2OP_CURRENT_VERSION_STR
         ):
             warnings.warn(
                 'You are using a grid2op "compatibility" environment. This means that some '
diff --git a/grid2op/Episode/EpisodeData.py b/grid2op/Episode/EpisodeData.py
@@ -19,6 +19,7 @@
     IncorrectNumberOfElements,
     NonFiniteElement,
 )
+from grid2op.Space import GRID2OP_CURRENT_VERSION_STR
 from grid2op.Action import ActionSpace
 from grid2op.Observation import ObservationSpace
 
@@ -535,7 +536,7 @@ def from_disk(cls,
             helper_action_env = ActionSpace.from_dict(
                 os.path.join(agent_path, EpisodeData.ENV_MODIF_SPACE)
             )
-        if observation_space.glop_version != grid2op.__version__:
+        if observation_space.glop_version != GRID2OP_CURRENT_VERSION_STR:
             warnings.warn(
                 'You are using a "grid2op compatibility" feature (the data you saved '
                 "have been saved with a previous grid2op version). When we loaded your data, we attempted "
@@ -833,7 +834,7 @@ def to_disk(self):
                 "w",
                 encoding="utf-8",
             ) as f:
-                dict_ = {"version": f"{grid2op.__version__}"}
+                dict_ = {"version": f"{GRID2OP_CURRENT_VERSION_STR}"}
                 json.dump(obj=dict_, fp=f, indent=4, sort_keys=True)
 
     def _aux_make_obs_space_serializable(self):
diff --git a/grid2op/Observation/baseObservation.py b/grid2op/Observation/baseObservation.py
@@ -1309,7 +1309,7 @@ def process_grid2op_compat(cls) -> None:
             cls._aux_process_grid2op_compat_191()
             
         if glop_ver < cls.MIN_VERSION_DETACH:
-            # alert attributes have been added in 1.9.1
+            # detachment has been added in grid2op 1.11
             cls._aux_process_grid2op_compat_1_11_0()
             
         cls.attr_list_set = copy.deepcopy(cls.attr_list_set)
diff --git a/grid2op/Space/GridObjects.py b/grid2op/Space/GridObjects.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2019-2020, RTE (https://www.rte-france.com)
+# Copyright (c) 2019-2025, 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,
@@ -22,6 +22,8 @@
 import os
 import numpy as np
 import sys
+
+import importlib.metadata
 from packaging import version
 from typing import Dict, Type, Union, Literal, Any, List, Optional, ClassVar, Tuple
     
@@ -30,11 +32,13 @@
 from grid2op.typing_variables import CLS_AS_DICT_TYPING, N_BUSBAR_PER_SUB_TYPING
 from grid2op.Exceptions import *
 from grid2op.Space.space_utils import extract_from_dict, save_to_dict, ElTypeInfo
+from grid2op.Space.default_var import (DEFAULT_ALLOW_DETACHMENT,
+                                       DEFAULT_N_BUSBAR_PER_SUB,
+                                       GRID2OP_CLASSES_ENV_FOLDER,
+                                       GRID2OP_CURRENT_VERSION_STR,
+                                       GRID2OP_CURRENT_VERSION)
 
 # TODO tests of these methods and this class in general
-DEFAULT_N_BUSBAR_PER_SUB = 2
-DEFAULT_ALLOW_DETACHMENT = False
-GRID2OP_CLASSES_ENV_FOLDER = "_grid2op_classes"
 
 
 class GridObjects:
@@ -480,7 +484,7 @@ class GridObjects:
 
     BEFORE_COMPAT_VERSION : ClassVar[str] = "neurips_2020_compat"
     MIN_VERSION_DETACH : ClassVar[str] = version.parse("1.11.0.dev2")
-    glop_version : ClassVar[str] = grid2op.__version__
+    glop_version : ClassVar[str] = GRID2OP_CURRENT_VERSION_STR
     
     _INIT_GRID_CLS = None  # do not modify that, this is handled by grid2op automatically
     _PATH_GRID_CLASSES : ClassVar[Optional[str]] = None  # especially do not modify that
@@ -746,7 +750,7 @@ def _clear_grid_dependant_class_attributes(cls) -> None:
         cls.n_busbar_per_sub = DEFAULT_N_BUSBAR_PER_SUB
         cls.detachment_is_allowed = DEFAULT_ALLOW_DETACHMENT
         
-        cls.glop_version = grid2op.__version__
+        cls.glop_version = GRID2OP_CURRENT_VERSION_STR
 
         cls.attr_list_vect = None
         cls.attr_list_set = {}
@@ -2967,7 +2971,7 @@ def init_grid(cls, gridobj, force=False, extra_name=None, force_module=None, _lo
         """
         # nothing to do now that the value are class member            
         name_res = "{}_{}".format(cls.__name__, gridobj.env_name)
-        if gridobj.glop_version != grid2op.__version__:
+        if gridobj.glop_version != GRID2OP_CURRENT_VERSION_STR:
             name_res += f"_{gridobj.glop_version}"
         
         if gridobj._PATH_GRID_CLASSES is not None:
@@ -4409,7 +4413,7 @@ class res(GridObjects):
             
         cls.process_shunt_static_data()
         
-        if cls.glop_version != grid2op.__version__:
+        if cls.glop_version != GRID2OP_CURRENT_VERSION_STR:
             # change name of the environment, this is done in Environment.py for regular environment
             # see `self.backend.set_env_name(f"{self.name}_{self._compat_glop_version}")`
             # cls.set_env_name(f"{cls.env_name}_{cls.glop_version}")
@@ -4597,7 +4601,7 @@ def init_grid_from_dict_for_pickle(name_res, orig_cls, cls_attr):
             # if hasattr(res_cls, "n_sub") and res_cls.n_sub > 0:
             # that's a grid2op class iniailized with an environment, I need to initialize it too
             res_cls._compute_pos_big_topo_cls()
-            if res_cls.glop_version != grid2op.__version__:
+            if res_cls.glop_version != GRID2OP_CURRENT_VERSION_STR:
                 res_cls.process_grid2op_compat()
             res_cls.process_shunt_static_data()
             res_cls.process_detachment()
@@ -4981,7 +4985,7 @@ def format_el(values):
 
 class {cls.__name__}({cls._INIT_GRID_CLS.__name__}):
     BEFORE_COMPAT_VERSION = \"{cls.BEFORE_COMPAT_VERSION}\"
-    glop_version = grid2op.__version__  # tells it's the installed grid2op version
+    glop_version = \"{GRID2OP_CURRENT_VERSION_STR}\"  # tells it's the installed grid2op version
     _PATH_GRID_CLASSES = {_PATH_ENV_str}   # especially do not modify that
     _INIT_GRID_CLS = {cls._INIT_GRID_CLS.__name__} 
     _CLS_DICT = None  # init once to avoid yet another serialization of the class as dict (in make_cls_dict)
@@ -5387,7 +5391,7 @@ def _aux_check_kirchhoff(cls,
                              shunt_info : Optional[ElTypeInfo] = None,
                              ) -> Tuple[np.ndarray, np.ndarray, np.ndarray, np.ndarray, np.ndarray]:
         """
-        Analogous to "backend.check_kirchhoff" but from the observation
+        Analogous to "backend.check_kirchhoff" but can be used for both the observation and the backend
 
         .. versionadded:: 1.11.0
         
diff --git a/grid2op/Space/__init__.py b/grid2op/Space/__init__.py
@@ -4,12 +4,21 @@
            "ElTypeInfo",
            "DEFAULT_N_BUSBAR_PER_SUB",
            "GRID2OP_CLASSES_ENV_FOLDER",
-           "DEFAULT_ALLOW_DETACHMENT"]
+           "DEFAULT_ALLOW_DETACHMENT",
+           "GRID2OP_CURRENT_VERSION",
+           "GRID2OP_CURRENT_VERSION_STR"]
+
 
 from grid2op.Space.RandomObject import RandomObject
+
 from grid2op.Space.SerializableSpace import SerializableSpace
+
 from grid2op.Space.GridObjects import (GridObjects,
-                                       ElTypeInfo,
-                                       DEFAULT_N_BUSBAR_PER_SUB,
+                                       ElTypeInfo)
+
+from grid2op.Space.default_var import (DEFAULT_N_BUSBAR_PER_SUB,
                                        GRID2OP_CLASSES_ENV_FOLDER,
-                                       DEFAULT_ALLOW_DETACHMENT)
+                                       DEFAULT_ALLOW_DETACHMENT,
+                                       GRID2OP_CURRENT_VERSION,
+                                       GRID2OP_CURRENT_VERSION_STR)
+
diff --git a/grid2op/Space/default_var.py b/grid2op/Space/default_var.py
@@ -0,0 +1,30 @@
+# Copyright (c) 2025, 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 Grid2Op, Grid2Op a testbed platform to model sequential decision making in power systems.
+
+import importlib.metadata
+from packaging import version
+
+#: if not set by the user, in how many independant buses
+#: each substation can be split. 2 by default
+DEFAULT_N_BUSBAR_PER_SUB = 2
+
+#: whether or not grid2op will allow (=continue an episode)
+#: if a load a generator or a storage unit is disconnected
+#: from the grid
+DEFAULT_ALLOW_DETACHMENT = False
+
+#: in which subfolder (of the environment) the grid2op classes
+#: will be stored
+GRID2OP_CLASSES_ENV_FOLDER = "_grid2op_classes"
+
+#: current grid2op version, represented as a string
+GRID2OP_CURRENT_VERSION_STR = importlib.metadata.version("grid2op")
+
+#: current grid2op version used, represented as a "packaging version"
+#: use this for any comparison
+GRID2OP_CURRENT_VERSION = version.parse(GRID2OP_CURRENT_VERSION_STR)
diff --git a/grid2op/__init__.py b/grid2op/__init__.py
@@ -11,7 +11,7 @@
 Grid2Op a testbed platform to model sequential decision making in power systems.
 """
 
-__version__ = '1.11.0.dev3'
+__version__ = '1.11.0.dev4'
 
 __all__ = [
     "Action",
diff --git a/test_jax.py b/test_jax.py
