Demand Response

CHANGELOG.rst

@@ -1,153 +1,97 @@
-Work "in progress"
+[TODO]
+--------------------
+- [???] use some kind of "env.get_state()" when simulating instead of recoding everything "by hand"
+- [???] use "backend.get_action_to_set()" in simulate
+- [???] model better the voltage, include voltage constraints
+- [???] use the prod_p_forecasted and co in the "next_chronics" of simulate
+- [???] in deepcopy of env, make tests that the "pointers" are properly propagated in the attributes (for example
+  `envcpy._game_rules.legal_action` should not be copied when building `envcpy._helper_action_env`)
+- [???] add multi agent
+- [???] make observation read only / immutable for all its properties (and not just for `prod_p`)
+- [???] better logging
+- [???] shunts in observation too, for real (but what to do when backend is not shunt compliant to prevent the
+  stuff to break)
+- [???] model agent acting at different time frame
+- [???] model delay in observations
+- [???] model delay in action
+- [???] Code and test the "load from disk" method
+- [???] add a "plot action" method
+- [???] in MultiEnv, when some converter of the observations are used, have each child process to compute
+  it in parallel and transfer the resulting data.
+- [???] "asynch" multienv
+- [???] properly model interconnecting powerlines
+
+Next few releases
 ---------------------------------
 
 General grid2op improvments:
 
-- ill formed docstring in the BaseAction module
-- remove pandapower dependency (have a way to install grid2op without pandapower)
-- better logging
-- have functions that automatically computes topo_vect and switch_state in the backend 
-  (usefull for solver that will never disconnect or reconnect anything)
-- bug on maintenance starting at midnight (they are not correctly handled in the observation)
+- numpy 2 compat (need pandapower for that)
+- TODO bug on maintenance starting at midnight (they are not correctly handled in the observation)
   => cf script test_issue_616
-- A number of max buses per substation different for each substation
-- in the runner, save multiple times the same scenarios
-- add a "_cst_" or something for the `const` members of all the classes
-- improve type annotation for all public functions
-- properly document and type hint all public members of all the public classes
-- properly implement the copy and "deepcopy" API
-- in deepcopy of env, make tests that the "pointers" are properly propagated in the attributes (for example
-  `envcpy._game_rules.legal_action` should not be copied when building `envcpy._helper_action_env`)
-- Make the redispatching data independent from the time step (eg instead of "in MW / step" have it in "MW / h")
+- TODO A number of max buses per sub
+- TODO in the runner, save multiple times the same scenario
+- TODO improve type annotation for all public functions
+- TODO add a "_cst_" or something for the `const` members of all the classes
+- TODO properly document and type hint all public members of all the public classes
+- TODO properly implement the copy and "deepcopy" API
+- TODO Make the redispatching data independent from the time step (eg instead of "in MW / step" have it in "MW / h")
   and have grid2op convert it to MW / step
-- make observation read only / immutable for all its properties (and not just for `prod_p`)
-- in parallel distribute the loading of the time series if using a `MultifolderWithCache`
-- Code and test the "load from disk" method
-- add a "plot action" method
-- does not read every data of the backend if not used
 
 Better multi processing support: 
 
 - automatic read from local dir also on windows !
-- doc for the "new" feature of automatic "experimental_read_from_local_dir"
-- extend this feature (automatic "experimental_read_from_local_dir") to work also on windows based OS 
-- finish the test in automatic_classes
-- "asynch" multienv
-- in MultiEnv, when some converter of the observations are used, have each child process to compute
-  it in parallel and transfer the resulting data.
+- TODO doc for the "new" feature of automatic "experimental_read_from_local_dir"
+- TODO extend this feature to work also on windows based OS 
+- TODO finish the test in automatic_classes
+
 
 Features related to gymnasium compatibility:
 
-- put the `Grid2opEnvWrapper` (of the notebooks) directly in grid2op as GymEnv
-- faster gym_compat (especially for DiscreteActSpace and BoxGymObsSpace)
-- Notebook for tf_agents
-- Notebook for acme
-- Notebook using "keras rl" (see https://keras.io/examples/rl/ppo_cartpole/)
-- example for MCTS https://github.com/bwfbowen/muax et https://github.com/google-deepmind/mctx
-- done and truncated properly handled in gym_compat module (when game over
+- TODO put the Grid2opEnvWrapper directly in grid2op as GymEnv
+- TODO faster gym_compat (especially for DiscreteActSpace and BoxGymObsSpace)
+- TODO Notebook for tf_agents
+- TODO Notebook for acme
+- TODO Notebook using "keras rl" (see https://keras.io/examples/rl/ppo_cartpole/)
+- TODO example for MCTS https://github.com/bwfbowen/muax et https://github.com/google-deepmind/mctx
+- TODO done and truncated properly handled in gym_compat module (when game over
   before the end it's probably truncated and not done) 
-- when reset, have an attribute "reset_infos" with some infos about the
+- TODO when reset, have an attribute "reset_infos" with some infos about the
   way reset was called.
-- on CI: test only gym, only gymnasium and keep current test for both gym and gymnasium
-- refactor the gym_compat module to have a "legacy" stuff exactly like today
+- TODO on CI: test only gym, only gymnasium and keep current test for both gym and gymnasium
+- TODO refactor the gym_compat module to have a "legacy" stuff exactly like today
   and the current class only supporting gymnasium (with possibly improved speed)
-- in the gym env, make the action_space and observation_space attribute
+- TODO in the gym env, make the action_space and observation_space attribute
   filled automatically (see ray integration, it's boring to have to copy paste...)
-- closer integration with `gymnasium` especially the "register env", being able to 
+- [???] closer integration with `gymnasium` especially the "register env", being able to 
   create an env from a string etc.
 
 Grid2op extended features:
 
-- ForecastEnv in MaskedEnv ! (and obs.simulate there too !)
-- in multi-mix increase the reset options with the mix the user wants
-- L2RPN scores as reward (sum loads after the game over and have it in the final reward)
-- work on the reward class (see https://github.com/Grid2Op/grid2op/issues/584)
-- jax everything that can be: create a simple env based on jax for topology manipulation, without
+- TODO ForecastEnv in MaskedEnv ! (and obs.simulate there too !)
+- TODO in multi-mix increase the reset options with the mix the user wants
+- TODO L2RPN scores as reward (sum loads after the game over and have it in the final reward)
+- TODO work on the reward class (see https://github.com/Grid2Op/grid2op/issues/584)
+- TODO jax everything that can be: create a simple env based on jax for topology manipulation, without
   redispatching or rules
-- backend in jax, maybe ?
-
-The "simulate" function :
-
-- use some kind of "env.get_state()" when simulating instead of recoding everything "by hand"
-- use "backend.get_action_to_set()" in simulate
-- use the prod_p_forecasted and co in the "next_chronics" of simulate
-
-Better handling of the voltages:
-
-- model better the voltage, include voltage constraints
-- shunts in observation too, for real (but what to do when backend is not shunt compliant to prevent the
-  stuff to break)
-- model action on "shunts":
-  - either continuous (by default, if no config file)
-  - or discrete (more realistic, need a config file)
-- model action related to transformer ratio:
-  - either continuous (by default, if no config file)
-  - or discrete (more realistic, need a config file)
-
-Other modeling issues:
-
-- model agent acting at different time frame
-- model delay in observations
-- model delay in action
-- model action / observation on phase shifters
-- model action / observation on HDVC powerlines
+- TODO backend in jax, maybe ?
 
 Native multi agents support:
 
 - cf ad-hoc branch (dev-multiagents)
-- properly model interconnecting powerlines
-
-[1.11.0] - 202x-yy-zz
------------------------
-- [BREAKING] Change for `FromMultiEpisodeData` that disables the caching by default
-  when creating the data.
-- [BREAKING] deprecation of `backend.check_kirchoff` in favor of `backend.check_kirchhoff` 
-  (fix the typo in the name)
-- [BREAKING] change the name of the generated classes: now by default the backend class
-  name is added. This behaviour can be turned off by passing `_add_cls_nm_bk=False`
-  when calling `grid2op.make(...)`. If you develop a new Backend, you can also
-  customize the added name by overloading the `get_class_added_name` class method.
-- [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.
-- [FIXED] the `obs.get_forecast_env` : in some cases the resulting first
-  observation (obtained from `for_env.reset()`) did not have the correct
-  topology.
-- [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(...)` 
-  or , `gridobj.get_storage_info(...)` 
-- [ADDED] codacy badge on the readme
-- [ADDED] a method to check the KCL (`obs.check_kirchhoff`) directly from the observation
-  (previously it was only possible to do it from the backend). This should 
-  be used for testing purpose only
-- [IMPROVED] possibility to set the injections values with names
-  to be consistent with other way to set the actions (*eg* set_bus)
-- [IMPROVED] error messages when creating an action which changes the injections
-- [IMPROVED] (linked to https://github.com/Grid2op/grid2op/issues/657) the way the 
-  "chronics_hander" in the ObsEnv behaves (it now fully implements the public interface of 
-  a "real" chronic_handler)
-- [IMPROVED] error message in the `FromNPY` class when the backend is checked
-- [IMRPOVED] the `FromMultiEpisodeData` class with the addition of the `caching` 
-  kwargs to allow / disable caching (which was default behavior in previous version) 
-- [IMPROVED] the `FromMultiEpisodeData` class that now returns also the path of the data
-- [IMPROVED] the classes inherited from `GreedyAgent` with the added possibility to 
-  do the `obs.simulate` on a different time horizon (kwarg `simulated_time_step`)
-- [IMPROVED] some type hints for some agent class
-- [IMPROVED] the `backend.update_from_obs` function to work even when observation
-  does not have shunt information but there are not shunts on the grid.
-- [IMPROVED] consistency of `MultiMixEnv` in case of automatic_classes (only one
-  class is generated for all mixes)
 
 [1.10.4] - 2024-10-15
 -------------------------
 - [FIXED] new pypi link (no change in code)
 - [FIXED] mybinder environment
 - [FIXED] update all the links in the README.md (for the new grid2op location)
+<<<<<<< HEAD
 - [FIXED] update all the links in the docs and the grid2op source files 
   (to match new location: Grid2op/grid2op.git)
 - [FIXED] the link in the `make_env` and `update_env` to point to 
   https://api.github.com/repos/Grid2Op/grid2op-datasets/
+=======
+>>>>>>> 0a04e162 (fixing the url to point to Grid2op/grid2op instead of rte-france/grid2op [skip ci])
 - [IMPROVED] clarity of the "work in progress" in this CHANGELOG
 
 [1.10.4] - 2024-10-14

CONTRIBUTING.md

@@ -22,7 +22,11 @@ If you want to contribute but are not sure were to start you can, for example:
 
 - tackle an opened issue tagged as `good first issue` 
 - try to solve an opened issue marked with `helps wanted`
+<<<<<<< HEAD
 - there are also some contribution ideas written in the `Work "in progress"` section of the `CHANGELOG.rst`
+=======
+- there are also some contribution ideas written in the `[TODO]` and `Next few releases` of the `CHANGELOG.rst`
+>>>>>>> 0a04e162 (fixing the url to point to Grid2op/grid2op instead of rte-france/grid2op [skip ci])
   at the top level of the github repo.
 
 In any case, if you are not sure about what is written here, feel free to ask in the grid2op [github discussion](https://github.com/orgs/Grid2op/discussions), 

getting_started/06_Redispatching_Curtailment.ipynb

@@ -111,7 +111,7 @@
    "source": [
     "By default, some environments do not specify the cost of generators, their maximum and minimum production values, etc. In this case it is not possible to redispatch in grid2op.\n",
     "\n",
-    "To know more about what is needed for using redispatching, it is advised to look at this help online : https://grid2op.readthedocs.io/en/latest/space.html#grid2op.Space.GridObjects.redispatching_unit_commitment_availble for the most recent documentation. When this notebook was created, the following were needed:\n",
+    "To know more about what is needed for using redispatching, it is advised to look at this help online : https://grid2op.readthedocs.io/en/latest/space.html#grid2op.Space.GridObjects.redispatching_unit_commitment_available for the most recent documentation. When this notebook was created, the following were needed:\n",
     "\n",
     "- \"gen_type\": the type of generator\n",
     "- \"gen_pmin\": the minimum value a generator can produce\n",
@@ -147,7 +147,7 @@
     "env_name = \"l2rpn_case14_sandbox\"\n",
     "env = grid2op.make(env_name, test=True, backend=bk_cls())\n",
     "\n",
-    "print(\"Is this environment suitable for redispatching: {}\".format(env.redispatching_unit_commitment_availble))"
+    "print(f\"Is this environment suitable for redispatching: {env.redispatching_unit_commitment_available}\")"
    ]
   },
   {

grid2op/Action/_backendAction.py

@@ -663,6 +663,14 @@ def set_redispatch(self, new_redispatching):
             This is called by the environment, do not alter.
         """
         self.prod_p.change_val(new_redispatching)
+
+    def set_flexibility(self, new_flexibility):
+        """
+        .. warning:: /!\\\\ Internal, do not use unless you know what you are doing /!\\\\
+
+            This is called by the environment, do not alter.
+        """
+        self.load_p.change_val(new_flexibility)
 
     def _aux_iadd_inj(self, dict_injection):
         """