settings

honeybee-energy settings

Commands for simulating Honeybee JSON files in EnergyPlus.

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

comfort-sim-par

Get a SimulationParameter JSON with outputs for thermal comfort mapping.

Args:
ddy_file: Full path to a DDY file that will be used to specify design days
within the simulation parameter.
honeybee-energy settings comfort-sim-par [OPTIONS] DDY_FILE

Options

-rp, --run-period <run_period>

An AnalysisPeriod or RunPeriod string to dictate the start and end of the simulation (eg. “6/21 to 9/21 between 0 and 23 @1”). If unspecified, the simulation will be for the whole year.

-n, --north <north>

Number from -360 to 360 for the counterclockwise difference between North and the positive Y-axis in degrees. 90 is west; 270 is east

Default

0

--filter-des-days, -all, --all-des-days

Flag to note whether the design days in the ddy-file should be filtered to only include 99.6 and 0.4 design days.

Default

True

-f, --output-file <output_file>

Optional file to output the JSON string of the simulation parameters. By default, it will be printed to stdout.

Default

Arguments

DDY_FILE

Required argument

custom-sim-par

Get a SimulationParameter JSON with an option for custom outputs.

Args:
ddy_file: Full path to a DDY file that will be used to specify design days
within the simulation parameter.
output_names: Any number of EnergyPlus output names as strings (eg.
‘Surface Window System Solar Transmittance’. These outputs will be
requested from the simulation.
honeybee-energy settings custom-sim-par [OPTIONS] DDY_FILE [OUTPUT_NAMES]...

Options

-rp, --run-period <run_period>

An AnalysisPeriod or RunPeriod string to dictate the start and end of the simulation (eg. “6/21 to 9/21 between 0 and 23 @1”). If unspecified, the simulation will be for the whole year.

-n, --north <north>

Number from -360 to 360 for the counterclockwise difference between North and the positive Y-axis in degrees. 90 is west; 270 is east

Default

0

--filter-des-days, -all, --all-des-days

Flag to note whether the design days in the ddy-file should be filtered to only include 99.6 and 0.4 design days.

Default

True

-f, --output-file <output_file>

Optional file to output the JSON string of the simulation parameters. By default, it will be printed to stdout.

Default

Arguments

DDY_FILE

Required argument

OUTPUT_NAMES

Optional argument(s)

default-sim-par

Get a SimulationParameter JSON with default outputs for energy use only.

Args:
ddy_file: Full path to a DDY file that will be used to specify design days
within the simulation parameter.
honeybee-energy settings default-sim-par [OPTIONS] DDY_FILE

Options

-rp, --run-period <run_period>

An AnalysisPeriod or RunPeriod string to dictate the start and end of the simulation (eg. “6/21 to 9/21 between 0 and 23 @1”). If unspecified, the simulation will be for the whole year.

-n, --north <north>

Number from -360 to 360 for the counterclockwise difference between North and the positive Y-axis in degrees. 90 is west; 270 is east

Default

0

--filter-des-days, -all, --all-des-days

Flag to note whether the design days in the ddy-file should be filtered to only include 99.6 and 0.4 design days.

Default

True

-f, --output-file <output_file>

Optional file to output the JSON string of the simulation parameters. By default, it will be printed to stdout.

Default

Arguments

DDY_FILE

Required argument

load-balance-sim-par

Get a SimulationParameter JSON with outputs for thermal load balances.

Args:
ddy_file: Full path to a DDY file that will be used to specify design days
within the simulation parameter.
honeybee-energy settings load-balance-sim-par [OPTIONS] DDY_FILE

Options

-lt, --load-type <load_type>

A text value to set the type of load outputs requested. Choose from the following: All - all energy use including heat lost from the zone Total - the total load added to the zone (both sensible and latent) Sensible - the sensible load added to the zone Latent - the latent load added to the zone.

Default

Total

-rp, --run-period <run_period>

An AnalysisPeriod or RunPeriod string to dictate the start and end of the simulation (eg. “6/21 to 9/21 between 0 and 23 @1”). If unspecified, the simulation will be for the whole year.

-n, --north <north>

Number from -360 to 360 for the counterclockwise difference between North and the positive Y-axis in degrees. 90 is west; 270 is east

Default

0

--filter-des-days, -all, --all-des-days

Flag to note whether the design days in the ddy-file should be filtered to only include 99.6 and 0.4 design days.

Default

True

-f, --output-file <output_file>

Optional file to output the JSON string of the simulation parameters. By default, it will be printed to stdout.

Default

Arguments

DDY_FILE

Required argument

orientation-sim-pars

Get SimulationParameter JSONs with different north angles for orientation studies.

Args:
ddy_file: Full path to a DDY file that will be used to specify design days
within the simulation parameter.
north_angles: Any number of values between -360 and 360 for the counterclockwise
difference between the North and the positive Y-axis in degrees. 90 is
West and 270 is East.
honeybee-energy settings orientation-sim-pars [OPTIONS] DDY_FILE
                                              [NORTH_ANGLES]...

Options

-o, --output-name <output_name>

Any number of EnergyPlus output names as strings (eg. Surface Window System Solar Transmittance). These outputs will be requested from the simulation.

-rp, --run-period <run_period>

An AnalysisPeriod or RunPeriod string to dictate the start and end of the simulation (eg. “6/21 to 9/21 between 0 and 23 @1”). If unspecified, the simulation will be for the whole year.

-n, --start-north <start_north>

Number from -360 to 360 for the starting north angle. This will be added to the north-angles in order to shift all norths.

Default

0

--filter-des-days, -all, --all-des-days

Flag to note whether the design days in the ddy-file should be filtered to only include 99.6 and 0.4 design days.

Default

True

-f, --folder <folder>

Output folder for the simulation parameter JSONS.

-log, --log-file <log_file>

Optional log file to output the paths of the simulation parameters. By default the list will be printed out to stdout.

Arguments

DDY_FILE

Required argument

NORTH_ANGLES

Optional argument(s)

run-period

Get a RunPeriod string that can be used to set the simulation run period.

Args:
start_month: Start month (1-12).
start_day: Start day (1-31).
end_month: End month (1-12).
end_day: End day (1-31).
honeybee-energy settings run-period [OPTIONS] START_MONTH START_DAY END_MONTH
                                    END_DAY

Options

-dow, --start-day-of-week <start_day_of_week>

Text for the day of the week on which the simulation starts.

Default

Sunday

-h, --holidays <holidays>

Text for the holidays within the simulation. Dates should be formatted as follows: “[day int] [month text]” (eg. “25 Dec”). If not specified, no holidays are applied.

-f, --output-file <output_file>

Optional file to output the JSON string of the run period. By default, it will be printed to stdout.

Default

Arguments

START_MONTH

Required argument

START_DAY

Required argument

END_MONTH

Required argument

END_DAY

Required argument

sizing-sim-par

Get a SimulationParameter JSON with outputs and run period for HVAC sizing.

Args:
ddy_file: Full path to a DDY file that will be used to specify design days
within the simulation parameter.
honeybee-energy settings sizing-sim-par [OPTIONS] DDY_FILE

Options

-lt, --load-type <load_type>

A text value to set the type of load outputs requested. Choose from the following: All - all energy use including heat lost from the zone Total - the total load added to the zone (both sensible and latent) Sensible - the sensible load added to the zone Latent - the latent load added to the zone.

Default

Total

-n, --north <north>

Number from -360 to 360 for the counterclockwise difference between North and the positive Y-axis in degrees. 90 is west; 270 is east

Default

0

--filter-des-days, -all, --all-des-days

Flag to note whether the design days in the ddy-file should be filtered to only include 99.6 and 0.4 design days.

Default

True

-f, --output-file <output_file>

Optional file to output the JSON string of the simulation parameters. By default, it will be printed to stdout.

Default

Arguments

DDY_FILE

Required argument