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

Uploaded Python 3

File details

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

File metadata

  • Download URL: CityLearn-1.3.5.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.5.tar.gz
Algorithm Hash digest
SHA256 de68d3dbf2a0b06241157af6751256d50e70ae70548f1ba6f6d5da638d38ac96
MD5 24481326c93eeea41b6974208302ea77
BLAKE2b-256 217b474b343c855c590b159aa41f641f7057720b7de487b01595f2e5f2c8e822

See more details on using hashes here.

File details

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

File metadata

  • Download URL: CityLearn-1.3.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4628bcbc25fc35131c84b82624ef41ff7642d921095c2bc4e5df2fcba86b90f8
MD5 a827510d207417e3fa8c0a9e8525f429
BLAKE2b-256 a6db1dd2c27d38150a98f3ba5e1b6b25d7a89d393e507edc3979f22bf760bd75

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