honeybee_ph.site module

Passive-House Style Monthly Climate Data

class honeybee_ph.site.Climate(_display_name: str = 'New York', _station_elevation: float = 0.0, _daily_temp_swing: float = 8.0, _average_wind_speed: float = 4.0, _monthly_temps: Climate_MonthlyTempCollection = Climate_MonthlyTempCollection(identifier='02846ee7', user_data={}), _monthly_radiation: Climate_MonthlyRadiationCollection = Climate_MonthlyRadiationCollection(identifier='dcf777b3', user_data={}), _peak_loads: Climate_PeakLoadCollection = Climate_PeakLoadCollection(identifier='a0ddb3e1', user_data={}))

Bases: _Base

ToString()

duplicate() → Climate

classmethod from_dict(_input_dict: Dict) → Climate

set_base_attrs_from_source(_source)

to_dict() → Dict

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property identifier

property identifier_short

class honeybee_ph.site.Climate_Ground

Bases: _Base

ToString()

duplicate() → Climate_Ground

classmethod from_dict(_input_dict: Dict) → Climate_Ground

set_base_attrs_from_source(_source)

to_dict() → Dict

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property identifier

property identifier_short

class honeybee_ph.site.Climate_MonthlyRadiationCollection(_north=Climate_MonthlyValueSet(identifier='79db0648', user_data={}), _east=Climate_MonthlyValueSet(identifier='5988b777', user_data={}), _south=Climate_MonthlyValueSet(identifier='5c8f68f9', user_data={}), _west=Climate_MonthlyValueSet(identifier='9742f5c1', user_data={}), _glob=Climate_MonthlyValueSet(identifier='b6174a9e', user_data={}))

Bases: _Base

ToString()

duplicate() → Climate_MonthlyRadiationCollection

classmethod from_dict(_input_dict: Dict[str, Dict[str, float]]) → Climate_MonthlyRadiationCollection

set_base_attrs_from_source(_source)

to_dict() → Dict[str, Dict[str, float]]

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property identifier

property identifier_short

class honeybee_ph.site.Climate_MonthlyTempCollection(_air: Climate_MonthlyValueSet = Climate_MonthlyValueSet(identifier='c67582c3', user_data={}), _dewpoint: Climate_MonthlyValueSet = Climate_MonthlyValueSet(identifier='0058cf3e', user_data={}), _sky: Climate_MonthlyValueSet = Climate_MonthlyValueSet(identifier='98aeb428', user_data={}), _ground: Climate_MonthlyValueSet = Climate_MonthlyValueSet(identifier='cf008224', user_data={}))

Bases: _Base

Collection class to organize monthly temperature values

ToString()

duplicate() → Climate_MonthlyTempCollection

classmethod from_dict(_input_dict: Dict[str, Dict[str, float]]) → Climate_MonthlyTempCollection

set_base_attrs_from_source(_source)

to_dict() → Dict[str, Dict[str, float]]

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property identifier

property identifier_short

class honeybee_ph.site.Climate_MonthlyValueSet(_values: Collection[float] = [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0])

Bases: _Base

A set of 12 monthly values (temp, radiation, etc).

ToString()

duplicate() → Climate_MonthlyValueSet

classmethod from_dict(_input_dict: Dict[str, float]) → Climate_MonthlyValueSet

set_base_attrs_from_source(_source)

to_dict() → Dict[str, float]

april = 0.0

august = 0.0

december = 0.0

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

february = 0.0

property identifier

property identifier_short

january = 0.0

july = 0.0

june = 0.0

march = 0.0

may = 0.0

months = ['january', 'february', 'march', 'april', 'may', 'june', 'july', 'august', 'september', 'october', 'november', 'december']

november = 0.0

october = 0.0

september = 0.0

property values: List[float]

class honeybee_ph.site.Climate_PeakLoadCollection(_heat_load_1: Climate_PeakLoadValueSet = Climate_PeakLoadValueSet(identifier='5b59e881', user_data={}), _heat_load_2: Climate_PeakLoadValueSet = Climate_PeakLoadValueSet(identifier='4325d538', user_data={}), _cooling_load_1: Climate_PeakLoadValueSet = Climate_PeakLoadValueSet(identifier='546a5d47', user_data={}), _cooling_load_2: Climate_PeakLoadValueSet = Climate_PeakLoadValueSet(identifier='27733f29', user_data={}))

Bases: _Base

A Collection of Peak Loads (Heating and Cooling).

ToString()

duplicate() → Climate_PeakLoadCollection

classmethod from_dict(_input_dict: Dict) → Climate_PeakLoadCollection

set_base_attrs_from_source(_source)

to_dict() → Dict[str, Dict[str, float] | str]

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property identifier

property identifier_short

class honeybee_ph.site.Climate_PeakLoadValueSet(_temp: float = 0.0, _rad_north: float = 0.0, _rad_east: float = 0.0, _rad_south: float = 0.0, _rad_west: float = 0.0, _rad_global: float = 0.0, _dewpoint_temp: float | None = None, _sky_temp: float | None = None, _ground_temp: float | None = None)

Bases: _Base

A set of Peak Load data.

ToString()

duplicate() → Climate_PeakLoadValueSet

classmethod from_dict(_input_dict: Dict[str, float]) → Climate_PeakLoadValueSet

set_base_attrs_from_source(_source)

to_dict() → Dict[str, float]

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property identifier

property identifier_short

class honeybee_ph.site.Location(latitude: float = 40.6, longitude: float = -73.8, site_elevation: float | None = None, climate_zone: int = 1, hours_from_UTC: int = -4)

Bases: _Base

Geographic Location Information.

ToString()

duplicate() → Location

classmethod from_dict(_input_dict: dict) → Location

set_base_attrs_from_source(_source)

to_dict() → Dict

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property identifier

property identifier_short

class honeybee_ph.site.PHPPCodes(_country_code: str = 'US-United States of America', _region_code: str = 'New York', _dataset_name: str = 'US0055c-New York')

Bases: _Base

Settings / names if using Pre-loaded PHPP Library Data

ToString()

duplicate() → PHPPCodes

classmethod from_dict(_input_dict: Dict) → PHPPCodes

set_base_attrs_from_source(_source)

to_dict() → Dict

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property identifier

property identifier_short

class honeybee_ph.site.Site(_location: Location = Location(identifier='2a4cb781', user_data={}), _climate: Climate = Climate(identifier='ae8bb710', user_data={}), _phpp_library_codes: PHPPCodes = PHPPCodes(identifier='10dbdd39', user_data={}))

Bases: _Base

Location and Climate data for the building site.

ToString()

duplicate() → Site

classmethod from_dict(_input_dict: Dict[str, Any]) → Site

set_base_attrs_from_source(_source)

to_dict() → Dict[str, Any]

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property identifier

property identifier_short