UrbanHeatPro.run_uhp

Run the UrbanHeatPro model.

Module Contents

Functions

run_uhp([selected_region, simulation_name, ...])

Read the configuration file and run the UrbanHeatPro model.
UrbanHeatPro.run_uhp.run_uhp(selected_region: str = None, simulation_name: str = None, buildings_use_filter='', settings_file='../settings/uhp_settings_example.yaml', result_dir=None)[source]

Read the configuration file and run the UrbanHeatPro model.

Use this function to run the UrbanHeatPro model from another python package,module or script. This function expects the default configuration file at ../settings/uhp_default_settings.yaml. The configuration file can be changed using the settings_file parameter. To make changes to the configuration of the model, change the values in the configuration file with the path specified in settings_file.

Parameters:

  • selected_region (str) – Name or identifier of the region to be simulated, defaults to None

  • simulation_name (str) – Name of the simulation, defaults to None. If None, the name of the region is used.

  • buildings_use_filter – Optional usetype identifier for the buildings file, defaults to ‘’

  • settings_file – Path to the settings file, defaults to '../settings/uhp_settings_example.yaml'

  • result_dir – Path to the result directory, defaults to None. If None, the ../results/ directory is used.