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.5.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.5.0-py3-none-any.whl (15.3 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: CityLearn-1.5.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.5.0.tar.gz
Algorithm Hash digest
SHA256 c2ebe04ee4aa689914436fea6270017de767788cd0f4bb9e9b290e27d6798bfb
MD5 c9754b34ac30051a9a63c23f01462572
BLAKE2b-256 a570a35e463863375f82199a12107a164a9c3a7cf1bca1dc32f96aef6963a113

See more details on using hashes here.

File details

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

File metadata

  • Download URL: CityLearn-1.5.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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5ab87eeb2ef4f4d104204f9ab9aecef8faa506127b1c63e2dc6541efe7c9ecfb
MD5 21f5948606a9c3199e6d2410dff556f0
BLAKE2b-256 80dd4d9166b893d80b74b81a61713e7d0d892e04339b020d51c5ecda5d373f18

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