Merge pull request #163 from BDonnot/master

Switching to version 1.4.0

.gitignore

@@ -245,6 +245,22 @@ getting_started/investigate_redisp_bug.ipynb
 **/split_and_save_meta_params.json
 getting_started/saved_agent_DDDQN_BDA_1000/
 getting_started/saved_agent_DDDQN_BDA_1000_results/
+getting_started/saved_agent2_DDDQN_300/
+getting_started/saved_agent2_DDDQN_300_results/
+getting_started/saved_agent_DDDQN_200/
+getting_started/saved_agent_DDDQN_200_results/
+test_stable_baselines.py
+grid2op/Opponent/DCOPFOpponent.py
+test_dcopponent.py
+getting_started/0_SmallExample.html
+grid2op/utils/my_agent/
+my_agent_for_test_reboot/
+scale_weights.py
+test_weights.jpg
+test_weights_focus.jpg
+test_weights_full.jpg
+times_api.txt
+new 1.txt
 
 # profiling files
 **.prof

CHANGELOG.rst

@@ -3,22 +3,49 @@ Change Log
 
 [TODO]
 --------------------
+- [???] add multi agent
+- [???] model curtailment
+- [???] better logging
+- [???] model batteries / pumped storage in grid2op (generator but that can be charged / discharged)
+- [???] shunts in observation too, for real (but what to do when backend is not shunt compliant to prevent the
+  stuff to break)
 - [???] Extensive tests for BridgeReward
 - [???] Extensive tests for DistanceReward
 - [???] in the observation, make the possibility to retrieve the "active flow graph" (ie graph with edges having active
   flows, and nodes the active production / consumption) and "reactive flow graph"
-- [???] better logging
 - [???] add a "plot action" method
 - [???] simulate in 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.
 - [???] "asynch" multienv
 - [???] properly model interconnecting powerlines
-- [???] model curtailment
-- [???] model batteries / pumped storage in grid2op (generator but that can be charged / discharged)
-- [???] model dumps (as in dump storage) in grid2op (stuff that have a given energy max, and cannot produce more than
+- [???] model agent acting at different time frame
+- [???] model delay in observations
+- [???] model delay in action
+- [???] model dams in grid2op (stuff that have a given energy max, and cannot produce more than
   the available energy)
 
+[1.3.2] - 2020-11-xx
+----------------------
+- [CHANGED] The parameters `FORECAST_DC` is now deprecated. Please use
+  `change_forecast_parameters(new_param)` with `new_param.ENV_DC=...` instead.
+- [FIXED] and test the method `backend.get_action_to_set`
+- [FIXED] an error for the voltage of the shunt in the `PandapowerBackend`
+- [FIXED] `PowerLineSet` and `PowerSetAndDispatch` action were not properly converted to vector.
+- [ADDED] a method to set the state of a backend given a complete observation.
+- [ADDED] a `utils` module to store the data of some environment and be able to compute the scores (as in the neurips
+  l2rpn competitions). This module might move at a different place in the future
+- [ADDED] a function to "split" an environment into train / validation using `os.symlink`
+- [ADDED] the implementation of `+` operator for action (based on previously available `+=`)
+- [ADDED] A more detailed documentation on the representation of the topology and how to create a backend
+- [ADDED] A easier way to set up the topology in backend (eg. `get_loads_bus`)
+- [ADDED] A easier way to set up the backend, with automatic computation of some attributes (eg. `*_to_sub_pos`,
+  `sub_info`, `dim_topo`) if needed.
+- [ADDED] A function to change the `parameters` used by the environment (or `obs_env`) "on the fly" (has only impact
+  AFTER `env.reset` is called) (see `change_parameters` and `change_forecast_parameters`)
+- [IMPROVED] `PandaPowerBackend` now should take less time to when `reset`.
+- [IMPROVED] some speed up in the grid2op computation
+
 [1.3.1] - 2020-11-04
 ----------------------
 - [FIXED] the environment "educ_case14_redisp"

README.md

@@ -4,7 +4,7 @@
 [![PyPi_Compat](https://img.shields.io/pypi/pyversions/grid2op.svg)](https://pypi.org/project/Grid2Op/)
 [![LICENSE](https://img.shields.io/pypi/l/grid2op.svg)](https://www.mozilla.org/en-US/MPL/2.0/)
 [![Documentation Status](https://readthedocs.org/projects/grid2op/badge/?version=latest)](https://grid2op.readthedocs.io/en/latest/?badge=latest)
-[![circleci](https://circleci.com/gh/BDonnot/Grid2Op.svg?style=shield)](https://circleci.com/gh/BDonnot/Grid2Op)
+[![circleci](https://circleci.com/gh/rte-france/Grid2Op.svg?style=shield)](https://circleci.com/gh/rte-france/Grid2Op)
 [![discord](https://discord.com/api/guilds/698080905209577513/embed.png)]( https://discord.gg/cYsYrPT)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/rte-france/Grid2Op/master)
 
@@ -178,6 +178,8 @@ This will create a "documentation" subdirectory and the main entry point of the
 It is recommended to build this documentation locally, for convenience.
 For example, the  "getting started" notebooks referenced some pages of the help.
 
+<!-- sphinx-build -b html docs documentation-->
+
 # Run the tests
 Provided that Grid2Op is installed *from source*:
 

docs/backend.rst

@@ -1,4 +1,5 @@
 .. currentmodule:: grid2op.Backend
+.. _backend-module:
 
 Backend
 ===================================
@@ -44,6 +45,11 @@ The order of the values returned are always the same and determined when the bac
 '\*_names'. For example, when the ith element of the results of a call to :func:`Backend.get_line_flow` is the
 flow on the powerline with name `lines_names[i]`.
 
+Creating a new backend
+-----------------------
+We developed a dedicated page for the development of new "Backend" compatible with grid2op here
+:ref:`create-backend-module`.
+
 Detailed Documentation by class
 -------------------------------
 .. automodule:: grid2op.Backend