Merge pull request #190 from rte-france/dev_1.5.1

Dev 1.5.1

.github/ISSUE_TEMPLATE/documentation.md

@@ -8,17 +8,20 @@ assignees: ''
 ---
 
 ## Documentation issue description
-<--A description of what the problem/suggestion is.-->
+<!--A description of what the problem/suggestion is.-->
 
 ## Suggested modifications
-<--Be as concise and clear as possible.
+<!--Be as concise and clear as possible.
 Ideally we could directly copy paste this code in grid2op documentation / notebook etc.
 -->
+
 ```
+Please note:
+
 Documentation issues are low priority. 
 Please provide your suggested modifications to increase processing speed.
 Thanks for your understanding.
 ```
 
 ## Additional context
-Add any other context here.
+<!--Add any other context here.-->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -8,13 +8,34 @@ assignees: ''
 ---
 
 ## Is your feature request related to a problem? Please describe.
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+<!--A clear and concise description of what the problem is.-->
+<!--Ex. I'm always frustrated when [...]-->
+<!-- Do not forget to include code you are currently running that is frustrating-->
 
+Ex. This is what i do:
+```python
+import grid2op
+env_name = ...
+env = grid2op.make(env_name, ...)
+
+...
+```
 ## Describe the solution you'd like
-A clear and concise description of what you want to happen.
+<!--A clear and concise description of what you want to happen.-->
+<!--Don't forget to include the "code of your dream" -->
+
+Ex. This is how i would like it to be done:
+```python
+import grid2op
+env_name = ...
+env = grid2op.make(env_name, ...)
+
+# give an example on how your awesome new feature would behave
+```
 
 ## Describe alternatives you've considered
-A clear and concise description of any alternative solutions or features you've considered.
+<!--A clear and concise description of any 
+alternative solutions or features you've considered.-->
 
 ## Additional context
-Add any other context about the feature request here.
+<!--Add any other context about the feature request here.-->

.gitignore

@@ -298,6 +298,11 @@ pp_error_non_connected_grid.py
 test_issue174.py
 actions2.npy
 bug_discord_0.py
+invert_idto_act.py
+test_bug_discord1.py
+test_networkx.py
+test_issue185.py
+test_can_make_opponent.py
 
 # profiling files
 **.prof

CHANGELOG.rst

@@ -22,6 +22,29 @@ Change Log
 - [???] "asynch" multienv
 - [???] properly model interconnecting powerlines
 
+[1.5.1] - 2021-xx-yy
+-----------------------
+- [FIXED]: `Issue #187 <https://github.com/rte-france/Grid2Op/issues/187>`_: improve the computation and the
+  documentation of the `RedispReward`. This has an impact on the `env.reward_range` of all environments using this
+  reward, because the old "reward_max" was not correct.
+- [FIXED] `Issue #181 <https://github.com/rte-france/Grid2Op/issues/181>`_ : now environment can be created with
+  a layout and a warning is issued in this case.
+- [FIXED] `Issue #180 <https://github.com/rte-france/Grid2Op/issues/180>`_ : it is now possible to set the thermal
+  limit with a dictionary
+- [FIXED] a typo that would cause the attack to be discarded in the runner in some cases (cases for now not used)
+- [FIXED] an issue linked to the transformation into gym box space for some environments,
+  this **might** be linked to `Issue #185 <https://github.com/rte-france/Grid2Op/issues/185>`_
+- [ADDED] a feature to retrieve the voltage angle (theta) in the backend (`backend.get_theta`) and in the observation.
+- [ADDED] support for multimix in the GymEnv (lack of support spotted thanks to
+  `Issue #185 <https://github.com/rte-france/Grid2Op/issues/185>`_ )
+- [ADDED] basic documentation of the environment available.
+- [ADDED] `Issue #166 <https://github.com/rte-france/Grid2Op/issues/166>`_ : support for simulate in multi environment
+  settings.
+- [IMPROVED] extra layer of security preventing modification of `observation_space` and `action_space` of environment
+- [IMPROVED] better handling of dynamically generated classes
+- [IMPROVED] the documentation of the opponent
+
+
 [1.5.0] - 2021-03-31
 -------------------------
 - [BREAKING] `backend.check_kirchoff()` method now returns also the discrepancy in the voltage magnitude

docs/action.rst

@@ -323,7 +323,9 @@ Now to retrieve a "graph like" object, you can :
     # method 2
     obs_add = obs + add
 
-And refer to the section :ref:`observation_module_graph` to retrieve a graph structure from these observations.
+And refer to the page :ref:`gridgraph-module` or the section :ref:`observation_module_graph` to retrieve a graph
+structure from these observations.
+
 For example:
 
 .. code-block:: python
@@ -333,6 +335,7 @@ For example:
     connect_mat = obs_add.connectivity_matrix()  # alternatively  `sim_obs.connectivity_matrix()`
 
 
+
 .. _Illegal-vs-Ambiguous:
 
 Illegal vs Ambiguous

docs/agent.rst

@@ -4,6 +4,12 @@
 Agent
 ============
 
+This page is organized as follow:
+
+.. contents:: Table of Contents
+    :depth: 3
+
+
 Objectives
 -----------
 In this RL framework, an Agent is an entity that acts on the Environment (modeled in grid2op as an object