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
  • Overview: module code

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.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.internal.baseline
  • citylearn.internal.building_ops
  • citylearn.internal.demand_response
  • citylearn.internal.entity_interface
  • citylearn.internal.kpi
  • citylearn.internal.loading
  • citylearn.internal.physics_invariants
  • citylearn.internal.robustness
  • citylearn.internal.runtime
  • citylearn.internal.topology
  • citylearn.internal.units
  • citylearn.multi_community
  • citylearn.occupant
  • citylearn.power_outage
  • citylearn.preprocessing
  • citylearn.reward_function
  • citylearn.rl
  • citylearn.utilities
  • citylearn.wrappers

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

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