Honeybee Primer
Ladybug Tools for Grasshopper Documentation
  • Honeybee Primer
  • Components
    • 0 :: Create
      • Deconstruct Model
      • Model
      • Deconstruct Object
      • Intersect Solids
      • Planarize Brep
      • Room
      • Room from Solid
      • Solve Adjacency
      • Face
      • Properties by Guide Surface
      • Add Subface
      • Aperture
      • Apertures by Ratio
      • Door
      • Facade Parameters
      • Skylights by Ratio
      • Add Shade
      • Extruded Border Shades
      • Louver Shades
      • Shade
      • Mirror
      • Move
      • Rotate
      • Scale
      • Recipe Settings
      • Visualize Recipe Execution
      • Add Prefix
      • Apertures by Guide Surface
      • Apertures by Width Height
      • Custom Ground
      • Set Identifier
      • Set Multiplier
      • Set Story
      • Straight Skeleton
    • 1 :: Visualize
      • Visualize All
      • Visualize Normals
      • Visualize Quick
      • Visualize Wireframe
      • Face Attributes
      • Room Attributes
      • Color Face Attributes
      • Color Room Attributes
      • Label Faces
      • Label Rooms
      • Visualize by BC
      • Visualize by Type
      • Check Versions
      • Config
      • Geometry Properties
    • 2 :: Organize
      • Faces by Attribute
      • Rooms by Attribute
      • Rooms by Floor Height
      • Rooms by Orientation
      • Faces by BC
      • Faces by Type
    • 3 :: Serialize
      • Object to String
      • String to Object
      • Dump Objects
      • Load Objects
      • Dump Compressed Objects
      • Load Compressed Objects
      • Dump gbXML
      • Load gbXML OSM IDF
      • Update HBJSON
      • Validate Model
Powered by GitBook
On this page
  • Inputs
  • Outputs
Export as PDF
  1. Components
  2. 3 :: Serialize

Load gbXML OSM IDF

PreviousDump gbXMLNextUpdate HBJSON

Last updated 3 years ago

-

Load a gbXML, OSM, or IDF file as a Honeybee Model.

The reverse translators within the OpenStudio SDK are used to import all geometry and boundary conditions (including adjacencies) to a Honeybee format.

Note that, while all geometry will be imported, it is possible that not all of the properties assigned to this geometry will be imported, particularly if a certain property is not supported in the OpenStudio SDK. Honeybee will assign defaults for missing properites and, the HBJSON format should be used whenever lossless file transfer is needed.

Inputs

  • model_file [Required]

A file path to a gbXML, OSM or IDF file from which a Honeybee Model will be loaded

  • load [Required]

Set to "True" to load the Model from the input file.

Outputs

  • report

...

  • model

A honeybee Model objects that has been re-serialized from the input file.

[source code]