Merge pull request #13 from BDonnot/plot_grid_plotly

Hazards, maintenance, plot utilities
rte-france · Dec 4, 2019 · de5a9a6 · de5a9a6
2 parents 0bcc334 + fd7dd6a
commit de5a9a6
Show file tree

Hide file tree

Showing 35 changed files with 3,864 additions and 282 deletions.
diff --git a/.gitignore b/.gitignore
@@ -156,3 +156,4 @@ documentation
 grid2op/data/*/*.csv
 **token.json
 getting_started/study_agent_getting_started/
+**Untitled.ipynb
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,5 +1,16 @@
 Change Log
 =============
+
+[0.4.0] - 2019-12-04
+--------------------
+- [ADDED] Basic tools for plotting with the `PlotPlotly` module
+- [UPDATED] handling of the `AmbiguousAction` and `IllegalAction` exceptions (and appropriated tests)
+- [ADDED] support of maintenance operation as well as hazards in the Observation (and appropriated tests)
+- [ADDED] support for maintenance operation in the Environment (read from the chronics)
+- [UPDATED] various documentation, in particular the class Observation
+- [UPDATED] information retrievable `Observation.state_of`
+- [ADDED] example of chronics with hazards and maintenance
+
 [0.3.6] - 2019-12-01
 --------------------
 - [UPDATED] Readme with docker

diff --git a/docs/conf.py b/docs/conf.py
@@ -22,8 +22,8 @@
 author = 'Benjamin Donnot'
 
 # The full version, including alpha/beta/rc tags
-release = '0.3.6'
-version = '0.3'
+release = '0.4.0'
+version = '0.4'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/index.rst b/docs/index.rst
@@ -34,6 +34,7 @@ Main module content
    quickstart
    grid2op
    makeenv
+   pltplotly
 
 Technical Documentation
 ----------------------------

diff --git a/docs/intro.rst b/docs/intro.rst
@@ -13,6 +13,6 @@ library is available as an example.
 
 Any other tools that is able to perform power flow computation can be used as a "backend" to
 play the game or to accelerate the training. Instructions and method to implement
-a new backend are available in the :class:`Grid2Op.Backend` documentation.
+a new backend are available in the :class:`Grid2Op.Backend.Backend` documentation.
 
 TO be continued (package still under development)
diff --git a/docs/pltplotly.rst b/docs/pltplotly.rst
@@ -0,0 +1,8 @@
+Basic plotting utilities
+===================================
+
+.. automodule:: grid2op.PlotPlotly
+    :members:
+    :special-members:
+
+.. include:: final.rst
diff --git a/getting_started/4_StudyYourAgent.ipynb b/getting_started/4_StudyYourAgent.ipynb
diff --git a/grid2op/Backend.py b/grid2op/Backend.py
@@ -773,6 +773,8 @@ def get_topo_vect(self):
         `*_pos_topo_vect` (*eg.* :attr:`Backend.load_pos_topo_vect`) vectors. For each elements it gives its position
         in this vector.
 
+        TODO make an example here on how to use this!
+
         Returns
         --------
         res: `numpy.ndarray`