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

Uploaded Python 3

File details

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

File metadata

  • Download URL: CityLearn-2.0b9.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.0b9.tar.gz
Algorithm Hash digest
SHA256 1b3fa0815339683dd56d68bb2c643525b78925da4f319f6db661cde959ebf25e
MD5 6f3aedd8b2fc067af76f4e291155fa97
BLAKE2b-256 36a696713ede79d2d546ccee1d507a38425ed0be12deeb0d08e5e944d3077e74

See more details on using hashes here.

File details

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

File metadata

  • Download URL: CityLearn-2.0b9-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.0b9-py3-none-any.whl
Algorithm Hash digest
SHA256 b88bec5806e5678a751b7587282eafb0c45b6ccc28e901e9e9061e5d71bc3710
MD5 2143d052f63fca6dc5bf49d15e3e0963
BLAKE2b-256 5f6f175760569e572d5186794a6a978b0d625162b933843ddd1d55ba7730ed82

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