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

Uploaded Python 3

File details

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

File metadata

  • Download URL: CityLearn-2.0b2.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.0b2.tar.gz
Algorithm Hash digest
SHA256 b6e1b0f7d4f361d53ae0bf7061319cb20e4cb0a52e191c41da7019b2db389a41
MD5 61d2d4fae3ecb5b99d948d02cdaee6c7
BLAKE2b-256 e401da64f87f0437c698c80ab5e9f8fc9d5cf9c055efb3d93898935bf85983e9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: CityLearn-2.0b2-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.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 6f986be87f63cd94393af4262a0c49f938a818ca2092b019b38427415c575b99
MD5 11a455362e2ea7265359b7f2852887a9
BLAKE2b-256 00def06115fe891916bd5e161825cb950392fbaaaed6a785b1b7e75c23c1cc27

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