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

Update HBJSON

PreviousLoad gbXML OSM IDFNextValidate Model

Last updated 3 years ago

-

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.

A full list of honeybee-schema versions can be found on the honeybee-schema GitHub:

https://github.com/ladybug-tools/honeybee-schema/releases
[source code]