honeybee.cli.validate module

honeybee validation commands.

honeybee.cli.validate.validate_model(model_file, room_overlaps=False, json=False, output_file=None, check_all=True, plain_text=True)

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.

Parameters:

• model_file – Full path to a Honeybee Model file.

• room_overlaps – Boolean to note whether the output validation report should only validate the Room collisions (True) or all possible issues with the model should be checked (False). (Default: False).

• json – Boolean to note whether the output validation report should be formatted as a JSON object instead of plain text.

• output_file – Optional file to output the string of the visualization file contents. If None, the string will simply be returned from this method.

honeybee.cli.validate.validate_room_volumes(model_file, output_file=None)

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.

Parameters:

• model_file – Full path to a Honeybee Model file.

• output_file – Optional file to output the string of the visualization file contents. If None, the string will simply be returned from this method.