citylearn.base module

class citylearn.base.Environment(seconds_per_time_step: Optional[float] = None)[source]

Bases: object

next_time_step()[source]

Advance to next time_step value.

Notes

Override in subclass for custom implementation when advancing to next time_step.

reset()[source]

Reset environment to initial state.

Calls reset_time_step.

Notes

Override in subclass for custom implementation when reseting environment.

reset_time_step()[source]

Reset time_step to initial state.

Sets time_step to 0.

property seconds_per_time_step: float

Number of seconds in 1 time step.

property time_step: int

Current environment time step.

property uid: str

Unique environment ID.