dragonfly_uwg.simulation.runperiod module

UWG Simulation Run Period.

class dragonfly_uwg.simulation.runperiod.UWGRunPeriod(start_date=01 Jan, end_date=31 Dec)[source]

Bases: object

UWG Simulation Run Period.

Parameters:

  • start_date – A ladybug Date object for the start of the simulation. Must be before the end date and have a leap_year property matching the end_date. (Default: 1 Jan).

  • end_date – A ladybug Date object for the end of the simulation. Must be after the start date and have a leap_year property matching the start_date. (Default: 31 Dec).

Properties:

  • start_date

  • end_date

  • day_count

ToString()[source]

Overwrite .NET ToString.

duplicate()[source]

Get a copy of this object.

classmethod from_analysis_period(analysis_period=1/1 to 12/31 between 0 and 23 @1)[source]

Initialize a UWGRunPeriod object from a ladybug AnalysisPeriod.

Parameters:

analysis_period – A ladybug AnalysisPeriod object that has the start and end dates for daylight savings time.

classmethod from_dict(data)[source]

Create a UWGRunPeriod object from a dictionary.

Parameters:

data – A UWGRunPeriod dictionary in following the format below.

{
"type": "UWGRunPeriod",
"start_date": [3, 12],
"end_date": [11, 5]
}
to_dict()[source]

UWGRunPeriod dictionary representation.

property day_count

Get an integer for the number of days in the run period.

property end_date

Get or set a ladybug Date object for the end of the simulation period.

property start_date

Get or set a ladybug Date object for the start of the simulation period.