honeybee_doe2.simulation module¶

honeybee-doe2 simulation parameters.

class honeybee_doe2.simulation.SimulationPar(title='Unnamed', run_period=None, site=None)[source]¶

Bases: object

Complete set of DOE-2 Simulation Settings.

Parameters:

title – Text for the title of the project. (Default: Unnamed).
run_period – A honeybee-energy RunPeriod object to describe the time period over which to run the simulation. (Default: Run for the whole year).
site – A SiteData object describing the site where the simulation is run. (Default: HArtford, CT).

Properties:

title
run_period
site

ToString()[source]¶: Overwrite .NET ToString.

duplicate()[source]¶: Get a copy of this object.

classmethod from_dict(data)[source]¶

Create a SimulationPar object from a dictionary.

Parameters:: data – A SimulationPar dictionary in following the format below.

{
"type": "SimulationPar",
"title": 'sample_project', # Text for the title
"run_period": {}, # Honeybee RunPeriod dictionary
"site": {}, # Honeybee SiteData dictionary
}

to_dict()[source]¶: SimulationPar dictionary representation.

to_inp()[source]¶: Get an DOE-2 INP string representation of the SimulationPar.

property run_period¶: Get or set a RunPeriod object for the time period to run the simulation.

property site¶: Get or set a SiteData object for the project site of the simulation.

property title¶: Get or set text for the title of the project.

class honeybee_doe2.simulation.SiteData(altitude=150)[source]¶

Bases: object

Object to describe the project site of the simulation.

Parameters:: altitude – A number for the altitude of the location above sea level in Feet. (Default: 150).

Properties:

altitude

ToString()[source]¶: Overwrite .NET ToString.

duplicate()[source]¶: Get a copy of this object.

classmethod from_dict(data)[source]¶

Create a SiteData object from a dictionary.

Parameters:: data – A SiteData dictionary in following the format below.

{
"type": "SiteData",
"altitude": 100  # altitude above sea level (ft)
}

to_dict()[source]¶: SiteData dictionary representation.

to_inp()[source]¶: Get an DOE-2 INP string representation of the SiteData.

property altitude¶: A number for the altitude of the location above sea level in Feet.

honeybee_doe2.simulation.run_period_to_inp(run_period)[source]¶: Translate a honeybee-energy RunPeriod object to a DOE-2 INP string