honeybee.cli.validate module

honeybee validation commands.

honeybee.cli.validate.validate_model(model_file, extension='Generic', json=False, output_file=None, plain_text=True)[source]

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.

  • extension_name –

    Text for the name of the extension to be checked. The value input here is case-insensitive such that “radiance” and “Radiance” will both result in the model being checked for validity with honeybee-radiance. This value can also be set to “Generic” in order to run checks for all installed extensions. Using “Generic” will run all except the most limiting of checks (eg. DOE2’s lack of support for courtyards) with the goal of producing a model that is export-able to multiple engines (albeit with a little extra postprocessing for particularly limited engines). Some common dragonfly extension names that can be input here if they are installed include:

    • Radiance

    • EnergyPlus

    • DOE2

    • IES

    • IDAICE

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

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

honeybee.cli.validate.validate_room_collisions(model_file, json=False, output_file=None, plain_text=True)[source]

Validate whether Room collide with one another beyond the model tolerance.

Parameters:

  • model_file – Full path to a Honeybee Model file.

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

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

honeybee.cli.validate.validate_rooms_solid(model_file, json=False, output_file=None, plain_text=True)[source]

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.

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

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