compare

honeybee compare

Commands for comparing Honeybee objects.

honeybee compare [OPTIONS] COMMAND [ARGS]...

models

Get a report outlining the differences between this model and another.

The resulting report will only note top-level objects that are different between this model and the other. If an object has not changed at all, then it will not show up in the report.

Changes to geometry are reported separately from changes in metadata (aka. extension properties) for each of the top level objects.

If the Model units or tolerance are different between the two models, then the units and tolerance of this model will take precedence and the other_model will be converted to these units and tolerance for geometry comparison.

Args:

base_model: Full path to a Honeybee Model file to be used as the base

of comparison.

other_model: Full path to a Honeybee Model file to which the base model

will be compared.

honeybee compare models [OPTIONS] BASE_MODEL_FILE OTHER_MODEL_FILE

Options

--include-deleted, -d, --ignore-deleted

Flag to note whether objects that appear in the base model but not in the other model should be reported. It is useful to ignore-deleted when the other model represents only a subset of the current model.

Default:

True

--include-added, -a, --ignore-added

Flag to note whether whether objects that appear in the other model but not in the current model should be reported.

Default:

True

--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 differences between models. By default it will be printed out to stdout

Arguments

BASE_MODEL_FILE

Required argument

OTHER_MODEL_FILE

Required argument