honeybee_doe2.properties.model module

Model DOE-2 Properties.

class honeybee_doe2.properties.model.ModelDoe2Properties(host)[source]

Bases: object

DOE-2 Properties for Honeybee Model.

Parameters:

host – A honeybee_core Model object that hosts these properties.

Properties:

  • host

ToString()[source]
apply_properties_from_dict(data)[source]

Apply the energy properties of a dictionary to the host Model of this object.

Parameters:

data – A dictionary representation of an entire honeybee-core Model. Note that this dictionary must have ModelEnergyProperties in order for this method to successfully apply the energy properties.

check_all(raise_exception=True, detailed=False)[source]

Check all of the aspects of the Model DOE-2 properties.

Parameters:

  • raise_exception – Boolean to note whether a ValueError should be raised if any errors are found. If False, this method will simply return a text string with all errors that were found.

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A text string with all errors that were found or a list if detailed is True. This string (or list) will be empty if no errors were found.

check_for_extension(raise_exception=True, detailed=False)[source]

Check that the Model is valid for DOE-2 simulation.

This process includes all relevant honeybee-core checks as well as checks that apply only for DOE-2.

Parameters:

  • raise_exception – Boolean to note whether a ValueError should be raised if any errors are found. If False, this method will simply return a text string with all errors that were found. (Default: True).

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A text string with all errors that were found or a list if detailed is True. This string (or list) will be empty if no errors were found.

check_generic(raise_exception=True, detailed=False)[source]

Check generic of the aspects of the Model DOE-2 properties.

This includes checks for everything except holes in floor plates and courtyard stories.

Parameters:

  • raise_exception – Boolean to note whether a ValueError should be raised if any errors are found. If False, this method will simply return a text string with all errors that were found.

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A text string with all errors that were found or a list if detailed is True. This string (or list) will be empty if no errors were found.

check_no_room_holes(raise_exception=True, detailed=False)[source]

Check whether any Room has geometry with holes.

EQuest currently has no way to represent such geometry so, if the issue is not addressed, the hole will simply be removed as part of the process of exporting to an INP file.

Parameters:

  • raise_exception – If True, a ValueError will be raised if the Room2D floor plate has one or more holes. (Default: True).

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A string with the message or a list with a dictionary if detailed is True.

to_dict()[source]

Return Model DOE-2 properties as a dictionary.

property host

Get the Model object hosting these properties.