update Readme, changelog and notebook name [skip ci]

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

Author: BDonnot

CHANGELOG.rst

@@ -100,7 +100,7 @@ Native multi agents support:
 - add detachment
 - add change_bus / set_bus
 
-[1.11.0] - 202x-yy-zz
+[1.11.0] - 2025-04-14
 -----------------------
 - [BREAKING] Change for `FromMultiEpisodeData` that disables the caching by default
   when creating the data.

README.md

@@ -202,6 +202,9 @@ interesting part of this framework:
 * [11_IntegrationWithExistingRLFrameworks](getting_started/11_IntegrationWithExistingRLFrameworks.ipynb)
   [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Grid2Op/grid2op/blob/master/getting_started/11_IntegrationWithExistingRLFrameworks.ipynb)
   explains how to use grid2op with other reinforcement learning framework. TODO: this needs to be redone
+* [12_DetachmentOfLoadsAndGenerators.ipynb](getting_started/12_DetachmentOfLoadsAndGenerators.ipynb.ipynb)
+  [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Grid2Op/grid2op/blob/master/getting_started/12_DetachmentOfLoadsAndGenerators.ipynb.ipynb)
+  explains briefly what is detachment.
 
 Try them out in your own browser without installing
 anything with the help of mybinder:

binder/environment.yml

@@ -8,7 +8,6 @@ dependencies:
   - pip
   - pip:
     - grid2op
-    - jyquickhelper
     - numpy
     - numba
     - seaborn

getting_started/13_DetachmentOfLoadsAndGenerators.ipynb renamed to getting_started/12_DetachmentOfLoadsAndGenerators.ipynb

@@ -23,14 +23,13 @@
     "from pathlib import Path\n",
     "\n",
     "# Setup Environment\n",
-    "data_path = Path.cwd() / \"grid2op\" / \"data\"\n",
-    "p = Parameters()\n",
-    "p.MAX_SUB_CHANGED = 5\n",
-    "env = grid2op.make(data_path / \"rte_case5_example\", param=p, allow_detachment=True)\n",
+    "env_standard = grid2op.make(\"rte_case5_example\", test=True, allow_detachment=False)\n",
+    "env_with_detach = grid2op.make(\"rte_case5_example\", test=True, allow_detachment=True)\n",
     "\n",
     "# Setup Plotter Utility\n",
-    "plotter = PlotMatplot(env.observation_space, load_name=True, gen_name=True, dpi=150)\n",
-    "print(f\"Loads: {env.n_load}, Generators: {env.n_gen}, Storage: {env.n_storage}, Allow Detachment: {env._allow_detachment}\")"
+    "plotter = PlotMatplot(env_standard.observation_space, load_name=True, gen_name=True, dpi=150)\n",
+    "for env, env_name in zip([env_standard, env_with_detach], [\"env_standard\", \"env_with_detach\"]):\n",
+    "    print(f\"For {env_name}: Loads: {env.n_load}, Generators: {env.n_gen}, Storage: {env.n_storage}, Detachment is allowed: {env.detachment_is_allowed}\")"
    ]
   },
   {
@@ -46,22 +45,33 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "load_lookup = {name:i for i,name in enumerate(env.name_load)}\n",
-    "gen_lookup = {name:i for i,name in enumerate(env.name_gen)}\n",
-    "act = env.action_space({\"set_bus\":[(env.load_pos_topo_vect[load_lookup[\"load_3_1\"]], -1),\n",
-    "                                   (env.load_pos_topo_vect[load_lookup[\"load_4_2\"]], -1)]})\n",
+    "act = env_standard.action_space({\"set_bus\":{\"loads_id\": [(\"load_3_1\", -1)]}})\n",
     "print(act)\n",
-    "env.set_id(\"00\")\n",
-    "init_obs = env.reset()\n",
-    "obs, reward, done, info = env.step(act)\n",
+    "init_obs = env_standard.reset(seed=0, options={\"time serie id\": \"00\"})\n",
+    "obs, reward, done, info = env_standard.step(act)\n",
     "plotter.plot_obs(obs, figure=plt.figure(figsize=(8,5)))\n",
+    "plt.title(\"Without providing 'allow_detachment=True' grid2op fails if a load is disconnected\")\n",
+    "plt.show()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "init_obs = env_with_detach.reset(seed=0, options={\"time serie id\": \"00\"})\n",
+    "obs, reward, done, info = env_with_detach.step(act)\n",
+    "plotter.plot_obs(obs, figure=plt.figure(figsize=(8,5)))\n",
+    "plt.title(\"Providing 'allow_detachment=True' grid2op continues if a load is disconnected\")\n",
+    "plt.tight_layout()\n",
     "plt.show()"
    ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "venv_test",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -75,9 +85,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.7"
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }