• 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

-

Serialize any honeybee object to a JSON text string. You can use "HB String to Object" component to load the objects from the file back.

Honeybee objects include any honeybee energy Material, Construction, ConstructionSet, Schedule, Load, ProgramType, or Simulation object.

Inputs

• hb_obj [Required]

A Honeybee object to be serialized to a string.

Outputs

• hb_str

A text string that completely describes the honeybee object. This can be serialized back into a honeybee object using the "HB String to Object" coponent.

- [source code]

Dump any honeybee object to a JSON file. You can use "HB Load Objects" component to load the objects from the file back into Grasshopper.

Honeybee objects include any honeybee energy Material, Construction, ConstructionSet, Schedule, Load, ProgramType, or Simulation object.

Inputs

• hb_objs [Required]

A list of Honeybee objects to be written to a file.

• name

A name for the file to which the honeybee objects will be written. (Default: 'unnamed').

• folder

An optional directory into which the honeybee objects will be written. The default is set to the default simulation folder.

• indent

An optional positive integer to set the indentation used in the resulting JSON file.

• abridged

Set to "True" to serialize the object in its abridged form. Abridged objects cannot be reserialized back to honeybee objects on their own but they are used throughout honeybee to minimize file size and unnecessary duplication.

• dump [Required]

Set to "True" to save the honeybee objects to file.

Outputs

• report

Errors, warnings, etc.

• hb_file

The location of the file where the honeybee JSON is saved.

- [source code]

Dump any honeybee object to a compressed .pkl file. You can use "HB Load Compressed Objects" component to load the objects from the file back into Grasshopper.

Honeybee objects include any Model, Room, Face, Aperture, Door, Shade, or boundary condition object

It also includes any honeybee energy Material, Construction, ConstructionSet, Schedule, Load, ProgramType, or Simulation object.

Inputs

• hb_objs [Required]

  A Honeybee object (or list of Honeybee objects) to be written to a file.

• name

  A name for the file to which the honeybee objects will be written. (Default: 'unnamed').

• folder

  An optional directory into which the honeybee objects will be written. The default is set to the default simulation folder.

• dump [Required]

  Set to "True" to save the honeybee objects to file.

Outputs

• report

  Errors, warnings, etc.

• hb_file

  The location of the file where the honeybee .pkl file is saved.

- [source code]

Load any honeybee object from a honeybee JSON file

Honeybee objects include any Model, Room, Face, Aperture, Door, Shade, or boundary condition object.

It also includes any honeybee energy Material, Construction, ConstructionSet, Schedule, Load, ProgramType, or Simulation object.

Inputs

• hb_file [Required]

  A file path to a honeybee JSON from which objects will be loaded back into Grasshopper. The objects in the file must be non-abridged in order to be loaded back correctly.

• load [Required]

  Set to "True" to load the objects from the _hb_file.

Outputs

• report

  Reports, errors, warnings, etc.

• hb_objs

  A list of honeybee objects that have been re-serialized from the input file.

- [source code]

Serialize any honeybee JSON text string back to a honeybee object.

Honeybee objects include any Model, Room, Face, Aperture, Door, Shade, or boundary condition object.

It also includes any honeybee energy Material, Construction, ConstructionSet, Schedule, Load, ProgramType, or Simulation object.

Inputs

• hb_str [Required]

  A text string that completely describes the honeybee object.

Outputs

• hb_obj

  A Honeybee object serialized from the input string.

- [source code]

Load any honeybee object from a compressed .pkl or .hbpkl file.

Honeybee objects include any Model, Room, Face, Aperture, Door, Shade, or boundary condition object.

It also includes any honeybee energy Material, Construction, ConstructionSet, Schedule, Load, ProgramType, or Simulation object.

Inputs

• hb_file [Required]

  A file path to a .pkl or .hbpkl from which objects will be loaded back into Grasshopper.

• load [Required]

  Set to "True" to load the objects from the _hb_file.

Outputs

• report

  Reports, errors, warnings, etc.

• hb_objs

  A list of honeybee objects that have been re-serialized from the input file.

- [source code]

Get a validation report that contains a summary of all issues with the Model.

This includes basic properties like adjacency checks and all geometry checks. Furthermore, all extension attributes for Energy and Radiance will be checked to ensure that the model can be simulated correctly in these engines.

Inputs

• model [Required]

A Honeybee Model object to be validated. This can also be the file path to a Model HBJSON that will be validated.

• validate [Required]

Set to "True" to validate the the Model and get a report of all issues with the model.

Outputs

• report

A report summarizing any issues with the input _model. If anything is invalid about the input model, this component will give a warning and this report will contain information about the specific parts of the model that are invalid. Otherwise, this report will simply say that the input model is valid.

- [source code]

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.

-

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.

• int_floors

A boolean to note whether all interior horizontal faces should be written with the InteriorFloor type instead of the combination of InteriorFloor and Ceiling that happens by default with OpenStudio gbXML serialization. (Default: False).

• triangulate

Boolean to note whether sub-faces (including Apertures and Doors) should be triangulated if they have more than 4 sides (True) or whether they should be left as they are (False). This triangulation is necessary when exporting directly to EnergyPlus since it cannot accept sub-faces with more than 4 vertices. However, it is not a general requirement of gbXML or all of the simulation engines that gbXML can import to/from. (Default: False).

• 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.

-

Upgrade a Model HBJSON file to the currently installed version of the schema.

This component can also upgrade to a specific version of the schema but it cannot downgrade the schema version or change the version of any honeybee object other than a Model.

Inputs

• hbjson [Required]

  A file path to a Model HBJSON which will be upgraded to the currently installed version of the Honeybee Model schema (or a specific version specified below).

• version

  Text to indicate the version to which the Model HBJSON will be updated (eg. 1.41.2). Versions must always consist of three integers separated by periods. If None, the Model HBJSON will be updated to the currently installed version of honeybee-schema.

• name

  A name for the file to which the honeybee objects will be written. By default, it will have the same name as the input file but with "UPDATED" appended to the file name.

• folder

  An optional directory into which the updated file will be written. The default is set to the default simulation folder.

• validate

  Boolean to note whether the Honeybee Model should be validated and checked for errors after it has been updated. This includes basic properties like adjacency and duplicate identifier checks as well as geometry checks for planarity, room solidity, etc.

• update [Required]

  Set to "True" to update the Model HBJSON to the currently installed version.

Outputs

• report

  Reports, errors, warnings, etc.

• hbjson

  The file path to the updated HBJSON.