**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
=======
.. image:: https://img.shields.io/pypi/v/bauwerk.svg
:target: https://pypi.python.org/pypi/bauwerk
.. image:: https://img.shields.io/travis/rdnfn/bauwerk.svg
:target: https://travis-ci.com/rdnfn/bauwerk
.. image:: https://readthedocs.org/projects/bauwerk/badge/?version=latest
:target: https://bauwerk.readthedocs.io/en/latest/?version=latest
:alt: Documentation Status
Super simple building control environments for reinforcement learning.
* Free software: MIT license
* Documentation: https://bauwerk.readthedocs.io.
Features
--------
* TODO
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/rdnfn/bauwerk",
"name": "bauwerk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "bauwerk",
"author": "rdnfn",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f0/7a/8e1f6b00e72f2f64c2429a4a53efeccf5404053bb8ea9439044b14ffe17d/bauwerk-0.3.2.tar.gz",
"platform": null,
"description": "\n\n\n **Warning**\n \n 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.\n\n\n=======\nbauwerk\n=======\n\n\n.. image:: https://img.shields.io/pypi/v/bauwerk.svg\n :target: https://pypi.python.org/pypi/bauwerk\n\n.. image:: https://img.shields.io/travis/rdnfn/bauwerk.svg\n :target: https://travis-ci.com/rdnfn/bauwerk\n\n.. image:: https://readthedocs.org/projects/bauwerk/badge/?version=latest\n :target: https://bauwerk.readthedocs.io/en/latest/?version=latest\n :alt: Documentation Status\n\n\n\n\nSuper simple building control environments for reinforcement learning.\n\n\n* Free software: MIT license\n* Documentation: https://bauwerk.readthedocs.io.\n\n\nFeatures\n--------\n\n* TODO\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\n\n0.3.2 (2022-12-00)\n------------------\n\n* Improvements\n\n * Add information on evaluation to docs.\n\n* Fixes\n\n * Improve plotting/widget code to comply with stricter shape testing in newer matplotlib versions\n\n0.3.1 (2022-11-03)\n------------------\n\n* Features\n\n * New building distributions:\n\n * *Building Distribution C*: varies battery and solar installation size.\n * *Building Distribution D*: varies battery, solar installation and load consumption size/scale.\n * *Building distribution E*: varies same as above, and adds irreducible noise to load and solar traces.\n\n* Environment & distribution changes (*! indicates that the change may affect experimental results*)\n\n * **!** Parameter default of ``grid_peak_threshold`` changed from 4.0kW to 2.0kW in all environments, including those of building distribution B.\n * 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``.\n\n* Improvements\n\n * Update to docs on distributions, wrappers and more.\n\n0.3.0 (2022-10-26)\n------------------\n\n* Features\n\n * Add experiment script\n * Add extensive evaluation features\n * Add support for much slower speed in game widget\n * Add benchmarks\n * Add support for setting tasks in environment\n * Add wrappers:\n\n * that add task parameters to observation space.\n * that clip the reward\n * that clip the action space\n * that normalise observation space\n\n* Improvements\n\n * Add clock and day to game widget\n * Design improvements for game widget\n * Action spaces dtype can now be set in env cfg\n\n\n0.2.1 (2022-09-12)\n------------------\n\n* Features\n\n * Add ``time_of_day`` variable to observation space.\n\n* Improvements\n\n * The ``solve`` function is now directly imported with ``bauwerk``, to simplify usage.\n * Additional sections added to documentation.\n * Add more grid parameters to ``SolarBatteryHouseEnv`` configuration.\n\n* Fixes:\n\n * Ensure solver outputs actions that are valid in environment (i.e. normalised)\n\n0.2.0 (2022-09-09)\n------------------\n\n* Features:\n\n * Add game widget based on ``SolarBatteryHouseEnv``.\n\n * Includes browser-based version of Bauwerk game that can be played by anybody without installing anything.\n\n * Add support for selling to the grid in ``SolarBatteryHouseEnv``.\n\n* Improvements:\n\n * Add explicit CVXPY-based solver in ``bauwerk.envs.solvers`` for ``SolarBatteryHouseEnv`` that was missing earlier.\n * Update ``SolarBatteryHouseEnv`` to comply with new gym step API by returning ``truncated`` value.\n * Add automatic github-actions-based testing of package.\n\n\n0.1.0 (2022-08-12)\n------------------\n\n* First release on PyPI.\n\n* Features:\n\n * ``SolarBatteryHouseEnv``: a simple environment representing a single family home with a solar photovoltaic installations and a home battery that can be controlled.\n * Optional integration with CVXPY to compute optimal actions in Bauwerk environments.\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Simple building control environments for reinforcement learning.",
"version": "0.3.2",
"split_keywords": [
"bauwerk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b04da5d7f63262fb8a10208124b9151153e5a91b94415f68f04f930cdc6c5009",
"md5": "71d66f10521cd67404835e226e24d45d",
"sha256": "2c10661030182d987c2865d09f8801a3704fa1800e67a84e2250d2d6477687d1"
},
"downloads": -1,
"filename": "bauwerk-0.3.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "71d66f10521cd67404835e226e24d45d",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 220005,
"upload_time": "2023-01-19T09:32:34",
"upload_time_iso_8601": "2023-01-19T09:32:34.534319Z",
"url": "https://files.pythonhosted.org/packages/b0/4d/a5d7f63262fb8a10208124b9151153e5a91b94415f68f04f930cdc6c5009/bauwerk-0.3.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f07a8e1f6b00e72f2f64c2429a4a53efeccf5404053bb8ea9439044b14ffe17d",
"md5": "ca32932164757508f7a78cada6fa0b9f",
"sha256": "d5b2ba2946adbdaed26d95f3ae3368c79790e3c1518bacced4f1fbdebfe2b5bd"
},
"downloads": -1,
"filename": "bauwerk-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "ca32932164757508f7a78cada6fa0b9f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 697933,
"upload_time": "2023-01-19T09:32:36",
"upload_time_iso_8601": "2023-01-19T09:32:36.364084Z",
"url": "https://files.pythonhosted.org/packages/f0/7a/8e1f6b00e72f2f64c2429a4a53efeccf5404053bb8ea9439044b14ffe17d/bauwerk-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-19 09:32:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "rdnfn",
"github_project": "bauwerk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "bauwerk"
}
JSON
