Welcome to UrbanHeatOpt!

Here you can find a complete documentation of the use of UrbanHeatOpt: A Software Framework for Supporting Municipal Heat Transition Planning. For more details please go to the following sections.

Contents:

• Introduction
  • Overview
• Quickstart
  • Environment Setup
  • Requirements
  • Running the Code
  • Using the Functions in a Python Script
• Project Structure and Settings
  • Organizational Structure: Case Studies and Scenarios
  • Folder Structure
  • Project Structure
  • Settings and Input Parameters
  • Using the Solver
  • Optimization Model Formulation
• Run a Case Study
  • 1. Environment and Packages
  • 2. Retrieve Building Data
  • 3. Generate Heat Demand Time Series
  • 4. Cluster Data and Prepare Network
  • 5. Run the Optimization Model
  • 6. Visualize the Results
• Modules
  • prepare_geodata module
  • hd_time_series_generator module
  • clustering module
  • model module
  • visualisation module
  • data module
  • utils module