edit

honeybee-energy edit

Commands for editing model energy properties.

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

lighting-from-daylight

Assign HB-energy lighting schedules using Radiance annual-daylight results.

Note that the honeybee-radiance extension must be installed in order for this command to be run successfully.

Also note that the Honeybee model must have sensor grids with room_identifiers assigned to them for them to affect the HB-Energy lighting schedules. If such grids are found, the lighting schedules of the Rooms will be adjusted according to whether the illuminance values at the sensor locations are at a target illuminance setpoint.

Each grid should have sensors at the locations in space where daylight dimming sensors are located. Grids with two or more sensors can be used to model setups where fractions of each room are controlled by different sensors. If the sensor grids are distributed over the entire floor of the rooms, the resulting schedules will be idealized, where light dimming has been optimized to supply the minimum illuminance setpoint everywhere in the room.

Args:

model_file: Full path to a Honeybee Model (HBJSON or HBpkl) file.

daylight_folder: Path to an annual-daylight results folder. This folder is

an output folder of the annual daylight recipe. The folder should

include grids_info.json and sun-up-hours.txt. The command uses the

list in grids_info.json to find the result files for each sensor grid.

honeybee-energy edit lighting-from-daylight [OPTIONS] MODEL_FILE
                                            DAYLIGHT_FOLDER

Options

-i, --ill-setpoint <ill_setpoint>

A number for the illuminance setpoint in lux beyond which electric lights are dimmed if there is sufficient daylight.

Default

300

-p, --min-power-in <min_power_in>

A number between 0 and 1 for the the lowest power the lighting system can dim down to, expressed as a fraction of maximum input power.

Default

0.3

-l, --min-light-out <min_light_out>

A number between 0 and 1 the lowest lighting output the lighting system can dim down to, expressed as a fraction of maximum light output. Note that setting this to 1 means lights are not dimmed at all until the illuminance setpoint is reached. This can be used to approximate manual light-switching behavior when used in conjunction with the off_at_min_ output below.

Default

0.2

--on-at-min, -oam, --off-at-min

Flag to note whether lights should switch off completely when they get to the minimum power input.

Default

True

-f, --output-file <output_file>

Optional hbjson file to output the JSON string of the converted model. By default this will be printed out to stdout

Default

-

Arguments

MODEL_FILE

Required argument

DAYLIGHT_FOLDER

Required argument

modifiers-from-constructions

Assign honeybee Radiance modifiers based on energy construction properties.

Note that the honeybee-radiance extension must be installed in order for this command to be run successfully.

Also note that setting the –exterior-offset to a non-zero value will add the offset faces as orphaned faces, which changes how the model simulates in EnergyPlus.

Args:

model_file: Full path to a Honeybee Model (HBJSON or HBpkl) file.

honeybee-energy edit modifiers-from-constructions [OPTIONS] MODEL_FILE

Options

--solar, -v, --visible

Flag to note whether the assigned radiance modifiers should follow the solar properties of the constructions or the visible properties.

--dynamic-groups, -sg, --static-groups

Flag to note whether dynamic window constructions and shaded window constructions should be translated to dynamic aperture groups or just the static (bare) construction should be used.

--dynamic-shade, -ss, --static-shade

Flag to note whether dynamic shade transmittance schedules should be translated to dynamic shade groups or just a static, fully-opaque construction should be used.

-o, --exterior-offset <exterior_offset>

A number for the distance at which the exterior Room faces should be offset in meters. This is used to account for the fact that the exterior material layer of the construction usually needs a different modifier from the interior. If set to 0, no offset will occur and all assigned modifiers will be interior.

Default

0

-f, --output-file <output_file>

Optional hbjson file to output the JSON string of the converted model. By default this will be printed out to stdout

Default

-

Arguments

MODEL_FILE

Required argument

reset-resource-ids

Reset the identifiers of resource objects in a Model file.

This is useful when human-readable names are needed when the model is exported to other formats like IDF and OSM and the uniqueness of the identifiers is less of a concern.

Args:

model_file: Full path to a Honeybee Model (HBJSON) file.

honeybee-energy edit reset-resource-ids [OPTIONS] MODEL_FILE

Options

--by-name, -uuid, --by-name-and-uuid

Flag to note whether newly-generated resource object IDs should be derived only from a cleaned display_name or whether this new ID should also have a unique set of 8 characters appended to it to guarantee uniqueness.

--reset-materials, -m, --keep-materials

Flag to note whether the IDs of all materials in the model should be reset.

Default

True

--reset-constructions, -c, --keep-constructions

Flag to note whether the IDs of all constructions in the model should be reset.

Default

True

--reset-construction-sets, -cs, --keep-construction-sets

Flag to note whether the IDs of all construction sets in the model should be reset.

Default

True

--reset-schedules, -s, --keep-schedules

Flag to note whether the IDs of all schedules in the model should be reset.

Default

True

--reset-programs, -p, --keep-programs

Flag to note whether the IDs of all programs in the model should be reset. This will also include resetting the IDs of all load objects in the program.

Default

True

-f, --output-file <output_file>

Optional hbjson file to output the JSON string of the converted model. By default this will be printed out to stdout

Default

-

Arguments

MODEL_FILE

Required argument