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.0b6.tar.gz (15.5 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.0b6-py3-none-any.whl (16.0 MB view details)

Uploaded Python 3

File details

Details for the file CityLearn-2.0b6.tar.gz.

File metadata

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

File hashes

Hashes for CityLearn-2.0b6.tar.gz
Algorithm Hash digest
SHA256 5ea822c995c60d576b982f1d0ab78b66c9ff4e96090ac94fa16996101b86d1c1
MD5 84dbb961bf9c603664405f33428d6668
BLAKE2b-256 ca5f929bbf41a26c06ab30a0a2c55aa61172d82144e62cc34c85a5bf6a0e10c5

See more details on using hashes here.

File details

Details for the file CityLearn-2.0b6-py3-none-any.whl.

File metadata

  • Download URL: CityLearn-2.0b6-py3-none-any.whl
  • Upload date:
  • Size: 16.0 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.0b6-py3-none-any.whl
Algorithm Hash digest
SHA256 bce8b696ebd42152ed22f071c06c409be1727daddcb1afd1b2ce20233d712a98
MD5 c3950fe8fdea83569659871c3c427767
BLAKE2b-256 51fbef7cf60b89128547f9ffb39f31365414dd92a24d87d914ac6e748becba48

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