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

Uploaded Python 3

File details

Details for the file CityLearn-2.1b7.tar.gz.

File metadata

  • Download URL: CityLearn-2.1b7.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.1b7.tar.gz
Algorithm Hash digest
SHA256 3998edc5d2902f4f39103a4d0d30249af9ee8a73e6855817ea7a109443ff2bb5
MD5 a051d8774949c5ec1cf83107351ced9f
BLAKE2b-256 f35db696c0623ff4482518f379d070f4eb043f11019695eb5c516c0e968e2843

See more details on using hashes here.

File details

Details for the file CityLearn-2.1b7-py3-none-any.whl.

File metadata

  • Download URL: CityLearn-2.1b7-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.1b7-py3-none-any.whl
Algorithm Hash digest
SHA256 8ccb14a3e9532a0d22ad111926e51bdf561cb6601f330a164b47ff5878b495cc
MD5 9264ccdee684301503c1c30842a79309
BLAKE2b-256 95a7d2a4fdffc5e5cc053ece1d279e5b8a3380e6e53a71fff48ef2e996dceebf

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