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

Uploaded Python 3

File details

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

File metadata

  • Download URL: CityLearn-1.3.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.3.0.tar.gz
Algorithm Hash digest
SHA256 32ca905e607ce25ad9ad94b5434520954c53e75bce4f4ef2d005040bad44064e
MD5 15ebd58f4ee77b3c9be1d14a4f9550e2
BLAKE2b-256 d0c14a3ce9e787078b28905365c5056eeb41f2ad1fae679d48b853b3e8e453f2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: CityLearn-1.3.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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec9055ff9b57968c0e4240f3c222c98b5f19fd16feb7bb0b794c31469d7ea66c
MD5 e4fca9e8a82af3aab67c3fbe3437afd7
BLAKE2b-256 cc504ad1a48b95b694e997177be9f5a0b9ef50f834d823ff414faee0cf69ee7b

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