honeybee_energy.properties.model module

Model Energy Properties.

class honeybee_energy.properties.model.ModelEnergyProperties(host, ventilation_simulation_control=None)[source]

Bases: object

Energy Properties for Honeybee Model.

Parameters
  • host – A honeybee_core Model object that hosts these properties.

  • ventilation_simulation_control – A VentilationSimulationControl object that defines global parameters for ventilation simulation.

Properties:
  • host

  • materials

  • constructions

  • room_constructions

  • face_constructions

  • shade_constructions

  • construction_sets

  • schedule_type_limits

  • schedules

  • shade_schedules

  • room_schedules

  • program_type_schedules

  • hvac_schedules

  • program_types

  • hvacs

  • ventilation_simulation_control

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.

assign_radiance_solar_exterior()[source]

Assign honeybee Radiance modifiers based on exterior solar properties.

assign_radiance_solar_interior()[source]

Assign honeybee Radiance modifiers based on interior solar properties.

assign_radiance_visible_exterior()[source]

Assign honeybee Radiance modifiers based on exterior visible properties.

assign_radiance_visible_interior()[source]

Assign honeybee Radiance modifiers based on interior visible properties.

autocalculate_ventilation_simulation_control()[source]

Set geometry properties of ventilation_simulation_control with Model’s rooms.

The room geometry of the host Model will be used to assign the aspect_ratio, long_axis_angle, and the building_type. Note that these properties are only meaningful for simulations using the AirflowNetwork.

check_duplicate_construction_identifiers(raise_exception=True)[source]

Check that there are no duplicate Construction identifiers in the model.

check_duplicate_construction_set_identifiers(raise_exception=True)[source]

Check that there are no duplicate ConstructionSet identifiers in the model.

check_duplicate_hvac_identifiers(raise_exception=True)[source]

Check that there are no duplicate HVAC identifiers in the model.

check_duplicate_material_identifiers(raise_exception=True)[source]

Check that there are no duplicate Material identifiers in the model.

check_duplicate_program_type_identifiers(raise_exception=True)[source]

Check that there are no duplicate ProgramType identifiers in the model.

check_duplicate_schedule_identifiers(raise_exception=True)[source]

Check that there are no duplicate Schedule identifiers in the model.

check_duplicate_schedule_type_limit_identifiers(raise_exception=True)[source]

Check that there are no duplicate ScheduleTypeLimit identifiers in the model.

duplicate(new_host=None)[source]

Get a copy of this object.

Parameters

new_host – A new Model object that hosts these properties. If None, the properties will be duplicated with the same host.

static load_properties_from_dict(data)[source]

Load model energy properties of a dictionary to Python objects.

Loaded objects include Materials, Constructions, ConstructionSets, ScheduleTypeLimits, Schedules, and ProgramTypes.

The function is called when re-serializing a Model object from a dictionary to load honeybee_energy objects into their Python object form before applying them to the Model geometry.

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 load the energy properties.

Returns

A tuple with seven elements

  • materials – A dictionary with identifiers of materials as keys and Python material objects as values.

  • constructions – A dictionary with identifiers of constructions as keys and Python construction objects as values.

  • construction_sets – A dictionary with identifiers of construction sets as keys and Python construction set objects as values.

  • schedule_type_limits – A dictionary with identifiers of schedule type limits as keys and Python schedule type limit objects as values.

  • schedules – A dictionary with identifiers of schedules as keys and Python schedule objects as values.

  • program_types – A dictionary with identifiers of program types as keys and Python program type objects as values.

  • hvacs – A dictionary with identifiers of HVAC systems as keys and Python HVACSystem objects as values.

offset_and_assign_exterior_face_modifiers(reflectance_type='Solar', offset=0.02)[source]

Offset all exterior Faces and assign them a modifier based on exterior layer.

This is often useful in conjunction with the assign_radiance_solar_interior or the assign_radiance_visible_interior to make a radiance model that accounts for both the interior and exterior material layers.

Note that this method will add the offset faces as orphaned faces and so the model will not be simulate-able in EnergyPlus after running this method (it is only intended to be simulated within Radiance).

Parameters
  • reflectance_type – Text for the type of reflectance to be used in the assigned modifier. Must be either Solar or Visible. (Default: Solar).

  • offset – A number for the distance at which the exterior Faces should be offset. (Default: 0.02, suitable for models in meters).

remove_child_constructions()[source]

Remove constructions assigned to Faces, Apertures, Doors and Shades.

This means that all constructions of the Mode’s rooms will be assigned by the Rooms’ construction_set (or the Honeybee default ConstructionSet if Rooms have no construction set).

to_dict()[source]

Return Model energy properties as a dictionary.

window_construction_by_orientation(construction, orientation=0, offset=45, north_vector=Vector2D(0.0, 1.0))[source]

Set the construction of exterior Apertures in Walls facing a given orientation.

This is useful for testing orientation-specific energy conservation strategies or creating AHSRAE baseline buildings.

Parameters
  • construction – A WindowConstruction that will be assigned to all of the room’s Apertures in Walls that are facing a certain orientation.

  • orientation – A number between 0 and 360 that represents the orientation in degrees to which the construction will be assigned. 0 = North, 90 = East, 180 = South, 270 = West. (Default: 0 for North).

  • offset – A number between 0 and 180 that represents the offset from the orientation in degrees for which the construction will be assigned. For example, a value of 45 indicates that any Apertures falling in the 90 degree range around the orientation will get the input construction. (Default: 45).

  • north_vector – A ladybug_geometry Vector3D for the north direction. Default is the Y-axis (0, 1).

property construction_schedules

A list of all unique schedules assigned to constructions in the model.

This includes schedules on al AirBoundaryConstructions.

property construction_sets

A list of all unique Room-Assigned ConstructionSets in the Model.

property constructions

A list of all unique constructions in the model.

This includes constructions across all Faces, Apertures, Doors, Shades, and Room ConstructionSets but it does NOT include the Honeybee generic default construction set.

property face_constructions

A list of all unique constructions assigned to Faces, Apertures and Doors.

property host

Get the Model object hosting these properties.

property hvac_schedules

A list of all unique HVAC-assigned schedules in the model.

property hvacs

A list of all unique HVAC systems in the Model.

property materials

List of all unique materials contained within the model.

This includes materials across all Faces, Apertures, Doors and Room ConstructionSets but it does NOT include the Honeybee generic default construction set.

property program_type_schedules

A list of all unique schedules assigned to ProgramTypes in the model.

property program_types

A list of all unique ProgramTypes in the Model.

property room_constructions

A list of all unique constructions assigned to Room ConstructionSets.

property room_schedules

A list of all unique schedules assigned directly to Rooms in the model.

Note that this does not include schedules from ProgramTypes assigned to the rooms. For this, use the program_type_schedules property.

property schedule_type_limits

List of all unique schedule type limits contained within the model.

This includes schedules across all Shades and Rooms.

property schedules

A list of all unique schedules in the model.

This includes schedules across all ProgramTypes, HVACs, Rooms and Shades.

property shade_constructions

A list of all unique constructions assigned to Shades in the model.

property shade_schedules

A list of all unique transmittance schedules assigned to Shades in the model.

property ventilation_simulation_control

Get or set global parameters for ventilation cooling simulation.