smartgrid.scenarii.small_daily_scenario¶
- smartgrid.scenarii.small_daily_scenario(max_step: int | None = 10000)[source]¶
A scenario with a small neighborhood and daily profiles of consumption.
Small refers to: 20 Households, 5 Offices, and 1 School. Daily means that the consumption profiles are aggregated over a single day, and provide data for each hour of this “average day”. It contains fewer changes than the “full” dataset (annual), e.g., no seasonal change.
It uses the OpenEI dataset of profiles, and the Adaptability3 reward function.
- Parameters:
max_step – The maximal number of time steps that the simulation should run for. By default, we assume 10,000 time steps, which can be quite long but provide enough data. It can also be set to None to let the interaction loop control when to stop (warning: the environment will never stop by itself in this case! Do not use the done value to avoid running an infinite loop!).
- Returns:
An environment pre-configured and ready to use (except for the reset call!).
- Return type: