honeybee_energy_ph.properties.ruleset module¶

Properties classes for PH-ScheduleRuleset objects.

exception honeybee_energy_ph.properties.ruleset.ScheduleRulesetPhProperties_FromDictError(_expected_types, _input_type)[source]¶

Bases: Exception

with_traceback()¶: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args¶

class honeybee_energy_ph.properties.ruleset.DailyOperatingPeriodCollection[source]¶

Bases: object

A collection of DailyOperatingPeriods. Ventilation may have more than one period.

ToString()[source]¶

add_period_to_collection(_period: DailyOperationPeriod) → None[source]¶

classmethod from_dict(_input_dict: dict[str, Any]) → DailyOperatingPeriodCollection[source]¶

to_dict() → dict[str, Any][source]¶

property fist_period: DailyOperationPeriod | None¶: Returns the first Operating Period in the collection, or None if collection is empty.

class honeybee_energy_ph.properties.ruleset.DailyOperationPeriod[source]¶

Bases: object

PH-Style Daily Operating Period.

ToString()[source]¶: Overwrite .NET ToString.

classmethod from_annual_utilization_factor(_ann_util_fac: float = 1.0, _name: str = '') → DailyOperationPeriod[source]¶

classmethod from_dict(_dict: dict[str, float]) → DailyOperationPeriod[source]¶

classmethod from_operating_hours(_op_hours: float = 24, _op_frac: float = 1.0, _name: str = '') → DailyOperationPeriod[source]¶

classmethod from_start_end_hours(_start_hr: float = 0, _end_hr: float = 24, _op_frac: float = 1.0, _name: str = '') → DailyOperationPeriod[source]¶

to_dict() → dict[str, float][source]¶

property operation_hours: float¶

property weighted_operation_hours: float¶

class honeybee_energy_ph.properties.ruleset.ScheduleRulesetPhProperties(_host)[source]¶

Bases: object

Honeybee-Energy-PH ScheduleRulesetPhProperties for managing PH-style schedule data.

ToString()[source]¶: Overwrite .NET ToString.

apply_properties_from_dict(abridged_data)[source]¶

classmethod from_days_per_week(_days_per_wk: float, _wks_per_year: float, _host: Any) → ScheduleRulesetPhProperties[source]¶: Construct a new Schedule based on day-per-week usage data

classmethod from_days_per_year(_days_per_year: float, _host: Any) → ScheduleRulesetPhProperties[source]¶: Construct a new Schedule based on day-per-year usage data.

classmethod from_dict(_dict: dict, host: Any) → ScheduleRulesetPhProperties[source]¶

to_dict(abridged: bool = False) → dict[str, Any][source]¶

validate_operating_period_hours(_total_period_hours: float = 24.0) → str | None[source]¶: Returns a warning if the total daily operating period hours do not equal the specified _total_period_hours.

property annual_average_operating_fraction: float¶: The annual average operating (utilization) fraction (0-1.0).

property first_operating_period: DailyOperationPeriod | None¶

property host¶

property operating_days_year: float¶: The Schedule’s total operating days per year.