Merge pull request #649 from rte-france/dev_1.10.4

Ready for version 1.10.4

.github/workflows/main.yml

@@ -14,6 +14,7 @@ jobs:
     container: quay.io/pypa/manylinux2014_x86_64
     env:
       ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION: true
+      GHA_USE_NODE_20: false
     strategy:
       matrix:
         python:
@@ -42,11 +43,16 @@ jobs:
             abi: cp312,
             version: '3.12',
           }
+          # - {
+          #   name: cp313,   # issue with pandapower atm
+          #   abi: cp313,
+          #   version: '3.13',
+          # }
 
     steps:
 
       - name: Checkout sources
-        uses: actions/checkout@v1
+        uses: actions/checkout@v3
         with:
           submodules: true
 
@@ -120,11 +126,15 @@ jobs:
             name: cp312,
             version: '3.12',
           }
+          # - {  # issue with pandapower atm
+          #   name: cp313,
+          #   version: '3.13',
+          # }
 
     steps:
 
       - name: Checkout sources
-        uses: actions/checkout@v1
+        uses: actions/checkout@v3
         with:
           submodules: true
 
@@ -159,13 +169,13 @@ jobs:
         run: python setup.py sdist
 
       - name: Upload wheel
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: grid2op-wheel-${{ matrix.config.name }}-${{ matrix.python.name }}
           path: dist/*.whl
 
       - name: Upload source archive
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         if: matrix.config.name == 'darwin' && matrix.python.name == 'cp310'
         with:
           name: grid2op-sources
@@ -202,7 +212,7 @@ jobs:
     steps:
 
       - name: Checkout sources
-        uses: actions/checkout@v1
+        uses: actions/checkout@v3
         with:
           submodules: true
 
@@ -238,12 +248,12 @@ jobs:
 
     steps:
       - name: Download wheels
-        uses: actions/download-artifact@v2
+        uses: actions/download-artifact@v4
         with:
           path: download
 
       - name: Upload wheels
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with:
           name: grid2op-wheels
           path: |

.gitignore

@@ -416,6 +416,7 @@ getting_started/venv_310_ray/
 grid2op/tests/venv_test_autoclass/
 test_eduardo.py
 grid2op/tests/failed_test*
+venv_312
 
 # profiling files
 **.prof

CHANGELOG.rst

@@ -63,6 +63,27 @@ Next release
 - TODO in multi-mix increase the reset options with the mix the user wants
 - TODO L2RPN scores as reward (sum loads after the game over and have it in the final reward)
 - TODO on CI: test only gym, only gymnasium and keep current test for both gym and gymnasium
+- TODO work on the reward class (see https://github.com/rte-france/Grid2Op/issues/584)
+
+
+[1.10.4] - 2024-10-14
+-------------------------
+- [FIXED] an issue in the backend: if the backend failed to be
+  created the `_grid` attribute was set to `None` and not set back to
+- [FIXED] the `self.skip_if_needed()` was missing for one of the test suite.
+- [FIXED] an error in the descirption of the `educ_case14_storage` environment
+  (wrong sign for the slack generator)
+- [FIXED] the environment would not load in case of an incorrect "layout.json"
+  instead of raising a warning.
+- [FIXED] some issue with gym_compat module for "newest" version of 
+  gymnasium (1.0.0)
+- [FIXED] github ci (v1 and v2 artifact are now deprecated)
+- [ADDED] a code of conduct from github
+- [ADDED] a "CONTRIBUTING.md" files (instead of having contribution instructions 
+  in the readme)
+- [ADDED] numpy 2 support (now that pandapower allows it)
+- [IMPROVED] error message when forecasts are not correctly set-up
+
 
 [1.10.3] - 2024-07-12
 -------------------------

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contribution
+
+We welcome contributions from everyone. 
+
+If you want to contribute, a good starting point is to get in touch with us through:
+- github (discussion, issues or pull-request)
+- the project [discord](https://discord.gg/cYsYrPT)
+- mail (see current corresponding author from the grid2op package on pypi here https://pypi.org/project/Grid2Op/) 
+
+Contribution can take different forms:
+
+- reporting bugs
+- improving the documentation
+- improving the code examples (notebooks or example in the doc)
+- fixing some reported issues (for example at https://github.com/rte-france/Grid2Op/issues )
+- adding a new functionality to grid2op (or increase its speed)
+- extend grid2op 
+
+# What to do ?
+
+For smaller changes (including, but not limited to the reporting of a bug or a contribution to the explanotory notebooks or the documentations)
+a simple "pull request" with your modifications by detailing what you had in mind and the  goal of your changes.
+
+In case of a major change (or if you have a doubt on what is "a small change"), please open an issue first
+to discuss what you would like to change and then follow as closely as possible the guidelines below. This is to ensure
+first that no other contribution is this direction is being currently made but also to make sure that it 
+does not conflicts with some core ideas of the project.
+
+# Guidelines for contributing to the codebase
+
+For larger contributions, you can follow the given :
+
+1. fork the repository located at <https://github.com/rte-france/Grid2Op>
+2. synch your fork with the "latest developement branch of grid2op". For example, if the latest grid2op release
+   on pypi is `1.10.3` you need to synch your repo with the branch named `dev_1.10.4` or `dev_1.11.0` (if
+   the branch `dev_1.10.4` does not exist). It will be the highest number in the branches `dev_*` on
+   grid2op official github repository.
+3. implement your functionality / code your modifications, add documentation or any kind of contribution
+4. make sure to add tests and documentation if applicable
+5. once it is developed, synch your repo with the last development branch again (see point 2 above) and
+   make sure to solve any possible conflicts
+6. write a pull request and make sure to target the right branch (the "last development branch")
+
+# When will it be merged ?
+
+A contribution will be merged once approved by the maintainers (this is why it is recommended to first 
+get in touch with the team)
+
+Code in the contribution should pass all the current tests, have some dedicated tests for the new feature (if applicable)
+and documentation (if applicable).
+
+If you contribute to some grid2op notebooks, please make sure to "clear all outputs"
+before making the pull request.
+
+New contributions should respect the "**Code of Conduct**" of grid2op.

README.md

@@ -262,6 +262,11 @@ For example, the  "getting started" notebooks referenced some pages of the help.
 
 ## Contributing
 
+Please consult the "CONTRIBUTING.md" file for extra information. This is a summary and
+in case of conflicting instructions, follow the one given in the `CONTRIBUTING.md` file
+and discard these ones.
+
+
 We welcome contributions from everyone. They can take the form of pull requests for smaller changed.
 In case of a major change (or if you have a doubt on what is "a small change"), please open an issue first
 to discuss what you would like to change.
@@ -305,6 +310,8 @@ The complete test suit is run on linux with the latest numpy version on python 3
 
 ### Known issues
 
+
+#### Multi processing
 Due to the underlying behaviour of the "multiprocessing" package on windows based python versions,
 the "multiprocessing" of the grid2op "Runner" is not supported on windows. This might change in the future,
 but it is currently not on our priorities.
@@ -316,6 +323,11 @@ Sometimes, on some configuration (python version) we do not recommend to use gri
 If you encounter any trouble, please downgrade to pandas<2.2. This behaviour occured in our continuous 
 integration environment for python >=3.9 but could not be reproduced locally.
 
+#### python 3.11
+Some version of grid2op (*eg* 1.6.3) are not compatible with python 3.10 or 3.11.
+
+Either use python version 3.8 or 3.9 or upgrade grid2op (1.6.5 works) if that is the case.
+
 ### Perform tests locally
 
 Provided that Grid2Op is installed *from source*:

docs/conf.py

@@ -22,7 +22,7 @@
 author = 'Benjamin Donnot'
 
 # The full version, including alpha/beta/rc tags
-release = '1.10.3'
+release = '1.10.4.dev1'
 version = '1.10'
 
 

docs/data_pipeline.rst

@@ -55,9 +55,9 @@ Results are reported in the table below:
 ==============================  ================  ===================
 Method used                     memory footprint  time to perform (s)
 ==============================  ================  ===================
-Nothing (see `Basic Usage`_)    low                44.6
-set_chunk (see `Chunk size`_)   ultra low          26.8
-`MultifolderWithCache`_         high               11.0
+Nothing (see Basic Usage )       low                44.6
+set_chunk (see `Chunk size`_ )   ultra low          26.8
+`MultifolderWithCache`_          high               11.0
 ==============================  ================  ===================
 
 As you can see, the default usage uses relatively little memory but takes a while to compute (almost 45s to perform

docs/developer.rst

@@ -0,0 +1,8 @@
+.. toctree::
+    :maxdepth: 1
+
+    developer/env_content
+    developer/create_an_environment
+    developer/createbackend
+
+.. include:: final.rst

docs/create_an_environment.rst → docs/developer/create_an_environment.rst

@@ -1,8 +1,8 @@
-.. |l2rpn_case14_sandbox_layout| image:: ./img/l2rpn_case14_sandbox_layout.png
-.. |R2_full_grid| image:: ./img/R2_full_grid.png
-.. |l2rpn_neurips_2020_track1_layout| image:: ./img/l2rpn_neurips_2020_track1_layout.png
-.. |l2rpn_neurips_2020_track2_layout| image:: ./img/l2rpn_neurips_2020_track2_layout.png
-.. |l2rpn_wcci_2022_layout| image:: ./img/l2rpn_wcci_2022_layout.png
+.. |l2rpn_case14_sandbox_layout| image:: ../img/l2rpn_case14_sandbox_layout.png
+.. |R2_full_grid| image:: ../img/R2_full_grid.png
+.. |l2rpn_neurips_2020_track1_layout| image:: ../img/l2rpn_neurips_2020_track1_layout.png
+.. |l2rpn_neurips_2020_track2_layout| image:: ../img/l2rpn_neurips_2020_track2_layout.png
+.. |l2rpn_wcci_2022_layout| image:: ../img/l2rpn_wcci_2022_layout.png
 
 
 Possible workflow to create an environment from existing time series