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
citylearn package
Subpackages
citylearn.agents package
citylearn.end_use_load_profiles package
citylearn.internal package
citylearn.utils package
Submodules
The CityLearn Challenge
Project
Publications and applications
References
Contributing
Developer Guide
Publishing Guide
Releases
CityLearn
citylearn
citylearn package
citylearn.utils package
citylearn.utils.paths module
Edit on GitHub
citylearn.utils.paths module