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

Uploaded Python 3

File details

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

File metadata

  • Download URL: CityLearn-1.3.6.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.6.tar.gz
Algorithm Hash digest
SHA256 e20905012741550ebcfa124b6c5a87fa06a229bb341bc1e2b69e2c1c7e80d143
MD5 867e5b1fdd44ae2d305de124a60c742b
BLAKE2b-256 b4487ad50b434de6d3c5c636422ad689791776bde643aab2928efefeab1ad6f4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: CityLearn-1.3.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ff0dc23e1b714b1853a2a6fa060cd17761f798182963028b30ac976a04f8ba7d
MD5 6dce9f2790c735417994e7d2512b413a
BLAKE2b-256 315232d1099573c7c335d9613bb3a77c918493c94df5bd8c8c0b912621a9a03e

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