Skip to main content

Simple building control environments for reinforcement learning.

Project description

Warning

Bauwerk is in a very early stage of development, not stable at the moment and not recommended for general usage at this point. Use at your own risk.

bauwerk

https://img.shields.io/pypi/v/bauwerk.svg https://img.shields.io/travis/rdnfn/bauwerk.svg Documentation Status

Super simple building control environments for reinforcement learning.

Features

  • TODO

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.3.1 (2022-11-03)

  • Features

    • New building distributions:

      • Building Distribution C: varies battery and solar installation size.

      • Building Distribution D: varies battery, solar installation and load consumption size/scale.

      • Building distribution E: varies same as above, and adds irreducible noise to load and solar traces.

  • Environment & distribution changes (! indicates that the change may affect experimental results)

    • ! Parameter default of grid_peak_threshold changed from 4.0kW to 2.0kW in all environments, including those of building distribution B.

    • The load and solar traces in HouseEnv now can be augmented with irreducible noise. This is set via the solar/load_noise_magnitude parameter of the EnvConfig.

  • Improvements

    • Update to docs on distributions, wrappers and more.

0.3.0 (2022-10-26)

  • Features

    • Add experiment script

    • Add extensive evaluation features

    • Add support for much slower speed in game widget

    • Add benchmarks

    • Add support for setting tasks in environment

    • Add wrappers:

      • that add task parameters to observation space.

      • that clip the reward

      • that clip the action space

      • that normalise observation space

  • Improvements

    • Add clock and day to game widget

    • Design improvements for game widget

    • Action spaces dtype can now be set in env cfg

0.2.1 (2022-09-12)

  • Features

    • Add time_of_day variable to observation space.

  • Improvements

    • The solve function is now directly imported with bauwerk, to simplify usage.

    • Additional sections added to documentation.

    • Add more grid parameters to SolarBatteryHouseEnv configuration.

  • Fixes:

    • Ensure solver outputs actions that are valid in environment (i.e. normalised)

0.2.0 (2022-09-09)

  • Features:

    • Add game widget based on SolarBatteryHouseEnv.

      • Includes browser-based version of Bauwerk game that can be played by anybody without installing anything.

    • Add support for selling to the grid in SolarBatteryHouseEnv.

  • Improvements:

    • Add explicit CVXPY-based solver in bauwerk.envs.solvers for SolarBatteryHouseEnv that was missing earlier.

    • Update SolarBatteryHouseEnv to comply with new gym step API by returning truncated value.

    • Add automatic github-actions-based testing of package.

0.1.0 (2022-08-12)

  • First release on PyPI.

  • Features:

    • SolarBatteryHouseEnv: a simple environment representing a single family home with a solar photovoltaic installations and a home battery that can be controlled.

    • Optional integration with CVXPY to compute optimal actions in Bauwerk environments.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bauwerk-0.3.1.tar.gz (696.0 kB view details)

Uploaded Source

Built Distribution

bauwerk-0.3.1-py2.py3-none-any.whl (218.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file bauwerk-0.3.1.tar.gz.

File metadata

  • Download URL: bauwerk-0.3.1.tar.gz
  • Upload date:
  • Size: 696.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for bauwerk-0.3.1.tar.gz
Algorithm Hash digest
SHA256 4dd5cb84239a5def1c718ff9e7f6c3da435463010137c62e408fbb47aebd187f
MD5 3a16ad52e9faab616659e07a9ff99469
BLAKE2b-256 c2d591a85e2d2876f5b45e20e94e42d42395e9ac8cca795f1a2c3b356a3ff6b4

See more details on using hashes here.

File details

Details for the file bauwerk-0.3.1-py2.py3-none-any.whl.

File metadata

  • Download URL: bauwerk-0.3.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 218.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for bauwerk-0.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b8f7069e03ed0e97528d595f03949affad169300a0e6b9fb64a45fbf122aecc2
MD5 a15c3a8e018fa13f81ae0cda798ff85d
BLAKE2b-256 01ab89f7159b5a73cd93258d2f5b8aa47d49e6eb38062a04a47be0e7071612c4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page