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
  • Edit on GitHub

citylearn.utils package

File, path and noise helpers shipped with the simulator distribution.

Submodules

  • citylearn.utils.file_handler module
    • FileHandler
      • FileHandler.join_url()
      • FileHandler.read_json()
      • FileHandler.read_pickle()
      • FileHandler.read_yaml()
      • FileHandler.resolve_schema_root()
      • FileHandler.write_json()
      • FileHandler.write_pickle()
      • FileHandler.write_yaml()
  • citylearn.utils.noise module
    • Noise
      • Noise.generate_gaussian_noise()
      • Noise.generate_scaled_noise()
  • citylearn.utils.paths module
Previous Next

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

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