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. Its objective is to facilitate and standardize the evaluation of RL agents such that different algorithms can be easily compared with each other.

Demand-response

Description

Districts and cities have periods of high demand for electricity, which raise electricity prices and the overall cost of the power distribution networks. Flattening, smoothening, and reducing the overall curve of electrical demand helps reduce operational and capital costs of electricity generation, transmission, and distribution networks. Demand response is the coordination of electricity consuming agents (i.e. buildings) in order to reshape the overall curve of electrical demand.

Citylearn

CityLearn allows the easy implementation of reinforcement learning agents in a multi-agent setting to reshape their aggregated curve of electrical demand by controlling the storage of energy by every agent. Currently, CityLearn allows controlling the storage of domestic hot water (DHW), chilled water (for sensible cooling and dehumidification) hot water (for sensible heating) and electricity. CityLearn also includes models of air-to-water heat pumps, electric heaters, solar photovoltaic arrays, and the pre-computed energy loads of the buildings, which include space cooling, dehumidification, appliances, DHW, and solar generation.

Installation

Install latest release in PyPi with pip:

pip install CityLearn

Documentation

Refer to the docs for documentation of the CityLearn API.

The CityLearn Challenge

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-1.6.0.tar.gz (14.8 MB view details)

Uploaded Source

Built Distribution

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

CityLearn-1.6.0-py3-none-any.whl (15.3 MB view details)

Uploaded Python 3

File details

Details for the file CityLearn-1.6.0.tar.gz.

File metadata

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

File hashes

Hashes for CityLearn-1.6.0.tar.gz
Algorithm Hash digest
SHA256 55c9cf545da2260d30a9793af65365a38ed297312f5d1574015b704ad32b342c
MD5 244c93c3a00651b1aa2ee4382a775ff3
BLAKE2b-256 a4bec96a2c82916ecfe816efb1add9d0dd5bf0044733e9c8977080ec4bb849b2

See more details on using hashes here.

File details

Details for the file CityLearn-1.6.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for CityLearn-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f14bba2345c638278f761ee9a2b3ab63641ea8f50b745321eed459b68cc49e00
MD5 170d5a9ce35bfeb9f11cc63d269b6ecb
BLAKE2b-256 b02d229cd3239963fe075dd80db6f2b8884cdacba8f6007b53c968e471ae14fb

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