validate

honeybee-energy validate

Commands for validating Honeybee energy JSON files.

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

construction-set

Validate all properties of a ConstructionSet or ConstructionSetAbridged JSON.

Args:
construction_set_json: Full path to a ConstructionSet or ConstructionSetAbridged
JSON file.
honeybee-energy validate construction-set [OPTIONS] CONSTRUCTION_SET_JSON

Arguments

CONSTRUCTION_SET_JSON

Required argument

model-properties

Validate the energy properties of a Model JSON against the Honeybee schema.

This includes basic re-serialization, which accounts for missing objects, and unique identifier checks.

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

Options

-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_JSON

Required argument

program-type

Validate all properties of a ProgramType or ProgramTypeAbridged JSON.

Args:
program_type_json: Full path to a ProgramType or ProgramTypeAbridged JSON file.
honeybee-energy validate program-type [OPTIONS] PROGRAM_TYPE_JSON

Arguments

PROGRAM_TYPE_JSON

Required argument

schedule

Validate all properties of a schedule or abridged schedule JSON.

Args:
schedule_json: Full path to a either ScheduleRuleset, ScheduleRulesetAbridged
ScheduleFixedInterval, or ScheduleFixedIntervalAbridged JSON file.
honeybee-energy validate schedule [OPTIONS] SCHEDULE_JSON

Arguments

SCHEDULE_JSON

Required argument

schedule-type-limit

Validate all properties of a ScheduleTypeLimit JSON against the Honeybee schema.

Args:
schedule_type_limit_json: Full path to a ScheduleTypeLimit JSON file.
honeybee-energy validate schedule-type-limit [OPTIONS]
                                             SCHEDULE_TYPE_LIMIT_JSON

Arguments

SCHEDULE_TYPE_LIMIT_JSON

Required argument

sim-par

Validate all properties of a SimulationParameter JSON against the Honeybee schema.

Args:
sim_par_json: Full path to a SimulationParameter JSON file.
honeybee-energy validate sim-par [OPTIONS] SIM_PAR_JSON

Arguments

SIM_PAR_JSON

Required argument