improve consistency and clarity of the changelog and contributing.md [skip ci]

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

Author: BDonnot

CHANGELOG.rst

@@ -1,90 +1,110 @@
-[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
+Work "in progress"
 ---------------------------------
 
 General grid2op improvments:
 
 - numpy 2 compat (need pandapower for that)
-- TODO bug on maintenance starting at midnight (they are not correctly handled in the observation)
+- 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)
   => cf script test_issue_616
-- 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")
+- 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")
   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
 
 Better multi processing support: 
 
 - automatic read from local dir also on windows !
-- 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
-
+- 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.
 
 Features related to gymnasium compatibility:
 
-- 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
+- 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
   before the end it's probably truncated and not done) 
-- TODO when reset, have an attribute "reset_infos" with some infos about the
+- when reset, have an attribute "reset_infos" with some infos about the
   way reset was called.
-- 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
+- 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
   and the current class only supporting gymnasium (with possibly improved speed)
-- TODO in the gym env, make the action_space and observation_space attribute
+- 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:
 
-- 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
+- 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
   redispatching or rules
-- TODO backend in jax, maybe ?
+- 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
 
 Native multi agents support:
 
 - cf ad-hoc branch (dev-multiagents)
+- properly model interconnecting powerlines
 
 [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)
+- [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/
 - [IMPROVED] clarity of the "work in progress" in this CHANGELOG
 
 [1.10.4] - 2024-10-14

CONTRIBUTING.md

@@ -22,7 +22,7 @@ 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`
-- there are also some contribution ideas written in the `[TODO]` and `Next few releases` of the `CHANGELOG.rst`
+- there are also some contribution ideas written in the `Work "in progress"` section of the `CHANGELOG.rst`
   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), 

grid2op/MakeEnv/Make.py

@@ -67,7 +67,7 @@
 )
 
 _LIST_REMOTE_URL = (
-    "https://api.github.com/repos/bdonnot/grid2op-datasets/contents/datasets.json"
+    "https://api.github.com/repos/Grid2Op/grid2op-datasets/contents/datasets.json"
 )
 _LIST_REMOTE_KEY = "download_url"
 _LIST_REMOTE_INVALID_CONTENT_JSON_ERR = (

grid2op/MakeEnv/UpdateEnv.py

@@ -17,10 +17,10 @@
 from grid2op.MakeEnv.Make import _retrieve_github_content
 
 _LIST_REMOTE_URL = (
-    "https://api.github.com/repos/bdonnot/grid2op-datasets/contents/updates.json"
+    "https://api.github.com/repos/Grid2Op/grid2op-datasets/contents/updates.json"
 )
 _LIST_REMOTE_ENV_HASH = (
-    "https://api.github.com/repos/bdonnot/grid2op-datasets/contents/env_hashes.json"
+    "https://api.github.com/repos/Grid2Op/grid2op-datasets/contents/env_hashes.json"
 )