validate¶

dragonfly validate¶

Commands for validating Dragonfly files.

dragonfly validate [OPTIONS] COMMAND [ARGS]...

model¶

Validate a Model file against the Dragonfly schema.

Args:

model_file: Full path to either a DFJSON or DFpkl file. This can also be a

HBJSON or a HBpkl from which a Dragonfly model should be derived.

dragonfly validate model [OPTIONS] MODEL_FILE

Options

-e, --extension <extension>¶

Text for the name of the extension to be checked. The value input is case-insensitive such that “radiance” and “Radiance” will both result in the model being checked for validity with dragonfly-radiance. This value can also be set to “All” in order to run checks for all installed extensions. Some common dragonfly extension names that can be input here include: Radiance, EnergyPlus, DOE2, IES, IDAICE

Default:: 'All'

--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 “dragonfly_core” and “dragonfly_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

--room-overlaps¶: Deprecated flag used to check room collisions. Use dragonfly validate room-collisions instead.

-f, --output-file <output_file>¶: Optional file to output the full report of any errors detected. By default it will be printed out to stdout

Arguments

MODEL_FILE¶: Required argument

room-collisions¶

Validate whether all Room volumes in a model are solid.

The returned result can include a list of all naked and non-manifold edges preventing closed room volumes when –json is used. This is helpful for visually identifying issues in geometry that are preventing the room volume from validating as closed.

Args:

model_file: Full path to a Dragonfly Model file.

dragonfly validate room-collisions [OPTIONS] MODEL_FILE

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. 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. 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_FILE¶: Required argument