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 facilitiate 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 with pip:

pip install git+https://github.com/intelligent-environments-lab/CityLearn.git@citylearn_2022

API 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.2.0.tar.gz (11.4 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.2.0-py3-none-any.whl (11.6 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for CityLearn-1.2.0.tar.gz
Algorithm Hash digest
SHA256 9b9476e7c09e39e1e293c79dc5163c6f10974bda82370f730b8b0a294564573e
MD5 5ea32f99cf727dcd38460774d612bd58
BLAKE2b-256 0661b32e918e51bf57857dff40371acb8d577474f2017470cd1b54a947873299

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for CityLearn-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 65eb8986bd4ed2e504cbb2a815a3cae15829951ea633d71a5863707c5b1ee1ad
MD5 583a1e72c134f4a31e96e839729396e7
BLAKE2b-256 682b98361d054db59d09d2375004df4b109c12043fd8ea6744609fd14eef8825

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