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

Uploaded Python 3

File details

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

File metadata

  • Download URL: CityLearn-2.1b4.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.1b4.tar.gz
Algorithm Hash digest
SHA256 c97206a12c9665756102c738467b4c9bdf0a3f4efb95b65182344df2adddda1d
MD5 07bece02d14448882a4ba6930dfa2448
BLAKE2b-256 c3d6c2c3377995807256a385a7c31b6364c6f25199eecbea8e901c5dd6411629

See more details on using hashes here.

File details

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

File metadata

  • Download URL: CityLearn-2.1b4-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.1b4-py3-none-any.whl
Algorithm Hash digest
SHA256 da0e03426c9bf69ece7dc4d7de98a5bae9955f2d16d5a1e92f8c90731c6025bd
MD5 b0c1205bd5b69ee3e63cbcf65429fea8
BLAKE2b-256 97722ade557e583197d91d3e4b2053e71ef757e78615899ee1acd8ad12121ca1

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