# CityLearn
CityLearn is an open source OpenAI Gym environment for the implementation of Multi-Agent Reinforcement Learning (RL) for building energy coordination and demand response in cities. A major challenge for RL in demand response is the ability to compare algorithm performance. Thus, CityLearn facilitates and standardizes the evaluation of RL agents such that different algorithms can be easily compared with each other.
## Environment Overview
CityLearn includes energy models of buildings and distributed energy resources (DER) including air-to-water heat pumps, electric heaters and batteries. A collection of building energy models makes up a virtual district (a.k.a neighborhood or community). In each building, space cooling, space heating and domestic hot water end-use loads may be independently satisfied through air-to-water heat pumps. Alternatively, space heating and domestic hot water loads can be satisfied through electric heaters.
## Installation
Install latest release in PyPi with `pip`:
```console
pip install CityLearn
```
## Documentation
Refer to the [docs](https://intelligent-environments-lab.github.io/CityLearn/) for documentation of the CityLearn API.
Raw data
{
"_id": null,
"home_page": "https://github.com/intelligent-environments-lab/CityLearn",
"name": "CityLearn",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Jose Ramon Vazquez-Canteli, Kingsley Nweye, Zoltan Nagy",
"author_email": "nweye@utexas.edu",
"download_url": "https://files.pythonhosted.org/packages/10/7f/11a2e3334d2d65aabdcec08fd5cbf227071ad6b51a9dcb25c07fd8781d99/CityLearn-2.1.2.tar.gz",
"platform": null,
"description": "# CityLearn\nCityLearn is an open source OpenAI Gym environment for the implementation of Multi-Agent Reinforcement Learning (RL) for building energy coordination and demand response in cities. A major challenge for RL in demand response is the ability to compare algorithm performance. Thus, CityLearn facilitates and standardizes the evaluation of RL agents such that different algorithms can be easily compared with each other.\n\n\n\n## Environment Overview\n\nCityLearn includes energy models of buildings and distributed energy resources (DER) including air-to-water heat pumps, electric heaters and batteries. A collection of building energy models makes up a virtual district (a.k.a neighborhood or community). In each building, space cooling, space heating and domestic hot water end-use loads may be independently satisfied through air-to-water heat pumps. Alternatively, space heating and domestic hot water loads can be satisfied through electric heaters.\n\n\n\n## Installation\nInstall latest release in PyPi with `pip`:\n```console\npip install CityLearn\n```\n\n## Documentation\nRefer to the [docs](https://intelligent-environments-lab.github.io/CityLearn/) for documentation of the CityLearn API.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "An open source OpenAI Gym environment for the implementation of Multi-Agent Reinforcement Learning (RL) for building energy coordination and demand response in cities.",
"version": "2.1.2",
"project_urls": {
"Homepage": "https://github.com/intelligent-environments-lab/CityLearn"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "58180b8f6e3f9a8ab6ee4e62fdcc816c931184c34bbf786713fb128e3b8f36d8",
"md5": "fedb24c02831ae1d276f6c5d92dcc87f",
"sha256": "95730b1deed73b1f5a4d17eb8334be3c99efa4aef8677822378d62d8359511dd"
},
"downloads": -1,
"filename": "CityLearn-2.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fedb24c02831ae1d276f6c5d92dcc87f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 22704138,
"upload_time": "2024-02-25T20:02:51",
"upload_time_iso_8601": "2024-02-25T20:02:51.771508Z",
"url": "https://files.pythonhosted.org/packages/58/18/0b8f6e3f9a8ab6ee4e62fdcc816c931184c34bbf786713fb128e3b8f36d8/CityLearn-2.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "107f11a2e3334d2d65aabdcec08fd5cbf227071ad6b51a9dcb25c07fd8781d99",
"md5": "a2ccaa53734b28d02f6d5c507f9247ab",
"sha256": "8634b3483a4fa580eb03f966e3c08a99816f1eda37648206633ff0f589367905"
},
"downloads": -1,
"filename": "CityLearn-2.1.2.tar.gz",
"has_sig": false,
"md5_digest": "a2ccaa53734b28d02f6d5c507f9247ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 22183423,
"upload_time": "2024-02-25T20:02:55",
"upload_time_iso_8601": "2024-02-25T20:02:55.088669Z",
"url": "https://files.pythonhosted.org/packages/10/7f/11a2e3334d2d65aabdcec08fd5cbf227071ad6b51a9dcb25c07fd8781d99/CityLearn-2.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-25 20:02:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "intelligent-environments-lab",
"github_project": "CityLearn",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"test_requirements": [],
"lcname": "citylearn"
}
JSON
