/beobench

A toolkit providing easy and unified access to building control environments for reinforcement learning (RL).

Primary LanguagePythonMIT LicenseMIT

Beobench

Documentation Status License

A toolkit providing easy and unified access to building control environments for reinforcement learning (RL).

Features

  • Large collection of building control environments: Out-of-the-box Beobench provides access to environments from BOPTEST, Energym, and Sinergym. By providing access to all the environments from these frameworks, Beobench is able to provide the (to the best of our knowledge) largest single collection of building control environments (see environment list here).
  • Clean and light-weight installation: Beobench is installed via pip and only requires Docker as an additional non-python dependency (see installation guide). Other packages require the user to deal with building simulator installations or manage docker images directly.
  • Built-in RL agents: Beobench allows the user to apply any agent from the Ray RLlib collection in addition to agents provided by the user directly.
  • Easily extendable: want to use Beobench with an environment not yet included? The support for user-defined Docker contexts makes it easy to use Beobench with any RL environment.

Quickstart

Run your first beobench experiment in three steps:

  1. Install docker on your machine (if on Linux, check the additional installation steps)

  2. Install beobench using:

    pip install beobench
  3. Finally, start your first experiment using:

    beobench run

Done, you have just started your first experiment... congrats! Check out the full getting started guide in the documentation for the next steps.

Documentation

https://beobench.readthedocs.io

Available environments

Gym Environment Type* Description
BOPTEST bestest_air original, beobench
  bestest_hydronic original, beobench
  bestest_hydronic_heat_pump original, beobench
  multizone_residential_hydronic original, beobench
  singlezone_commercial_hydronic original, beobench
Energym Apartments2Thermal-v0 original, beobench
  Apartments2Grid-v0 original, beobench
  ApartmentsThermal-v0 original, beobench
  ApartmentsGrid-v0 original, beobench
  OfficesThermostat-v0 original, beobench
  MixedUseFanFCU-v0 original, beobench
  SeminarcenterThermostat-v0 original, beobench
  SeminarcenterFull-v0 original, beobench
  SimpleHouseRad-v0 original, beobench
  SimpleHouseRSla-v0 original, beobench
  SwissHouseRSlaW2W-v0 original, beobench
  SwissHouseRSlaA2W-v0 original, beobench
  SwissHouseRSlaTank-v0 original, beobench
  SwissHouseRSlaTankDhw-v0 original, beobench
Sinergym Eplus-demo-v1 original, beobench
  Eplus-5Zone-hot-discrete-v1 original, beobench
  Eplus-5Zone-mixed-discrete-v1 original, beobench
  Eplus-5Zone-cool-discrete-v1 original, beobench
  Eplus-5Zone-hot-continuous-v1 original, beobench
  Eplus-5Zone-mixed-continuous-v1 original, beobench
  Eplus-5Zone-cool-continuous-v1 original, beobench
  Eplus-5Zone-hot-discrete-stochastic-v1 original, beobench
  Eplus-5Zone-mixed-discrete-stochastic-v1 original, beobench
  Eplus-5Zone-cool-discrete-stochastic-v1 original, beobench
  Eplus-5Zone-hot-continuous-stochastic-v1 original, beobench
  Eplus-5Zone-mixed-continuous-stochastic-v1 original, beobench
  Eplus-5Zone-cool-continuous-stochastic-v1 original, beobench
  Eplus-datacenter-discrete-v1 original, beobench
  Eplus-datacenter-continuous-v1 original, beobench
  Eplus-datacenter-discrete-stochastic-v1 original, beobench
  Eplus-datacenter-continuous-stochastic-v1 original, beobench
  Eplus-IWMullion-discrete-v1 original, beobench
  Eplus-IWMullion-continuous-v1 original, beobench
  Eplus-IWMullion-discrete-stochastic-v1 original, beobench
  Eplus-IWMullion-continuous-stochastic-v1 original, beobench

* Types of environments:

  • residential home
  • office office
  • data center industry

License

MIT license, see credits and license page in docs for more detailed information.