validate

honeybee validate

Commands for validating Honeybee objects.

honeybee validate [OPTIONS] COMMAND [ARGS]...

model

Validate all properties of a Model file against the Honeybee schema.

This includes checking basic compliance with the 5 rules of honeybee geometry as well as checks for all extension attributes. The 5 rules of honeybee geometry are as follows.

  1. All Face3Ds must be planar to within the model tolerance.

  2. All Face3Ds must NOT be self-intersecting (like a bowtie shape)

  3. All children sub-faces (Apertures and Doors) must be co-planar with

    their parent Face and lie completely within its boundary.

  4. All adjacent object pairs (faces and sub-faces with a Surface boundary

    condition) must have matching areas.

  5. All Room volumes must be closed solids.

Args:
model_json: Full path to a Model JSON file.
honeybee validate model [OPTIONS] MODEL_JSON

Options

--plain-text, -j, --json

Flag to note whether the output validation report should be formatted as a JSON object instead of plain text. If set to JSON, the output object will contain several attributes. The “honeybee_core” and “honeybee_schema” attributes will note the versions of these libraries used in the validation process. An attribute called “fatal_error” is a text string containing an exception if the Model failed to serialize and will be an empty string if serialization was successful. An attribute called “errors” will contain a list of JSON objects for each invalid issue found in the model. A boolean attribute called “valid” will note whether the Model is valid or not.

Default

True

-f, --output-file <output_file>

Optional file to output the full report of the validation. By default it will be printed out to stdout

Arguments

MODEL_JSON

Required argument

room-volumes

Get a list of all naked and non-manifold edges preventing closed room volumes.

This is helpful for visually identifying issues in geometry that are preventing the room volume from reading as closed.

Args:
model_json: Full path to a Model JSON file.
honeybee validate room-volumes [OPTIONS] MODEL_JSON

Options

-f, --output-file <output_file>

Optional file to output the JSON strings of ladybug_geometry LineSegment3Ds that represent naked and non-manifold edges. By default it will be printed out to stdout

Arguments

MODEL_JSON

Required argument