baseline

honeybee-energy baseline

Commands for creating baseline buildings conforming to standards.

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

appendix-g-summary

Get a JSON with a summary of ASHRAE-90.1 Appendix G performance.

This includes Appendix G performance for versions 2016, 2019, and 2022.

Args:

proposed_sql: The path of the SQL result file that has been generated from an

energy simulation of a proposed building.

baseline_sqls: The path of a directory with several SQL result files generated

from an energy simulation of a baseline building (eg. for several

simulations of different orientations). The baseline performance will

be computed as the average across all SQL files in the directory.

climate_zone: Text indicating the ASHRAE climate zone. This can be a single

integer (in which case it is interpreted as A) or it can include the

A, B, or C qualifier (eg. 3C).

honeybee-energy baseline appendix-g-summary [OPTIONS] PROPOSED_SQL
                                            BASELINE_SQLS... CLIMATE_ZONE

Options

-b, --building-type <building_type>

Text for the building type that the Model represents. This is used to determine the baseline window-to-wall ratio and HVAC system. If the type is not recognized or is “Unknown”, it will be assumed that the building is a generic NonResidential. The following have meaning per the standard: Residential, NonResidential, MidriseApartment, HighriseApartment, LargeOffice, MediumOffice, SmallOffice, Retail, StripMall, PrimarySchool, SecondarySchool, SmallHotel, LargeHotel, Hospital, Outpatient, Warehouse, SuperMarket, FullServiceRestaurant, QuickServiceRestaurant, Laboratory, Courthouse

Default

NonResidential

-e, --electricity-cost <electricity_cost>

A number for the cost per each kWh of electricity. This can be in any currency as long as it is coordinated with the costs of other inputs to this method. (Default: 0.12 for the average 2020 cost of electricity in the US in $/kWh).

Default

0.12

-g, --natural-gas-cost <natural_gas_cost>

A number for the cost per each kWh of natural gas. This can be in any currency as long as it is coordinated with the costs of other inputs to this method. (Default: 0.06 for the average 2020 cost of natural gas in the US in $/kWh).

Default

0.06

-dc, --district-cooling-cost <district_cooling_cost>

A number for the cost per each kWh of district cooling energy. This can be in any currency as long as it is coordinated with the costs of other inputs to this method. (Default: 0.04 assuming average 2020 US cost of electricity in $/kWh with a COP 3.5 chiller).

Default

0.04

-dh, --district-heating-cost <district_heating_cost>

A number for the cost per each kWh of district heating energy. This can be in any currency as long as it is coordinated with the costs of other inputs to this method. (Default: 0.08 assuming average 2020 US cost of natural gas in $/kWh with an efficiency of 0.75 with all burner and distribution losses).

Default

0.08

-f, --output-file <output_file>

Optional json file to output the JSON string of the summary report. By default this will be printed out to stdout

Default

-

Arguments

PROPOSED_SQL

Required argument

BASELINE_SQLS

Required argument(s)

CLIMATE_ZONE

Required argument

constructions

Convert a Model’s constructions to be conformant with ASHRAE 90.1-2004 appendix G.

This includes assigning a ConstructionSet that is compliant with Table 5.5 to all rooms in the model.

Args:

model_file: Full path to a Honeybee Model file.

climate_zone: Text indicating the ASHRAE climate zone. This can be a single

integer (in which case it is interpreted as A) or it can include the

A, B, or C qualifier (eg. 3C).

honeybee-energy baseline constructions [OPTIONS] MODEL_FILE CLIMATE_ZONE

Options

-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

CLIMATE_ZONE

Required argument

create

Convert a Model to be conformant with ASHRAE 90.1 appendix G.

This includes running all other functions contained within this group to adjust the geometry, constructions, lighting, HVAC, SHW, and remove any clearly-defined energy conservation measures like daylight controls. Note that all schedules are essentially unchanged, meaning that additional post-processing of setpoints may be necessary to account for energy conservation strategies like expanded comfort ranges, ceiling fans, and personal thermal comfort devices. It may also be necessary to adjust electric equipment loads in cases where such equipment qualifies as an energy conservation strategy or hot water loads in cases where low-flow fixtures are implemented.

Note that not all versions of ASHRAE 90.1 use this exact definition of a baseline model but version 2016 and onward conform to it. It is essentially an adjusted version of the 90.1-2004 methods.

Args:

model_file: Full path to a Honeybee Model file.

climate_zone: Text indicating the ASHRAE climate zone. This can be a single

integer (in which case it is interpreted as A) or it can include the

A, B, or C qualifier (eg. 3C).

honeybee-energy baseline create [OPTIONS] MODEL_FILE CLIMATE_ZONE

Options

-b, --building-type <building_type>

Text for the building type that the Model represents. This is used to determine the baseline window-to-wall ratio and HVAC system. If the type is not recognized or is “Unknown”, it will be assumed that the building is a generic NonResidential. The following have specified systems per the standard: Residential, NonResidential, MidriseApartment, HighriseApartment, LargeOffice, MediumOffice, SmallOffice, Retail, StripMall, PrimarySchool, SecondarySchool, SmallHotel, LargeHotel, Hospital, Outpatient, Warehouse, SuperMarket, FullServiceRestaurant, QuickServiceRestaurant, Laboratory

Default

NonResidential

-a, --floor-area <floor_area>

A number for the floor area of the building that the model is a part of in m2. If None or 0, the model floor area will be used.

Default

0

-s, --story-count <story_count>

An integer for the number of stories of the building that the model is a part of. If None or 0, the model stories will be used.

Default

0

--lighting-by-space, -lb, --lighting-by-building

Flag to note whether the building-type should be used to assign the baseline lighting power density, which will use the same value for all Rooms in the model, or a space-by-space method should be used. To use the space-by-space method, the model should either be built with the programs that ship with Ladybug Tools in honeybee-energy-standards or the baseline_watts_per_area should be correctly assigned for all Rooms.

-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

CLIMATE_ZONE

Required argument

geometry

Convert a Model’s geometry to be conformant with ASHRAE 90.1-2004 appendix G.

This includes stripping out all attached shades (leaving detached shade as context), reducing the vertical glazing ratio to 40% it it’s above this value, and reducing the skylight ratio to 5% if it’s above this value.

Args:

model_file: Path to a Honeybee Model file.

honeybee-energy baseline geometry [OPTIONS] MODEL_FILE

Options

-b, --building-type <building_type>

Text for the building type that the Model represents. This is used to set the maximum window ratio for the model. If the type is not recognized or is “Unknown”, a maximum of 0.4 shall be used. The following have specified ratios per the standard: LargeOffice, MediumOffice, SmallOffice, Retail, StripMall, PrimarySchool, SecondarySchool, SmallHotel, LargeHotel, Hospital, Outpatient, Warehouse, SuperMarket, FullServiceRestaurant, QuickServiceRestaurant

Default

NonResidential

-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

hvac

Convert a Model’s HVAC to be conformant with ASHRAE 90.1-2004 appendix G.

This includes the selection of the correct Appendix G template HVAC based on the inputs and the application of this HVAC to all conditioned spaces in the model.

Args:

model_file: Full path to a Honeybee Model file.

climate_zone: Text indicating the ASHRAE climate zone. This can be a single

integer (in which case it is interpreted as A) or it can include the

A, B, or C qualifier (eg. 3C).

honeybee-energy baseline hvac [OPTIONS] MODEL_FILE CLIMATE_ZONE

Options

-b, --building-type <building_type>

Text for the building type that the Model represents. This is used to determine the baseline system. If the type is not recognized or is “Unknown”, it will be assumed that the building is a generic NonResidential. The following have specified systems per the standard: Residential, NonResidential, MidriseApartment, HighriseApartment, LargeOffice, MediumOffice, SmallOffice, Retail, StripMall, PrimarySchool, SecondarySchool, SmallHotel, LargeHotel, Hospital, Outpatient, Warehouse, SuperMarket, FullServiceRestaurant, QuickServiceRestaurant, Laboratory

Default

NonResidential

-a, --floor-area <floor_area>

A number for the floor area of the building that the model is a part of in m2. If None or 0, the model floor area will be used.

Default

0

-s, --story-count <story_count>

An integer for the number of stories of the building that the model is a part of. If None or 0, the model stories will be used.

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

CLIMATE_ZONE

Required argument

leed-v4-summary

Get a JSON with a summary of LEED V4 (and 4.1) performance.

This includes ASHRAE 90.1-2016 Appendix G performance for both cost and carbon (GHG) emissions as well as the estimated number of LEED “Optimize Energy Performance” points.

Args:

proposed_sql: The path of the SQL result file that has been generated from an

energy simulation of a proposed building.

baseline_sqls: The path of a directory with several SQL result files generated

from an energy simulation of a baseline building (eg. for several

simulations of different orientations). The baseline performance will

be computed as the average across all SQL files in the directory.

climate_zone: Text indicating the ASHRAE climate zone. This can be a single

integer (in which case it is interpreted as A) or it can include the

A, B, or C qualifier (eg. 3C).

honeybee-energy baseline leed-v4-summary [OPTIONS] PROPOSED_SQL
                                         BASELINE_SQLS... CLIMATE_ZONE

Options

-b, --building-type <building_type>

Text for the building type that the Model represents. This is used to determine the baseline window-to-wall ratio and HVAC system. If the type is not recognized or is “Unknown”, it will be assumed that the building is a generic NonResidential. The following have meaning per the standard: Residential, NonResidential, MidriseApartment, HighriseApartment, LargeOffice, MediumOffice, SmallOffice, Retail, StripMall, PrimarySchool, SecondarySchool, SmallHotel, LargeHotel, Hospital, Outpatient, Warehouse, SuperMarket, FullServiceRestaurant, QuickServiceRestaurant, Laboratory, Courthouse

Default

NonResidential

-e, --electricity-cost <electricity_cost>

A number for the cost per each kWh of electricity. This can be in any currency as long as it is coordinated with the costs of other inputs to this method. (Default: 0.12 for the average 2020 cost of electricity in the US in $/kWh).

Default

0.12

-g, --natural-gas-cost <natural_gas_cost>

A number for the cost per each kWh of natural gas. This can be in any currency as long as it is coordinated with the costs of other inputs to this method. (Default: 0.06 for the average 2020 cost of natural gas in the US in $/kWh).

Default

0.06

-dc, --district-cooling-cost <district_cooling_cost>

A number for the cost per each kWh of district cooling energy. This can be in any currency as long as it is coordinated with the costs of other inputs to this method. (Default: 0.04 assuming average 2020 US cost of electricity in $/kWh with a COP 3 chiller).

Default

0.04

-dh, --district-heating-cost <district_heating_cost>

A number for the cost per each kWh of district heating energy. This can be in any currency as long as it is coordinated with the costs of other inputs to this method. (Default: 0.08 assuming average 2020 US cost of natural gas in $/kWh with an efficiency of 0.75 with all burner and distribution losses).

Default

0.08

-ee, --electricity-emissions <electricity_emissions>

A number for the electric grid carbon emissions in kg CO2 per MWh. For locations in the USA, this can be obtained from he honeybee_energy.result.emissions future_electricity_emissions method. For locations outside of the USA where specific data is unavailable, the following rules of thumb may be used as a guide. (Default: 400). 800 kg/MWh - for an inefficient coal or oil-dominated grid 400 kg/MWh - for the US (energy mixed) grid around 2020 100-200 kg/MWh - for grids with majority renewable/nuclear composition 0-100 kg/MWh - for grids with renewables and storage

Default

400

-f, --output-file <output_file>

Optional json file to output the JSON string of the summary report. By default this will be printed out to stdout

Default

-

Arguments

PROPOSED_SQL

Required argument

BASELINE_SQLS

Required argument(s)

CLIMATE_ZONE

Required argument

lighting

Convert a Model’s lighting to be conformant with ASHRAE 90.1-2004 appendix G.

This includes determining whether an ASHRAE 2004 equivalent exists for each program type in the model. If none is found, the baseline_watts_per_area on the room’s program’s lighting will be used, which will default to a typical office if none has been specified.

Args:

model_file: Full path to a Honeybee Model file.

honeybee-energy baseline lighting [OPTIONS] MODEL_FILE

Options

-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

remove-ecms

Remove energy conservation strategies (ECMs) not associated with baseline models.

This includes removing the opening behavior of all operable windows, daylight controls, etc.

Args:

model_file: Full path to a Honeybee Model file.

honeybee-energy baseline remove-ecms [OPTIONS] MODEL_FILE

Options

-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

shw

Convert a Model’s geometry to be conformant with ASHRAE 90.1-2004 appendix G.

This includes stripping out all attached shades (leaving detached shade as context), reducing the vertical glazing ratio to 40% it it’s above this value, and reducing the skylight ratio to 5% if it’s above this value.

Args:

model_file: Path to a Honeybee Model file.

honeybee-energy baseline shw [OPTIONS] MODEL_FILE

Options

-b, --building-type <building_type>

Text for the building type that the Model represents. This is used to determine the baseline system. If the type is not recognized or is “Unknown”, it will be assumed that the building is a generic NonResidential. The following have specified systems per the standard: Residential, NonResidential, MidriseApartment, HighriseApartment, LargeOffice, MediumOffice, SmallOffice, Retail, StripMall, PrimarySchool, SecondarySchool, SmallHotel, LargeHotel, Hospital, Outpatient, Warehouse, SuperMarket, FullServiceRestaurant, QuickServiceRestaurant, Laboratory

Default

NonResidential

-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