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.4.3.tar.gz (11.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-1.4.3-py3-none-any.whl (11.8 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for CityLearn-1.4.3.tar.gz
Algorithm Hash digest
SHA256 b64d234189d9e48c703666cb4f7b76d5ccbe6da13c3dea27d97fbaa42a1d2872
MD5 67afd1c3149ac1a7ebc57c31fcd600dc
BLAKE2b-256 77540b7ebef108917e2b0ccf3eaed3a9872cd32dd8e5f0c395abc5c0196137c7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: CityLearn-1.4.3-py3-none-any.whl
  • Upload date:
  • Size: 11.8 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.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 636695864f8955bfdd434e93ca2e50e2d35820fc9b1a9509e7750d965f965e8d
MD5 e54c58d92da73a97bd4204501facfc92
BLAKE2b-256 1d0079b9a84d2a110b2526b530878e385445c6ef370f0683aabd5a8caa0f84a8

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