Merge remote-tracking branch 'upstream/dev_1.11.0' into dev-switches

.github/workflows/main.yml

@@ -43,6 +43,11 @@ jobs:
             abi: cp312,
             version: '3.12',
           }
+          # - {
+          #   name: cp313,   # issue with pandapower atm
+          #   abi: cp313,
+          #   version: '3.13',
+          # }
 
     steps:
 
@@ -121,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
 

CHANGELOG.rst

@@ -84,7 +84,7 @@ Native multi agents support:
 - cf ad-hoc branch (dev-multiagents)
 
 
-[1.10.4] - 2024-xx-yy
+[1.10.4] - 2024-10-14
 -------------------------
 - [FIXED] an issue in the backend: if the backend failed to be copied
   created the `_grid` attribute was set to `None` and not set back to
@@ -99,9 +99,15 @@ Native multi agents support:
   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
 - [IMPROVED] an error message when loading a grid with forecasts
 
+
 [1.10.3] - 2024-07-12
 -------------------------
 - [BREAKING] `env.chronics_hander.set_max_iter(xxx)` is now a private function. Use 

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.

Dockerfile

@@ -35,7 +35,7 @@ WORKDIR /Grid2Op
 RUN git pull
 RUN git remote update
 RUN git fetch --all --tags
-RUN git checkout "tags/v1.10.3" -b "v1.10.3-branch"
+RUN git checkout "tags/v1.10.4" -b "v1.10.4-branch"
 # Install Dependencies
 RUN pip3 install .[optional,challenge]
 WORKDIR /

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.

docs/conf.py

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

grid2op/Episode/CompactEpisodeData.py

@@ -95,9 +95,11 @@ def __init__(self, env, obs, exp_dir, ep_id:str=None):
         """
         if exp_dir is not None:
             self.exp_dir = p(exp_dir)
+            self.exp_dir = self.exp_dir / "CompactEpisodeData"
+            self.exp_dir.mkdir(parents=False, exist_ok=True)
         else:
             self.exp_dir = None
-        self.array_names = ("actions", "env_actions", "attacks", "observations", "rewards", "other_rewards", "disc_lines", "times")
+        self.array_names = ("actions", "env_actions", "attacks", "observations", "rewards", "other_rewards", "disc_lines", "times", "legal", "ambiguous")
         self.space_names = ("observation_space", "action_space", "attack_space", "env_modification_space")
         if ep_id is None:
             self.ep_id = env.chronics_handler.get_name()

grid2op/Runner/runner.py

@@ -1728,7 +1728,7 @@ def run(
                     )
                 else:
                     if add_detailed_output and (_IS_WINDOWS or _IS_MACOS):
-                        self.logger.warn(
+                        self.logger.warning(
                             "Parallel run are not fully supported on windows or macos when "
                             '"add_detailed_output" is True. So we decided '
                             "to fully deactivate them."

grid2op/__init__.py

@@ -11,7 +11,7 @@
 Grid2Op
 
 """
-__version__ = '1.10.4.dev1'
+__version__ = '1.10.4'
 
 __all__ = [
     "Action",

grid2op/data_test/runner_data/res_agent_1.10.4/00/_parameters.json

@@ -0,0 +1,24 @@
+{
+    "ACTIVATE_STORAGE_LOSS": true,
+    "ALARM_BEST_TIME": 12,
+    "ALARM_WINDOW_SIZE": 12,
+    "ALERT_TIME_WINDOW": 12,
+    "ALLOW_DISPATCH_GEN_SWITCH_OFF": true,
+    "ENV_DC": false,
+    "FORECAST_DC": false,
+    "HARD_OVERFLOW_THRESHOLD": 2.0,
+    "IGNORE_INITIAL_STATE_TIME_SERIE": 0,
+    "IGNORE_MIN_UP_DOWN_TIME": true,
+    "INIT_STORAGE_CAPACITY": 0.5,
+    "LIMIT_INFEASIBLE_CURTAILMENT_STORAGE_ACTION": false,
+    "MAX_LINE_STATUS_CHANGED": 1,
+    "MAX_SIMULATE_PER_EPISODE": -1,
+    "MAX_SIMULATE_PER_STEP": -1,
+    "MAX_SUB_CHANGED": 1,
+    "NB_TIMESTEP_COOLDOWN_LINE": 0,
+    "NB_TIMESTEP_COOLDOWN_SUB": 0,
+    "NB_TIMESTEP_OVERFLOW_ALLOWED": 2,
+    "NB_TIMESTEP_RECONNECTION": 10,
+    "NO_OVERFLOW_DISCONNECTION": false,
+    "SOFT_OVERFLOW_THRESHOLD": 1.0
+}

grid2op/data_test/runner_data/res_agent_1.10.4/00/episode_meta.json

@@ -0,0 +1,11 @@
+{
+    "agent_seed": null,
+    "backend_type": "PandaPowerBackend_rte_case5_example",
+    "chronics_max_timestep": "100",
+    "chronics_path": "/home/donnotben/Documents/grid2op_dev/grid2op/data/rte_case5_example/chronics/00",
+    "cumulative_reward": 35.87366485595703,
+    "env_seed": null,
+    "env_type": "Environment_rte_case5_example",
+    "grid_path": "/home/donnotben/Documents/grid2op_dev/grid2op/data/rte_case5_example/grid.json",
+    "nb_timestep_played": 7
+}

grid2op/data_test/runner_data/res_agent_1.10.4/00/episode_times.json

@@ -0,0 +1,12 @@
+{
+    "Agent": {
+        "total": 0.00021775700224679895
+    },
+    "Env": {
+        "apply_act": 0.025833767002040986,
+        "observation_computation": 0.00829864700062899,
+        "powerflow_computation": 0.20847854800376808,
+        "total": 0.24261096200643806
+    },
+    "total": 0.24721698199937236
+}

grid2op/data_test/runner_data/res_agent_1.10.4/00/grid2op.info

@@ -0,0 +1,3 @@
+{
+    "version": "1.10.4"
+}

grid2op/data_test/runner_data/res_agent_1.10.4/00/other_rewards.json

@@ -0,0 +1,9 @@
+[
+    {},
+    {},
+    {},
+    {},
+    {},
+    {},
+    {}
+]

grid2op/data_test/runner_data/res_agent_1.10.4/01/_parameters.json

@@ -0,0 +1,24 @@
+{
+    "ACTIVATE_STORAGE_LOSS": true,
+    "ALARM_BEST_TIME": 12,
+    "ALARM_WINDOW_SIZE": 12,
+    "ALERT_TIME_WINDOW": 12,
+    "ALLOW_DISPATCH_GEN_SWITCH_OFF": true,
+    "ENV_DC": false,
+    "FORECAST_DC": false,
+    "HARD_OVERFLOW_THRESHOLD": 2.0,
+    "IGNORE_INITIAL_STATE_TIME_SERIE": 0,
+    "IGNORE_MIN_UP_DOWN_TIME": true,
+    "INIT_STORAGE_CAPACITY": 0.5,
+    "LIMIT_INFEASIBLE_CURTAILMENT_STORAGE_ACTION": false,
+    "MAX_LINE_STATUS_CHANGED": 1,
+    "MAX_SIMULATE_PER_EPISODE": -1,
+    "MAX_SIMULATE_PER_STEP": -1,
+    "MAX_SUB_CHANGED": 1,
+    "NB_TIMESTEP_COOLDOWN_LINE": 0,
+    "NB_TIMESTEP_COOLDOWN_SUB": 0,
+    "NB_TIMESTEP_OVERFLOW_ALLOWED": 2,
+    "NB_TIMESTEP_RECONNECTION": 10,
+    "NO_OVERFLOW_DISCONNECTION": false,
+    "SOFT_OVERFLOW_THRESHOLD": 1.0
+}