dragonfly_uwg.run module

Module for running models through the Urban Weather Generator (UWG).

dragonfly_uwg.run.run_uwg(model, epw_file_path, simulation_parameter=None, directory=None, silent=False)[source]

Run a UWG dictionary file through the UWG on any operating system.

Parameters

  • model – A Dragonfly Model to be used to morph the EPW for the urban area.

  • epw_file_path – The full path to an EPW file.

  • simulation_parameter – A UWGSimulationParameter object that dictates various settings about the UWG simulation. If None, default parameters will be generated. (Default: None).

  • directory – Text for the directory into which the the uwg JSON and morphed urban EPW will be written. If None, it will be written into the ladybug default_epw_folder within a subfolder bearing the name of the dragonfly Model. (Default: None).

  • silent – Boolean to note whether the simulation should be run silently. This only has an effect on Windows simulations since Unix-based simulations always use shell and are always silent (Default: False).

Returns

The following files output from the UWG CLI run

  • uwg_json – Path to a .json file derived from the input uwg_dict.

  • epw – File path to the morphed EPW. Will be None if the UWG failed to run.