Merge pull request #438 from BDonnot/bd_dev

improve "env.generate_data" function

CHANGELOG.rst

@@ -118,7 +118,9 @@ Change Log
   env backend and the obs backend.
 - [IMPROVED] the environment now called the "chronics_handler.forecast" function at most once per step.
 - [IMPROVED] make it easier to create an environment without `MultiFolder` or `MultifolderWithCache`
-
+- [IMPROVED] add the possibility to forward kwargs to chronix2grid function when calling `env.generate_data`
+- [IMPROVED] when calling `env.generate_data` an extra file (json) will be read to set default values 
+  passed to `chronix2grid.add_data`
 
 [1.8.1] - 2023-01-11
 ---------------------

grid2op/Environment/BaseEnv.py

@@ -2967,7 +2967,6 @@ def step(self, action: BaseAction) -> Tuple[BaseObservation, float, bool, dict]:
 
         except StopIteration:
             # episode is over
-            print("I got a StopIteration")
             is_done = True
 
         self._backend_action.reset()

grid2op/Environment/Environment.py

@@ -1714,7 +1714,7 @@ def get_params_for_runner(self):
         res["_is_test"] = self._is_test  # TODO not implemented !!
         return res
 
-    def generate_data(self, nb_year=1, nb_core=1, seed=None):
+    def generate_data(self, nb_year=1, nb_core=1, seed=None, **kwargs):
         """This function uses the chronix2grid package to generate more data that will then
         be available locally. You need to install it independently (see https://github.com/BDonnot/ChroniX2Grid#installation
         for more information)
@@ -1762,6 +1762,8 @@ def generate_data(self, nb_year=1, nb_core=1, seed=None):
             number of computer cores to use, by default 1.
         seed: int, optional
             If the same seed is given, then the same data will be generated.
+        **kwargs:
+            key word arguments passed to `add_data` function of `chronix2grid.grid2op_utils` module
         """
         try:
             from chronix2grid.grid2op_utils import add_data
@@ -1771,6 +1773,18 @@ def generate_data(self, nb_year=1, nb_core=1, seed=None):
                 f"Please visit https://github.com/bdonnot/chronix2grid#installation "
                 f"for further install instructions."
             ) from exc_
+        pot_file = None
+        if self.get_path_env() is not None:
+            pot_file = os.path.join(self.get_path_env(), "chronix2grid_adddata_kwargs.json")
+        if os.path.exists(pot_file) and os.path.isfile(pot_file):
+            import json
+            with open(pot_file, "r", encoding="utf-8") as f:
+                kwargs_default = json.load(f)
+            for el in kwargs_default:
+                if not el in kwargs:
+                    kwargs[el] = kwargs_default[el]
+        # TODO logger here for the kwargs used (including seed=seed, nb_scenario=nb_year, nb_core=nb_core)
         add_data(
-            env=self, seed=seed, nb_scenario=nb_year, nb_core=nb_core, with_loss=True
+            env=self, seed=seed, nb_scenario=nb_year, nb_core=nb_core,
+            **kwargs
         )