CityLearn

Getting started

  • Installation
  • Your first simulation
  • Features and configuration
  • Moving an existing project to CityLearn v3

Configure and run

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

Evaluate

  • Baselines
  • KPIs
  • How to read the scorecard
  • Default scorecard KPI names
  • KPIs Reference
  • KPI v2 Naming Tree

Visualize

  • CityLearn UI

Concepts and tutorials

  • Core concepts
  • Examples and tutorials
  • Command Line Interface
  • Python API
  • The CityLearn Challenge

Project

  • Publications and applications
  • References
  • Contributing
  • Developer Guide
  • Publishing Guide
  • Releases
CityLearn
  • Search

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

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