|
| 1 | +# Copyright (c) 2019-2023, RTE (https://www.rte-france.com) |
| 2 | +# See AUTHORS.txt |
| 3 | +# This Source Code Form is subject to the terms of the Mozilla Public License, version 2.0. |
| 4 | +# If a copy of the Mozilla Public License, version 2.0 was not distributed with this file, |
| 5 | +# you can obtain one at http://mozilla.org/MPL/2.0/. |
| 6 | +# SPDX-License-Identifier: MPL-2.0 |
| 7 | +# This file is part of Grid2Op, Grid2Op a testbed platform to model sequential decision making in power systems. |
| 8 | + |
| 9 | +import warnings |
| 10 | +import unittest |
| 11 | +import numpy as np |
| 12 | + |
| 13 | +import grid2op |
| 14 | +try: |
| 15 | + from lightsim2grid import LightSimBackend |
| 16 | + LS_AVAIL = True |
| 17 | +except ImportError: |
| 18 | + LS_AVAIL = False |
| 19 | + pass |
| 20 | +from grid2op.Environment import Environment |
| 21 | +from grid2op.Runner import Runner |
| 22 | +from grid2op.gym_compat import (GymEnv, |
| 23 | + BoxGymActSpace, |
| 24 | + BoxGymObsSpace, |
| 25 | + DiscreteActSpace, |
| 26 | + MultiDiscreteActSpace) |
| 27 | + |
| 28 | + |
| 29 | +class TestEnvironmentBasic(unittest.TestCase): |
| 30 | + def setUp(self) -> None: |
| 31 | + if not LS_AVAIL: |
| 32 | + self.skipTest("lightsim not installed") |
| 33 | + with warnings.catch_warnings(): |
| 34 | + warnings.filterwarnings("ignore") |
| 35 | + self.env = grid2op.make("l2rpn_case14_sandbox", |
| 36 | + test=True, |
| 37 | + _add_to_name=type(self).__name__, |
| 38 | + backend=LightSimBackend()) |
| 39 | + self.line_id = 3 |
| 40 | + th_lim = self.env.get_thermal_limit() * 2. # avoid all problem in general |
| 41 | + th_lim[self.line_id] /= 10. # make sure to get trouble in line 3 |
| 42 | + self.env.set_thermal_limit(th_lim) |
| 43 | + |
| 44 | + TestEnvironmentBasic._init_env(self.env) |
| 45 | + |
| 46 | + @staticmethod |
| 47 | + def _init_env(env): |
| 48 | + env.set_id(0) |
| 49 | + env.seed(0) |
| 50 | + env.reset() |
| 51 | + |
| 52 | + def tearDown(self) -> None: |
| 53 | + self.env.close() |
| 54 | + return super().tearDown() |
| 55 | + |
| 56 | + def test_right_type(self): |
| 57 | + assert isinstance(self.env, Environment) |
| 58 | + |
| 59 | + def test_ok(self): |
| 60 | + act = self.env.action_space() |
| 61 | + for i in range(10): |
| 62 | + obs_in, reward, done, info = self.env.step(act) |
| 63 | + if i < 2: # 2 : 2 full steps already |
| 64 | + assert obs_in.timestep_overflow[self.line_id] == i + 1, f"error for step {i}: {obs_in.timestep_overflow[self.line_id]}" |
| 65 | + else: |
| 66 | + # cooldown applied for line 3: |
| 67 | + # - it disconnect stuff in `self.env_in` |
| 68 | + # - it does not affect anything in `self.env_out` |
| 69 | + assert not obs_in.line_status[self.line_id] |
| 70 | + |
| 71 | + def test_reset(self): |
| 72 | + # timestep_overflow should be 0 initially even if the flow is too high |
| 73 | + obs = self.env.reset() |
| 74 | + assert obs.timestep_overflow[self.line_id] == 0 |
| 75 | + assert obs.rho[self.line_id] > 1. |
| 76 | + |
| 77 | + |
| 78 | +class TestEnvironmentBasicCpy(TestEnvironmentBasic): |
| 79 | + def setUp(self) -> None: |
| 80 | + super().setUp() |
| 81 | + init_int = self.env |
| 82 | + self.env = self.env.copy() |
| 83 | + init_int.close() |
| 84 | + |
| 85 | + |
| 86 | +class TestBasicEnvironmentRunner(unittest.TestCase): |
| 87 | + def setUp(self) -> None: |
| 88 | + TestEnvironmentBasic.setUp(self) |
| 89 | + self.max_iter = 10 |
| 90 | + |
| 91 | + def tearDown(self) -> None: |
| 92 | + self.env.close() |
| 93 | + return super().tearDown() |
| 94 | + |
| 95 | + def test_runner_can_make(self): |
| 96 | + runner = Runner(**self.env.get_params_for_runner()) |
| 97 | + env2 = runner.init_env() |
| 98 | + assert isinstance(env2, Environment) |
| 99 | + |
| 100 | + def test_runner(self): |
| 101 | + # create the runner |
| 102 | + runner_in = Runner(**self.env.get_params_for_runner()) |
| 103 | + res_in, *_ = runner_in.run(nb_episode=1, max_iter=self.max_iter, env_seeds=[0], episode_id=[0], add_detailed_output=True) |
| 104 | + res_in2, *_ = runner_in.run(nb_episode=1, max_iter=self.max_iter, env_seeds=[0], episode_id=[0]) |
| 105 | + # check correct results are obtained when agregated |
| 106 | + assert res_in[3] == 10 |
| 107 | + assert res_in2[3] == 10 |
| 108 | + assert np.allclose(res_in[2], 645.4992065) |
| 109 | + assert np.allclose(res_in2[2], 645.4992065) |
| 110 | + |
| 111 | + # check detailed results |
| 112 | + ep_data_in = res_in[-1] |
| 113 | + for i in range(self.max_iter + 1): |
| 114 | + obs_in = ep_data_in.observations[i] |
| 115 | + if i < 3: |
| 116 | + assert obs_in.timestep_overflow[self.line_id] == i, f"error for step {i}: {obs_in.timestep_overflow[self.line_id]}" |
| 117 | + else: |
| 118 | + # cooldown applied for line 3: |
| 119 | + # - it disconnect stuff in `self.env_in` |
| 120 | + # - it does not affect anything in `self.env_out` |
| 121 | + assert not obs_in.line_status[self.line_id], f"error for step {i}: line is not disconnected" |
| 122 | + |
| 123 | + |
| 124 | +class TestBasicEnvironmentGym(unittest.TestCase): |
| 125 | + def setUp(self) -> None: |
| 126 | + TestEnvironmentBasic.setUp(self) |
| 127 | + |
| 128 | + def tearDown(self) -> None: |
| 129 | + self.env.close() |
| 130 | + return super().tearDown() |
| 131 | + |
| 132 | + def _aux_run_envs(self, act, env_gym): |
| 133 | + for i in range(10): |
| 134 | + obs_in, reward, done, truncated, info = env_gym.step(act) |
| 135 | + if i < 2: # 2 : 2 full steps already |
| 136 | + assert obs_in["timestep_overflow"][self.line_id] == i + 1, f"error for step {i}: {obs_in['timestep_overflow'][self.line_id]}" |
| 137 | + else: |
| 138 | + # cooldown applied for line 3: |
| 139 | + # - it disconnect stuff in `self.env_in` |
| 140 | + # - it does not affect anything in `self.env_out` |
| 141 | + assert not obs_in["line_status"][self.line_id] |
| 142 | + |
| 143 | + def test_gym_with_step(self): |
| 144 | + """test the step function also disconnects (or not) the lines""" |
| 145 | + env_gym = GymEnv(self.env) |
| 146 | + act = {} |
| 147 | + self._aux_run_envs(act, env_gym) |
| 148 | + env_gym.reset() |
| 149 | + self._aux_run_envs(act, env_gym) |
| 150 | + |
| 151 | + def test_gym_normal(self): |
| 152 | + """test I can create the gym env""" |
| 153 | + env_gym = GymEnv(self.env) |
| 154 | + env_gym.reset() |
| 155 | + |
| 156 | + def test_gym_box(self): |
| 157 | + """test I can create the gym env with box ob space and act space""" |
| 158 | + env_gym = GymEnv(self.env) |
| 159 | + with warnings.catch_warnings(): |
| 160 | + warnings.filterwarnings("ignore") |
| 161 | + env_gym.action_space = BoxGymActSpace(self.env.action_space) |
| 162 | + env_gym.observation_space = BoxGymObsSpace(self.env.observation_space) |
| 163 | + env_gym.reset() |
| 164 | + |
| 165 | + def test_gym_discrete(self): |
| 166 | + """test I can create the gym env with discrete act space""" |
| 167 | + env_gym = GymEnv(self.env) |
| 168 | + with warnings.catch_warnings(): |
| 169 | + warnings.filterwarnings("ignore") |
| 170 | + env_gym.action_space = DiscreteActSpace(self.env.action_space) |
| 171 | + env_gym.reset() |
| 172 | + act = 0 |
| 173 | + self._aux_run_envs(act, env_gym) |
| 174 | + |
| 175 | + def test_gym_multidiscrete(self): |
| 176 | + """test I can create the gym env with multi discrete act space""" |
| 177 | + env_gym = GymEnv(self.env) |
| 178 | + with warnings.catch_warnings(): |
| 179 | + warnings.filterwarnings("ignore") |
| 180 | + env_gym.action_space = MultiDiscreteActSpace(self.env.action_space) |
| 181 | + env_gym.reset() |
| 182 | + act = env_gym.action_space.sample() |
| 183 | + act[:] = 0 |
| 184 | + self._aux_run_envs(act, env_gym) |
| 185 | + |
| 186 | + |
| 187 | +if __name__ == "__main__": |
| 188 | + unittest.main() |
0 commit comments