preheat_open.zone.Zone

class preheat_open.zone.Zone(zone_data, parent_zone=None, building=None)

Bases: object

Defines a building zone in the PreHEAT sense

__init__(zone_data, parent_zone=None, building=None)

Methods

__init__(zone_data[, parent_zone, building])
add_coupled_unit(unit)	rtype: None
clear_comfort_profile_data()	Clears the comfort profile data loaded in the building object (therefore also the zone)
describe([children, prefix, display])	rtype: str
get_parent_zone()	rtype: Zone
get_sub_zones([zone_ids])	rtype: list[Zone]
get_type()	Returns the type of the zone ('room', 'stairway', 'corridor', 'bathroom', 'kitchen') and its 'dryness' ('dry', 'wet', '?')
get_unit_types([sub_zones])	Return as list of the coupled unit types
get_units(unit_type[, sub_zones])	Returns the coupled units of a given type
load_comfort_profile_data(start, end)	Loads the comfort profile data in the building object
query_zones([zone_id, zone_type])	rtype: list[Zone]

Attributes

comfort_profile_data

Accessor to the comfort profile data of the given zone (or its parents).

clear_comfort_profile_data()

Clears the comfort profile data loaded in the building object (therefore also the zone)

Return type:

None

property comfort_profile_data: DataFrame

Accessor to the comfort profile data of the given zone (or its parents). This requires prior loading via the load_comfort_profile_data method.

If no comfort profile is defined in the zone and the building only has one, then it falls back to the comfort profile at building level.

Raises NoComfortProfileError if no data is loaded or available

Returns:

comfort profile in format: dataframe[setpoint, min, max, value]

get_type()

Returns the type of the zone (‘room’, ‘stairway’, ‘corridor’, ‘bathroom’, ‘kitchen’) and its ‘dryness’ (‘dry’, ‘wet’, ‘?’)

Return type:

tuple[Optional[str], str]

Returns:

zone_type, wet_or_dry

get_unit_types(sub_zones=True)

Return as list of the coupled unit types

Return type:

list[str]

get_units(unit_type, sub_zones=True)

Returns the coupled units of a given type

Parameters:

• unit_type – str

• sub_zones – bool (True)

Return type:

list[BaseBuildingUnit]

Returns:

list(BuildingUnit) or None

load_comfort_profile_data(start, end)

Loads the comfort profile data in the building object

Parameters:

• start (Union[str, datetime]) – start of the period

• end (Union[str, datetime]) – end of the period

Return type:

None