honeybee_energy.simulation.sizing module

Parameters with criteria for sizing the heating and cooling system.

class honeybee_energy.simulation.sizing.SizingParameter(design_days=None, heating_factor=1.25, cooling_factor=1.15, efficiency_standard=None, climate_zone=None, building_type=None, bypass_efficiency_sizing=False)[source]

Bases: object

Sizing parameters with criteria for sizing the heating and cooling system.

Parameters

  • design_days – An array of Ladybug DesignDay objects that represent the criteria for which the HVAC systems will be sized. (Default: None).

  • heating_factor – A number that will get multiplied by the peak heating load for each zone in the model in order to size the heating system for the model. Must be greater than 0. (Default: 1.25).

  • cooling_factor – A number that will get multiplied by the peak cooling load for each zone in the model in order to size the cooling system for the model. Must be greater than 0. (Default: 1.15).

  • efficiency_standard –

    Text to specify the efficiency standard, which will automatically set the efficiencies of all HVAC equipment when provided. Note that providing a standard here will cause the OpenStudio translation process to perform an additional sizing calculation with EnergyPlus, which is needed since the default efficiencies of equipment vary depending on their size. THIS WILL SIGNIFICANTLY INCREASE TRANSLATION TIME. However, it is often worthwhile when the goal is to match the HVAC specification with a particular standard. (Default: None). Choose from the following.

    • DOE_Ref_Pre_1980

    • DOE_Ref_1980_2004

    • ASHRAE_2004

    • ASHRAE_2007

    • ASHRAE_2010

    • ASHRAE_2013

    • ASHRAE_2016

    • ASHRAE_2019

  • climate_zone – Text indicating the ASHRAE climate zone to be used with the efficiency_standard. When unspecified, the climate zone will be inferred from the design days. This input 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).

  • building_type –

    Text for the building type to be used in the efficiency_standard. If the type is not recognized or is None, it will be assumed that the building is a generic NonResidential. The following have meaning for the standard.

    • NonResidential

    • Residential

    • MidriseApartment

    • HighriseApartment

    • LargeOffice

    • MediumOffice

    • SmallOffice

    • Retail

    • StripMall

    • PrimarySchool

    • SecondarySchool

    • SmallHotel

    • LargeHotel

    • Hospital

    • Outpatient

    • Warehouse

    • SuperMarket

    • FullServiceRestaurant

    • QuickServiceRestaurant

    • Laboratory

    • Courthouse

  • bypass_efficiency_sizing – A boolean to indicate whether the efficiency standard should trigger an sizing run that sets the efficiencies of all HVAC equipment in the Model (False) or the standard should only be written into the OSM and the sizing run should be bypassed (True). Bypassing the sizing run is useful when you only want to check that the overall HVAC system architecture is correct and you do not want to wait the extra time that it takes to run the sizing calculation. (Default: False).

Properties:

  • design_days

  • heating_factor

  • cooling_factor

  • efficiency_standard

  • climate_zone

  • building_type

  • bypass_efficiency_sizing

ToString()[source]

Overwrite .NET ToString.

add_design_day(design_day)[source]

Add a ladybug DesignDay to this object’s design_days.

Parameters

design_day – A Ladybug DesignDay object to be added to this object.

add_from_ddy(ddy_file)[source]

Add all design days within a .ddy file to this object.

Parameters

ddy_file – The full path to a .ddy file on this machine.

add_from_ddy_990_010(ddy_file)[source]

Add the 99.0% and 1.0% design days within a .ddy file to this object.

99.0% means that this percent of the hours of the year have outside heating conditions warmer than this design day. 1.0% means that this percent of the hours of the year have outside cooling conditions cooler than this design day.

Parameters

ddy_file – The full path to a .ddy file on this machine.

add_from_ddy_996_004(ddy_file)[source]

Add the 99.6% and 0.4% design days within a .ddy file to this object.

99.6% means that this percent of the hours of the year have outside heating conditions warmer than this design day. 0.4% means that this percent of the hours of the year have outside cooling conditions cooler than this design day.

Parameters

ddy_file – The full path to a .ddy file on this machine.

add_from_ddy_keyword(ddy_file, keyword)[source]

Add DesignDays from a .ddy file using a keyword in the DesignDay name.

Parameters

  • ddy_file – The full path to a .ddy file on this machine.

  • keyword – String for a keyword, which will be used to select DesignDays from the .ddy file to add to this object.

apply_location(location)[source]

Apply a Ladybug Location object to all of the DesignDays in this object.

This is particularly handy after re-serialization from an IDF since the IDF does not store the location information in the DesignDay.

Parameters

location – A Ladybug Location object.

duplicate()[source]

Get a copy of this object.

classmethod from_dict(data)[source]

Create a SizingParameter object from a dictionary.

Parameters

data – A SizingParameter dictionary in following the format.

{
"type": "SizingParameter",
"design_days": [],  # Array of Ladybug DesignDay dictionaries
"heating_factor": 1.25,
"cooling_factor": 1.15,
"efficiency_standard": "ASHRAE_2004",  # standard for HVAC efficiency
"climate_zone": "5A",  # climate zone for HVAC efficiency
"building_type": "LargeOffice",  # building type for HVAC efficiency
"bypass_efficiency_sizing": False  # bypass the efficiency sizing run
}
classmethod from_idf(design_days=None, sizing_parameter=None, location=None)[source]

Create a SizingParameter object from an EnergyPlus IDF text string.

Parameters

  • design_days – An array of of IDF SizingPeriod:DesignDay strings that represent the criteria for which the HVAC systems will be sized. If None, no sizing criteria will be included. Default: None.

  • sizing_parameter – A text string for an EnergyPlus Sizing:Parameters definition. If None, defaults of 1.25 anf 1.15 will be used. Default: None.

  • location – An optional Ladybug Location object, which gets assigned to the DesignDay objects in order to interpret their SkyConditions. This object is not used in the export to IDF. If None, the intersection of the equator with the prime meridian will be used. Default: None.

remove_all_design_days()[source]

Remove all DesignDays from this object.

remove_design_day(design_day_index)[source]

Remove a single DesignDay from this object using an index.

Parameters

design_day_index – An integer for the index of the DesignDay to remove.

remove_design_day_keyword(keyword)[source]

Remove DesignDays from this object using a keyword in the DesignDay names.

Parameters

keyword – String for a keyword, which will be used to select DesignDays for deletion from this object.

to_ddy()[source]

Get this SizingParameter as a Ladybug DDY object.

This can be written to a .ddy file if so desired.

to_dict()[source]

SizingParameter dictionary representation.

to_idf()[source]

Get an EnergyPlus string representation of the SizingParameters.

Returns

A tuple with two elements

  • design_days: An array of of IDF SizingPeriod:DesignDay strings.

  • sizing_parameter: A text string for an EnergyPlus Sizing:Parameters definition.

CLIMATE_ZONES = ('0A', '1A', '2A', '3A', '4A', '5A', '6A', '0B', '1B', '2B', '3B', '4B', '5B', '6B', '3C', '4C', '5C', '7', '8')
STANDARDS = ('DOE_Ref_Pre_1980', 'DOE_Ref_1980_2004', 'ASHRAE_2004', 'ASHRAE_2007', 'ASHRAE_2010', 'ASHRAE_2013', 'ASHRAE_2016', 'ASHRAE_2019')
property building_type

Get or set text for the building type associated with the efficiency standard.

If the type is not recognized or is None, it will be assumed that the building is a generic NonResidential.

property bypass_efficiency_sizing

Get or set a boolean for whether efficiency standard triggers a sizing run.

property climate_zone

Get or set text for the climate zone associated with the efficiency standard.

When unspecified, the climate zone will be inferred from the design days. This input 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).

property cooling_factor

Get or set a number that will get multiplied by the peak cooling loads.

property design_days

Get or set an array of Ladybug DesignDay objects for sizing criteria.

property efficiency_standard

Get or set text for the efficiency standard.

When specified, this will automatically set the efficiencies of all HVAC equipment. Note that setting this variable will cause the OpenStudio translation process to perform an additional sizing calculation with EnergyPlus, which is needed since the default efficiencies of equipment vary depending on their size. So THIS WILL SIGNIFICANTLY INCREASE TRANSLATION TIME. However, it is often worthwhile when the goal is to match the HVAC specification with a particular standard. Choose from the following.

  • DOE_Ref_Pre_1980

  • DOE_Ref_1980_2004

  • ASHRAE_2004

  • ASHRAE_2007

  • ASHRAE_2010

  • ASHRAE_2013

  • ASHRAE_2016

  • ASHRAE_2019

property heating_factor

Get or set a number that will get multiplied by the peak heating loads.