Skip to main content

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.2 (2022-12-00)

  • Improvements

    • Add information on evaluation to docs.

  • Fixes

    • Improve plotting/widget code to comply with stricter shape testing in newer matplotlib versions

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.

Metadata

Release files for bauwerk 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bauwerk 0.3.2
File Size Uploaded Provenance Actions
bauwerk-0.3.2.tar.gz 697.9 kB Without provenance Details for bauwerk-0.3.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for bauwerk 0.3.2
File Interpreter ABI Platform Actions
bauwerk-0.3.2-py2.py3-none-any.whl Python 3, Python 2 none any Details for bauwerk-0.3.2-py2.py3-none-any.whl

Total release size: 917.9 kB

Release files / bauwerk-0.3.2.tar.gz

Download URL bauwerk-0.3.2.tar.gz
Size 697.9 kB
Tags Source
SHA-256 checksum
How to use checksums
d5b2ba2946adbdaed26d95f3ae3368c79790e3c1518bacced4f1fbdebfe2b5bd
BLAKE2b-256 checksum
How to use checksums
f07a8e1f6b00e72f2f64c2429a4a53efeccf5404053bb8ea9439044b14ffe17d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.1

Release files / bauwerk-0.3.2-py2.py3-none-any.whl

Download URL bauwerk-0.3.2-py2.py3-none-any.whl
Size 220.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
2c10661030182d987c2865d09f8801a3704fa1800e67a84e2250d2d6477687d1
BLAKE2b-256 checksum
How to use checksums
b04da5d7f63262fb8a10208124b9151153e5a91b94415f68f04f930cdc6c5009
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.1

Security for bauwerk 0.3.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page