CityLearn

Getting started

  • Installation
  • Your first simulation
  • Glossary
  • Core concepts
  • Features and configuration

Configure and run

  • Running Simulations
  • Dataset catalogue
  • Schema Reference
  • Dataset Reference
  • Portugal REC Datasets
  • Data Unit Contract
  • Flat and Entity Interfaces
  • Observations Reference
  • Actions Reference
  • Multi-Community Reference
  • Robustness Reference

Evaluate

  • Baselines
  • KPIs

Visualize

  • CityLearn UI

Tutorials and reference

  • Examples and tutorials
  • Command Line Interface
  • Python API

Project

  • Publications and applications
  • References
  • Contributing
  • Moving an existing project to CityLearn v3
  • Validation and performance
  • Developer Guide
  • Publishing CityLearn
  • Releases
  • Earlier releases

History

  • The CityLearn Challenge
CityLearn
  • Overview: module code

This documentation is built from the development branch, master. It includes the changes listed under Unreleased, which the latest release, CityLearn 3.6.0, does not have. To read the documentation of the version you installed (pip show citylearn), open the docs folder at its tag on GitHub, for example v3.6.0.

All modules for which code is available

  • citylearn.agents.base
  • citylearn.agents.baseline
  • citylearn.agents.marlisa
  • citylearn.agents.q_learning
  • citylearn.agents.rbc
  • citylearn.agents.rlc
  • citylearn.agents.sac
  • citylearn.base
  • citylearn.building
  • citylearn.citylearn
  • citylearn.community_dataset
  • citylearn.cost_function
  • citylearn.data
  • citylearn.dynamics
  • citylearn.electric_vehicle
  • citylearn.electric_vehicle_charger
  • citylearn.end_use_load_profiles.clustering
  • citylearn.end_use_load_profiles.lstm_model.model
  • citylearn.end_use_load_profiles.lstm_model.model_generation
  • citylearn.end_use_load_profiles.lstm_model.model_generation_wrapper
  • citylearn.end_use_load_profiles.lstm_model.preprocessing
  • citylearn.end_use_load_profiles.neighborhood
  • citylearn.end_use_load_profiles.simulate
  • citylearn.energy_model
  • citylearn.exporter
  • citylearn.multi_community
  • citylearn.occupant
  • citylearn.power_outage
  • citylearn.preprocessing
  • citylearn.random_streams
  • citylearn.reward_function
  • citylearn.rl
  • citylearn.utilities
  • citylearn.utils.file_handler
  • citylearn.utils.noise
  • citylearn.wrappers

© Copyright 2023, Jose Ramon Vazquez-Canteli, Kingsley Nweye, Zoltan Nagy.

Built with Sphinx using a theme provided by Read the Docs.