Dump gbXML
- [source code]
Dump a Honyebee Model to a gbXML file.
The gbXML format is a common open standard used to transfer energy model geometry and (some) energy simulation properties from one simulation environment to another.
The forward translators within the OpenStudio SDK are used to export all Honeybee model geometry and properties.

Inputs

    model [Required]
    A Honeybee Model object to be written to a gbXML file.
    name
    A name for the file to which the honeybee objects will be written. If unspecified, it will be derived from the model identifier.
    folder
    An optional directory into which the honeybee objects will be written. The default is set to the default simulation folder.
    full_geo
    Boolean to note whether space boundaries and shell geometry should be included in the exported gbXML vs. just the minimal required non-manifold geometry. Setting to True to include the full geometry will increase file size without adding much new infomration that doesn't already exist in the file. However, some gbXML interfaces need this geometry in order to properly represent and display room volumes. (Default: False).
    dump [Required]
    Set to "True" to save the honeybee model to a gbXML file.

Outputs

    report
    Errors, warnings, etc.
    gbxml
    The location of the file where the honeybee JSON is saved.
Last modified 1mo ago
Export as PDF
Copy link