honeybee_openstudio.reader module

Methods to read OpenStudio Models into Honeybee Models.

honeybee_openstudio.reader.aperture_from_openstudio(os_sub_surface, os_site_transform=None, constructions=None)[source]

Convert an OpenStudio SubSurface into a Honeybee Aperture.

Parameters:

  • os_sub_surface – An OpenStudio SubSurface to be converted into a Honeybee Aperture.

  • site_transform – An optional OpenStudio Transformation object that describes how the coordinates of the SubSurface object relate to the world coordinate system.

  • constructions – An optional dictionary of Honeybee Construction objects which will be used to assign a construction to the aperture.

Returns:

A honeybee Aperture object.

honeybee_openstudio.reader.door_from_openstudio(os_sub_surface, os_site_transform=None, constructions=None)[source]

Convert an OpenStudio SubSurface into a Honeybee Door.

Parameters:

  • os_sub_surface – An OpenStudio SubSurface to be converted into a Honeybee Door.

  • site_transform – An optional OpenStudio Transformation object that describes how the coordinates of the SubSurface object relate to the world coordinate system.

  • constructions – An optional dictionary of Honeybee Construction objects which will be used to assign a construction to the door.

Returns:

A honeybee Door object.

honeybee_openstudio.reader.face_3d_from_openstudio(os_vertices)[source]

Convert an OpenStudio Point3dVector into a Face3D.

Parameters:

os_vertices – An OpenStudio Point3dVector that came from any OpenStudio PlanarSurface class.

Returns:

A ladybug-geometry Face3D object created from the OpenStudio Point3dVector.

honeybee_openstudio.reader.face_from_openstudio(os_surface, os_site_transform=None, constructions=None)[source]

Convert an OpenStudio Surface into a Honeybee Face.

Parameters:

  • os_surface – An OpenStudio Surface to be converted into a Honeybee Aperture.

  • site_transform – An optional OpenStudio Transformation object that describes how the coordinates of the SubSurface object relate to the world coordinate system.

  • constructions – An optional dictionary of Honeybee Construction objects which will be used to assign a construction to the aperture.

Returns:

A honeybee Aperture object.

honeybee_openstudio.reader.model_from_gbxml_file(gbxml_file, reset_properties=False, print_warnings=False)[source]

Translate a gbXML file to a Honeybee Model.

Parameters:

  • gbxml_file – Text string for the path to the gbXML file to be converted to a Honeybee Model.

  • reset_properties – Boolean to note whether all energy properties should be reset to defaults upon import, meaning that only the geometry and boundary conditions are imported from the Openstudio Model. (Default: False).

  • print_warnings – Boolean for whether warnings about unimported objects should be printed. (Default: False).

honeybee_openstudio.reader.model_from_idf_file(idf_file, reset_properties=False, print_warnings=False)[source]

Translate an IDF file to a Honeybee Model.

Parameters:

  • idf_file – Text string for the path to the IDF file to be converted to a Honeybee Model.

  • reset_properties – Boolean to note whether all energy properties should be reset to defaults upon import, meaning that only the geometry and boundary conditions are imported from the Openstudio Model. (Default: False).

  • print_warnings – Boolean for whether warnings about unimported objects should be printed. (Default: False).

honeybee_openstudio.reader.model_from_openstudio(os_model, reset_properties=False)[source]

Convert an OpenStudio Model into a Honeybee Model.

Parameters:

  • os_model – An OpenStudio Model to be converted into a Honeybee Model.

  • reset_properties – Boolean to note whether all energy properties should be reset to defaults upon import, meaning that only the geometry and boundary conditions are imported from the Openstudio Model. This can be particularly useful when importing an openStudio Model that originated from an IDF or gbXML since these formats don’t support higher-level objects like SpaceTypes or ConstructionSets. So it is often easier to just import the geometry and reassign properties rather than working from a model where all properties are assigned to individual objects. (Default: False)

Returns:

A honeybee Model.

honeybee_openstudio.reader.model_from_osm(osm_str, reset_properties=False, print_warnings=False)[source]

Translate an OSM string to a Honeybee Model.

Parameters:

  • osm_str – Text string for the contents of an OSM to be converted to a Honeybee Model.

  • reset_properties – Boolean to note whether all energy properties should be reset to defaults upon import, meaning that only the geometry and boundary conditions are imported from the Openstudio Model. (Default: False).

  • print_warnings – Boolean for whether warnings about unimported objects should be printed. (Default: False).

honeybee_openstudio.reader.model_from_osm_file(osm_file, reset_properties=False, print_warnings=False)[source]

Translate an OSM file to a Honeybee Model.

Parameters:

  • osm_file – Text string for the path to the OSM file to be converted to a Honeybee Model.

  • reset_properties – Boolean to note whether all energy properties should be reset to defaults upon import, meaning that only the geometry and boundary conditions are imported from the Openstudio Model. (Default: False).

  • print_warnings – Boolean for whether warnings about unimported objects should be printed. (Default: False).

honeybee_openstudio.reader.room_from_openstudio(os_space, constructions=None, schedules=None)[source]

Convert an OpenStudio Space into a Honeybee Room.

Parameters:

  • os_space – An OpenStudio Space to be converted into a Honeybee Room.

  • constructions – An optional dictionary of Honeybee Construction objects which will be used to assign a construction to the room.

  • schedules – An optional dictionary of Honeybee Schedule objects which will be used to assign schedules to the rooms.

Returns:

A honeybee Room object.

honeybee_openstudio.reader.shades_from_openstudio(os_shade_group, constructions=None, schedules=None)[source]

Convert an OpenStudio ShadingSurfaceGroup into a list of Honeybee Shades.

Parameters:

  • os_shade_group – An OpenStudio ShadingSurfaceGroup to be converted into a list of Honeybee Shades.

  • constructions – An optional dictionary of Honeybee Construction objects which will be used to assign constructions to the shades.

  • schedules – An optional dictionary of Honeybee Schedule objects which will be used to assign transmittance schedules to the shades.

Returns:

A list of Honeybee Shade objects.