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. A major challenge for RL in demand response is the ability to compare algorithm performance. Thus, CityLearn facilitates and standardizes the evaluation of RL agents such that different algorithms can be easily compared with each other.

Demand-response

Environment Overview

CityLearn includes energy models of buildings and distributed energy resources (DER) including air-to-water heat pumps, electric heaters and batteries. A collection of building energy models makes up a virtual district (a.k.a neighborhood or community). In each building, space cooling, space heating and domestic hot water end-use loads may be independently satisfied through air-to-water heat pumps. Alternatively, space heating and domestic hot water loads can be satisfied through electric heaters.

Citylearn

Installation

Install latest release in PyPi with pip:

pip install CityLearn

Documentation

Refer to the docs for documentation of the CityLearn API.

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-2.1.2.tar.gz (22.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

CityLearn-2.1.2-py3-none-any.whl (22.7 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: CityLearn-2.1.2.tar.gz
  • Upload date:
  • Size: 22.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.7

File hashes

Hashes for CityLearn-2.1.2.tar.gz
Algorithm Hash digest
SHA256 8634b3483a4fa580eb03f966e3c08a99816f1eda37648206633ff0f589367905
MD5 a2ccaa53734b28d02f6d5c507f9247ab
BLAKE2b-256 107f11a2e3334d2d65aabdcec08fd5cbf227071ad6b51a9dcb25c07fd8781d99

See more details on using hashes here.

File details

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

File metadata

  • Download URL: CityLearn-2.1.2-py3-none-any.whl
  • Upload date:
  • Size: 22.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.7

File hashes

Hashes for CityLearn-2.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 95730b1deed73b1f5a4d17eb8334be3c99efa4aef8677822378d62d8359511dd
MD5 fedb24c02831ae1d276f6c5d92dcc87f
BLAKE2b-256 58180b8f6e3f9a8ab6ee4e62fdcc816c931184c34bbf786713fb128e3b8f36d8

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