dragonfly_uwg.simulation.parameter module

Complete set of UWG Simulation Settings.

class dragonfly_uwg.simulation.parameter.UWGSimulationParameter(climate_zone=Autocalculate, run_period=None, timestep=12, vegetation_parameter=None, reference_epw_site=None, boundary_layer_parameter=None)[source]

Bases: object

Complete set of UWG Simulation Settings.

Parameters:

  • climate_zone – Text for the ASHRAE climate zone, including the letter for humidity classification (eg. “4A”). This is used to set default constructions for various buildings. If set to autocalculate, the climate zone will be estimated from analysis of the epw to be morphed for simulation. (Default: autocalculate).

  • run_period – A UWGRunPeriod object to describe the time period over which to run the simulation. If None, the simulation will be run for the whole year. (Default: None).

  • timestep – An integer for the number of timesteps per hour at which the calculation will be run. (Default: 12).

  • vegetation_parameter – A VegetationParameter to specify the behavior of vegetation in the urban area. If None, generic vegetation parameters will be generated. (Default: None).

  • reference_epw_site – A ReferenceEPWSite to specify the properties of the reference site where the input rural EPW was recorded. If None, generic airport properties will be generated. (Default: None).

  • boundary_layer_parameter – A BoundaryLayerParameter to specify the properties of the urban boundary layer. If None, generic boundary layer parameters will be generated. (Default: None).

ToString()[source]

Overwrite .NET ToString method.

duplicate()[source]

Get a copy of this object.

classmethod from_dict(data)[source]

Create a UWGSimulationParameter object from a dictionary.

Parameters:

data – A UWGSimulationParameter dictionary in following the format below.

{
"type": "UWGSimulationParameter",
"climate_zone": "5A",  # Text for ASHRAE climate zone
"run_period": {}, # Dragonfly UWGRunPeriod dictionary
"timestep": 20, # Integer for the simulation timestep
"vegetation_parameter": {}, # Dragonfly VegetationParameter dictionary
"reference_epw_site": {}, # Dragonfly ReferenceEPWSite dictionary
"boundary_layer_parameter": {} # Dragonfly BoundaryLayerParameter dictionary
}
to_dict()[source]

UWGSimulationParameter dictionary representation.

to_uwg_dict(epw_file)[source]

Get a dictionary following the input schema of the UWG.

Note that this dictionary will only include the properties that the UWGSimulationParameter object possesses and will lack all of those provided by the Model object. For fully simulate-able UWG input, the Model.to.uwg method should be used. The keys of the dictionary output by this method include the following.

  • zone

  • month

  • day

  • nday

  • dtsim

  • rurvegcover

  • vegstart

  • vegend

  • albveg

  • latgrss

  • lattree

  • h_ubl1

  • h_ubl2

  • h_ref

  • h_temp

  • h_wind

  • c_circ

  • c_exch

  • h_obs

Parameters:

epw_file – File path to the EPW that will be morphed by the UWG. This will be used to fill all autocalculated fields like the ASHRAE climate zone and vegetation start/end.

VALIDTIMESTEPS = (1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, 60)
VALIDZONES = ('1A', '1B', '2A', '2B', '3A', '3B', '3C', '4A', '4B', '4C', '5A', '5B', '5C', '6A', '6B', '7', '8')
property boundary_layer_parameter

Get or set a BoundaryLayerParameter object for the boundary layer properties.

property climate_zone

Get or set a text for the ASHRAE climate zone.

property reference_epw_site

Get or set a ReferenceEPWSite object for the properties of the rural EPW.

property run_period

Get or set a UWGRunPeriod object for the time period to run the simulation.

property timestep

Get or set a integer for the number of simulation timesteps per hour.

property vegetation_parameter

Get or set a VegetationParameter object for the behavior of vegetation.