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.4.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.4.0-py3-none-any.whl (11.7 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: CityLearn-1.4.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.4.0.tar.gz
Algorithm Hash digest
SHA256 7861c5105253c9f6ebcf095c75a1fd37b524ce30c9ebc603751b4f54dabf28bb
MD5 d7855275bcae49d5c9878d2aea8c9265
BLAKE2b-256 a392cca7ffa1df96c72bd330f3cfcb056151f7439c120f2028631746b93cb008

See more details on using hashes here.

File details

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

File metadata

  • Download URL: CityLearn-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 11.7 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c7cae8d28335efd9cca38d68e4d217da104b8dec74c086e38b8669f59d9bcee8
MD5 4d062e3a5c9f1e6346b62b8efb66472f
BLAKE2b-256 f628273fe5e9cf3a6aab391d5027674cab55cfe23b76258a9506b8c5446fab0b

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