Skip to main content

An open source OpenAI Gym environment for the implementation of Multi-Agent Reinforcement Learning (RL) for building energy coordination and demand response in cities.

Project description

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.

Demand-response

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.

Citylearn

Installation

Install latest release in PyPi with pip:

pip install CityLearn

Documentation

Refer to the docs for documentation of the CityLearn API.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

CityLearn-2.0b4.tar.gz (15.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

CityLearn-2.0b4-py3-none-any.whl (16.0 MB view details)

Uploaded Python 3

File details

Details for the file CityLearn-2.0b4.tar.gz.

File metadata

  • Download URL: CityLearn-2.0b4.tar.gz
  • Upload date:
  • Size: 15.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.7

File hashes

Hashes for CityLearn-2.0b4.tar.gz
Algorithm Hash digest
SHA256 cf51b5f31b0ee5185207dbaed8b647550b558cbefa1b8a3682ffde45b0186875
MD5 20f0c2f4bebc335677621c484a62d5fc
BLAKE2b-256 3c213b7342ce37990f4d0d2d9d3de441448edb3fd93252217c37958328b3680d

See more details on using hashes here.

File details

Details for the file CityLearn-2.0b4-py3-none-any.whl.

File metadata

  • Download URL: CityLearn-2.0b4-py3-none-any.whl
  • Upload date:
  • Size: 16.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.7

File hashes

Hashes for CityLearn-2.0b4-py3-none-any.whl
Algorithm Hash digest
SHA256 0917d069bc7321e39e1234c13e611247203cbcf008a895793ce858e081f74b80
MD5 87b6470a6b23f9974e2534e7c0d96ebe
BLAKE2b-256 2a25b8b204dbedebb84fa919625d460a0459c1adbca8b03e3f047ea9aff61373

See more details on using hashes here.

Supported by

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