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

Uploaded Python 3

File details

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

File metadata

  • Download URL: CityLearn-2.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 427c7781c7a9b49bcc9b662b369702b0f697f62f5eb935aa15345f0f9506bc71
MD5 80e9f340ab56f753a3883984ad8bd019
BLAKE2b-256 9859bb2d9a6103a6998e0e2daebedbe51d33131a4fe740dff9173fc94eef204a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: CityLearn-2.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cbf440304cbdfde96de56dd070d2aa22bf05d0c5996be9cbea97cbfb16d1e655
MD5 b9772dfb14de2d2cfa388e5edb00e970
BLAKE2b-256 2d5a82d4bc63aed27d7ccdf38265af44d9de18834dc16726e228085813e401ef

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