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.3.4.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.3.4-py3-none-any.whl (11.6 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: CityLearn-1.3.4.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.3.4.tar.gz
Algorithm Hash digest
SHA256 2b83fc30f86839afa68806a5eb5a9a8eff7420d35f65b182060d4612c7f502c1
MD5 04f18242c7fc9dba1e1b8c4638fd46e6
BLAKE2b-256 cb7f453d7fb731a0068b26dbbfabd4767d7bf8fed42f0bfa63ac76cd2eae1a23

See more details on using hashes here.

File details

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

File metadata

  • Download URL: CityLearn-1.3.4-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.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e389ef8e52bd2f8a743ccfc157205b79388dcecc9b9a8afe5a4d14d527abb944
MD5 1aee5b32ce72d822fc93fc9a980f2fa7
BLAKE2b-256 a5c32e5d00b9b9dcc0e6c745753406ddc2bec2dce60fefe43e5f81327ce7d453

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