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

Uploaded Python 3

File details

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

File metadata

  • Download URL: CityLearn-2.0b8.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.0b8.tar.gz
Algorithm Hash digest
SHA256 f753e8699803ba7200aca425d48572f8b9b7dad785dd7a3f02d78880b6f6a42f
MD5 47ebcaaa5f708f2b982878ca77a2333c
BLAKE2b-256 88a505a295222577ead83e23797ca35b81c6962c94e8006978b95e561501e9dc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: CityLearn-2.0b8-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.0b8-py3-none-any.whl
Algorithm Hash digest
SHA256 ac97fb5fb8131d89e9fdf800bbfb35f07fc0d67ac2f66fca69d43a911bfa453b
MD5 729fa992d583b4f15a4173201249a7cf
BLAKE2b-256 6b9030f54e8bf457006f59bce122660bcc73087ce70eed8070cfe7a31e3c5a7a

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