Merge pull request #547 from rte-france/dev_1.9.6

Version 1.9.6
Grid2op · Oct 26, 2023 · 2e0e5f3 · 2e0e5f3
2 parents 0f927b1 + 5619bee
commit 2e0e5f3
Show file tree

Hide file tree

Showing 211 changed files with 5,910 additions and 1,479 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -21,6 +21,9 @@ executors:
     python311:
         docker:
             - image: python:3.11-buster
+    python312:
+        docker:
+            - image: cimg/python:3.12.0
 
 jobs:
     test:
@@ -231,6 +234,14 @@ jobs:
                    python -m pip install -U .[test]
                    export _GRID2OP_FORCE_TEST=1
                    grid2op.testinstall
+            - run:
+               command: |
+                   source venv_test/bin/activate
+                   python -m pip install -U "numpy>=1.26,<1.27"
+                   python -m pip install -U .[test]
+                   export _GRID2OP_FORCE_TEST=1
+                   grid2op.testinstall
+
     install310:
         executor: python310
         resource_class: small
@@ -282,6 +293,14 @@ jobs:
                    python -m pip install -U .[test]
                    export _GRID2OP_FORCE_TEST=1
                    grid2op.testinstall
+            - run:
+               command: |
+                   source venv_test/bin/activate
+                   python -m pip install -U "numpy>=1.26,<1.27"
+                   python -m pip install -U .[test]
+                   export _GRID2OP_FORCE_TEST=1
+                   grid2op.testinstall
+
     install311:
         executor: python311
         resource_class: small
@@ -319,6 +338,36 @@ jobs:
                    python -m pip install -U .[test]
                    export _GRID2OP_FORCE_TEST=1
                    grid2op.testinstall
+            - run:
+               command: |
+                   source venv_test/bin/activate
+                   python -m pip install -U "numpy>=1.26,<1.27"
+                   python -m pip install -U .[test]
+                   export _GRID2OP_FORCE_TEST=1
+                   grid2op.testinstall
+    install312:
+        executor: python312
+        resource_class: small
+        steps:
+            - checkout
+            - run: 
+                command: |
+                    sudo  apt-get update
+                    sudo  apt-get install -y coinor-cbc
+            - run: python -m pip install virtualenv
+            - run: python -m virtualenv venv_test
+            - run:
+               command: |
+                   source venv_test/bin/activate
+                   python -m pip install -U pip setuptools wheel
+                #    python -m pip install -U numba  # not on python 3.12 at the moment
+            - run:
+               command: |
+                   source venv_test/bin/activate
+                   python -m pip install -U "numpy>=1.26,<1.27"
+                   python -m pip install -U .[test]
+                   export _GRID2OP_FORCE_TEST=1
+                   grid2op.testinstall
 
 workflows:
     version: 2.1
@@ -331,3 +380,4 @@ workflows:
           - install39
           - install310
           - install311
+        #   - install312  # failing because of dependencies of numba, torch etc. Tired of it so ignoring it !
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -35,6 +35,11 @@ jobs:
             abi: cp311,
             version: '3.11',
           }
+          - {
+            name: cp312,
+            abi: cp312,
+            version: '3.12',
+          }
 
     steps:
 
@@ -50,6 +55,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install --upgrade wheel
+          python -m pip install --upgrade setuptools
           
       - name: Build wheel
         run: |
@@ -102,6 +108,10 @@ jobs:
             name: cp311,
             version: '3.11',
           }
+          - {
+            name: cp312,
+            version: '3.12',
+          }
 
     steps:
 
@@ -119,6 +129,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           python -m pip install --upgrade wheel
+          python -m pip install --upgrade setuptools
 
       - name: Build wheel
         run: python setup.py bdist_wheel
@@ -134,7 +145,7 @@ jobs:
           python3 -c "from grid2op.Action._backendAction import _BackendAction"
 
       - name: Build source archive
-        if: matrix.config.name == 'darwin' && matrix.python.name == 'cp39'
+        if: matrix.config.name == 'darwin' && matrix.python.name == 'cp310'
         run: python setup.py sdist
 
       - name: Upload wheel

diff --git a/.gitignore b/.gitignore
@@ -392,6 +392,11 @@ actspace_converter.py
 grid2op/data_test/input_data_local/
 test_sim2real_battery.py
 grid2op/tests/list_test_debug
+aux_test_make_backend_test_suite.py
+grid2op/tests/test_failing_simulator.txt
+old_pyproject.toml
+pp_bug_gen_alone.py
+test_dunder.py
 
 # profiling files
 **.prof
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -31,6 +31,42 @@ Change Log
 - [???] "asynch" multienv
 - [???] properly model interconnecting powerlines
 
+[1.9.6] - 2023-10-26
+----------------------
+- [BREAKING] when a storage is connected alone on a bus, even if it produces / absorbs 0.0 MW it 
+  will raise a diverging powerflow error (previously the storage was automatically disconnected by 
+  `PandaPowerBackend`, but probably not by other backends)
+- [BREAKING] when a shunt is alone on a bus, the powerflow will diverge even in DC mode 
+  (previously it only converges which was wrong behaviour: grid2op should not disconnect shunt)
+- [FIXED] a bug in PandaPowerBackend (DC mode) where isolated load did not raised 
+  exception (they should lead to a divergence)
+- [FIXED] some wrong behaviour in the `remove_line_status_from_topo` when no observation where provided
+  and `check_cooldown` is `False`
+- [FIXED] a bug in PandaPowerBackend in AC powerflow: disconnected storage unit had no 0. as voltage
+- [FIXED] a bug in PandaPowerBackend in AC powerflow when a generator was alone a bus it made the powerflow
+  crash on some cases (*eg* without lightsim2grid, without numba)
+- [FIXED] a bug in PandaPowerBackend in DC (in some cases non connected grid were not spotted)
+- [FIXED] now the observations once reloaded have the correct `_is_done` flag (`obs._is_done = False`)
+  which allows to use the `obs.get_energy_graph()` for example. This fixes https://github.com/rte-france/Grid2Op/issues/538
+- [ADDED] now depends on the `typing_extensions` package
+- [ADDED] a complete test suite to help people develop new backend using "Test Driven Programming" 
+  techniques
+- [ADDED] the information on which time series data has been used by the environment in the `info`return value
+  of `env.step(...)`
+- [ADDED] a test suite easy to set up to test the backend API (and only the backend for now, integration tests with
+  runner and environment will follow)
+- [ADDED] an attribute of the backend to specify which file extension can be processed by it. Environment creation will
+  fail if none are found. See `backend.supported_grid_format` see https://github.com/rte-france/Grid2Op/issues/429
+- [IMPROVED] now easier than ever to run the grid2op test suite with a new backend (for relevant tests)
+- [IMPROVED] type hints for `Backend` and `PandapowerBackend`
+- [IMPROVED] distribute python 3.12 wheel
+- [IMPROVED] test for python 3.12 and numpy 1.26 when appropriate (*eg* when numpy version is released)
+- [IMPROVED] handling of environments without shunts
+- [IMPROVED] error messages when grid is not consistent 
+- [IMPROVED] add the default `l2rpn_case14_sandbox` environment in all part of the docs (substituing `rte_case14_realistic` or nothing)
+- [IMPROVED] imports on the `Exceptions` module
+- [IMPROVED] pandapower backend raises `BackendError` when "diverging"
+
 [1.9.5] - 2023-09-18
 ---------------------
 - [FIXED] issue https://github.com/rte-france/Grid2Op/issues/518