open-fdd 0.1.8__py3-none-any.whl → 0.1.9__py3-none-any.whl

open_fdd/air_handling_unit/faults/fault_condition_fourteen.py

@@ -0,0 +1,177 @@
+import numpy as np
+import pandas as pd
+
+from open_fdd.core.base_fault import BaseFaultCondition
+from open_fdd.core.components import FaultInputColumn, InstanceAttribute
+from open_fdd.core.exceptions import InvalidParameterError
+from open_fdd.core.mixins import FaultConditionMixin
+
+INPUT_COLS = [
+    FaultInputColumn(
+        name="clg_coil_enter_temp_col",
+        constant_form="CLG_COIL_ENTER_TEMP_COL",
+        description="Cooling coil entering air temperature",
+        unit="°F",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="clg_coil_leave_temp_col",
+        constant_form="CLG_COIL_LEAVE_TEMP_COL",
+        description="Cooling coil leaving air temperature",
+        unit="°F",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="cooling_sig_col",
+        constant_form="COOLING_SIG_COL",
+        description="Cooling signal",
+        unit="%",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="heating_sig_col",
+        constant_form="HEATING_SIG_COL",
+        description="Heating signal",
+        unit="%",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="economizer_sig_col",
+        constant_form="ECONOMIZER_SIG_COL",
+        description="Economizer signal",
+        unit="%",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="supply_vfd_speed_col",
+        constant_form="SUPPLY_VFD_SPEED_COL",
+        description="Supply fan VFD speed",
+        unit="%",
+        required=True,
+        type=float,
+    ),
+]
+
+FAULT_PARAMS = [
+    InstanceAttribute(
+        name="delta_t_supply_fan",
+        constant_form="DELTA_T_SUPPLY_FAN",
+        description="Temperature rise across supply fan",
+        unit="°F",
+        type=float,
+        range=(0.0, 5.0),
+    ),
+    InstanceAttribute(
+        name="coil_temp_enter_err_thres",
+        constant_form="COIL_TEMP_ENTER_ERR_THRES",
+        description="Cooling coil entering air temperature error threshold",
+        unit="°F",
+        type=float,
+        range=(0.0, 10.0),
+    ),
+    InstanceAttribute(
+        name="coil_temp_leave_err_thres",
+        constant_form="COIL_TEMP_LEAV_ERR_THRES",
+        description="Cooling coil leaving air temperature error threshold",
+        unit="°F",
+        type=float,
+        range=(0.0, 10.0),
+    ),
+    InstanceAttribute(
+        name="ahu_min_oa_dpr",
+        constant_form="AHU_MIN_OA_DPR",
+        description="Minimum outdoor air damper position",
+        unit="fraction",
+        type=float,
+        range=(0.0, 1.0),
+    ),
+]
+
+
+class FaultConditionFourteen(BaseFaultCondition, FaultConditionMixin):
+    """Class provides the definitions for Fault Condition 14.
+    Temperature drop across inactive cooling coil in OS1 (heating) and OS2 (economizer) modes.
+    This fault checks if there is an unexpected temperature drop across the cooling coil
+    when it should be inactive.
+
+    py -3.12 -m pytest open_fdd/tests/ahu/test_ahu_fc14.py -rP -s
+    """
+
+    input_columns = INPUT_COLS
+    fault_params = FAULT_PARAMS
+    equation_string = (
+        "fc14_flag = 1 if (CLG_LEAVE < CLG_ENTER - √(εENTER² + εLEAVE²)) "
+        "in OS1 (heating) or OS2 (economizer) modes for N consecutive values else 0 \n"
+    )
+    description_string = (
+        "Fault Condition 14: Temperature drop across inactive cooling coil "
+        "in OS1 (heating) and OS2 (economizer) modes \n"
+    )
+    error_string = "One or more required columns are missing or None \n"
+
+    @FaultConditionMixin._handle_errors
+    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
+        """Apply the fault condition to the DataFrame."""
+        # Apply common checks
+        self._apply_common_checks(df)
+
+        # Get column values using accessor methods
+        cooling_sig_col = self.get_input_column("cooling_sig_col")
+        heating_sig_col = self.get_input_column("heating_sig_col")
+        economizer_sig_col = self.get_input_column("economizer_sig_col")
+        supply_vfd_speed_col = self.get_input_column("supply_vfd_speed_col")
+        clg_coil_enter_temp_col = self.get_input_column("clg_coil_enter_temp_col")
+        clg_coil_leave_temp_col = self.get_input_column("clg_coil_leave_temp_col")
+
+        # Get parameter values using accessor methods
+        coil_temp_enter_err_thres = self.get_param("coil_temp_enter_err_thres")
+        coil_temp_leave_err_thres = self.get_param("coil_temp_leave_err_thres")
+        ahu_min_oa_dpr = self.get_param("ahu_min_oa_dpr")
+
+        # Check analog outputs [data with units of %] are floats only
+        columns_to_check = [
+            cooling_sig_col,
+            heating_sig_col,
+            economizer_sig_col,
+            supply_vfd_speed_col,
+        ]
+        self._apply_analog_checks(df, columns_to_check, check_greater_than_one=True)
+
+        # Calculate the threshold for temperature drop
+        temp_drop_threshold = np.sqrt(
+            coil_temp_enter_err_thres**2 + coil_temp_leave_err_thres**2
+        )
+
+        # Check if there's a significant temperature drop across the cooling coil
+        temp_drop = df[clg_coil_enter_temp_col] - df[clg_coil_leave_temp_col]
+        significant_temp_drop = temp_drop > temp_drop_threshold
+
+        # Check operating modes:
+        # OS1: Heating mode (HTG > 0, CLG = 0, ECO = MIN_OA)
+        os1_mode = (
+            (df[heating_sig_col] > 0.0)
+            & (df[cooling_sig_col] == 0.0)
+            & (df[economizer_sig_col] <= ahu_min_oa_dpr)
+        )
+
+        # OS2: Economizer mode (HTG = 0, CLG = 0, ECO > MIN_OA)
+        os2_mode = (
+            (df[heating_sig_col] == 0.0)
+            & (df[cooling_sig_col] == 0.0)
+            & (df[economizer_sig_col] > ahu_min_oa_dpr)
+        )
+
+        # Combine conditions:
+        # Fault occurs when there's a significant temperature drop across an inactive cooling coil
+        # in either OS1 (heating) or OS2 (economizer) mode
+        combined_check = significant_temp_drop & (os1_mode | os2_mode)
+
+        # Set fault flag
+        self._set_fault_flag(df, combined_check, "fc14_flag")
+
+        return df

open_fdd/air_handling_unit/faults/fault_condition_nine.py

@@ -0,0 +1,140 @@
+import pandas as pd
+
+from open_fdd.core.base_fault import BaseFaultCondition
+from open_fdd.core.components import FaultInputColumn, InstanceAttribute
+from open_fdd.core.exceptions import InvalidParameterError
+from open_fdd.core.mixins import FaultConditionMixin
+
+INPUT_COLS = [
+    FaultInputColumn(
+        name="sat_setpoint_col",
+        constant_form="SAT_SETPOINT_COL",
+        description="Supply air temperature setpoint",
+        unit="°F",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="oat_col",
+        constant_form="OAT_COL",
+        description="Outside air temperature",
+        unit="°F",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="cooling_sig_col",
+        constant_form="COOLING_SIG_COL",
+        description="Cooling signal",
+        unit="%",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="economizer_sig_col",
+        constant_form="ECONOMIZER_SIG_COL",
+        description="Economizer signal",
+        unit="%",
+        required=True,
+        type=float,
+    ),
+]
+
+FAULT_PARAMS = [
+    InstanceAttribute(
+        name="delta_t_supply_fan",
+        constant_form="DELTA_T_SUPPLY_FAN",
+        description="Temperature rise across supply fan",
+        unit="°F",
+        type=float,
+        range=(0.0, 5.0),
+    ),
+    InstanceAttribute(
+        name="outdoor_degf_err_thres",
+        constant_form="OUTDOOR_DEGF_ERR_THRES",
+        description="Outdoor air temperature error threshold",
+        unit="°F",
+        type=float,
+        range=(0.0, 10.0),
+    ),
+    InstanceAttribute(
+        name="supply_degf_err_thres",
+        constant_form="SUPPLY_DEGF_ERR_THRES",
+        description="Supply air temperature error threshold",
+        unit="°F",
+        type=float,
+        range=(0.0, 10.0),
+    ),
+    InstanceAttribute(
+        name="ahu_min_oa_dpr",
+        constant_form="AHU_MIN_OA_DPR",
+        description="Minimum outdoor air damper position",
+        unit="fraction",
+        type=float,
+        range=(0.0, 1.0),
+    ),
+]
+
+
+class FaultConditionNine(BaseFaultCondition, FaultConditionMixin):
+    """Class provides the definitions for Fault Condition 9.
+    Outside air temperature too high in free cooling without
+    additional mechanical cooling in economizer mode.
+
+    py -3.12 -m pytest open_fdd/tests/ahu/test_ahu_fc9.py -rP -s
+    """
+
+    input_columns = INPUT_COLS
+    fault_params = FAULT_PARAMS
+    equation_string = (
+        "fc9_flag = 1 if OAT > (SATSP - ΔT_fan + εSAT) "
+        "in free cooling mode for N consecutive values else 0 \n"
+    )
+    description_string = (
+        "Fault Condition 9: Outside air temperature too high in free cooling mode "
+        "without additional mechanical cooling in economizer mode \n"
+    )
+    error_string = "One or more required columns are missing or None \n"
+
+    @FaultConditionMixin._handle_errors
+    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
+        """Apply the fault condition to the DataFrame."""
+        # Apply common checks
+        self._apply_common_checks(df)
+
+        # Get column values using accessor methods
+        oat_col = self.get_input_column("oat_col")
+        sat_setpoint_col = self.get_input_column("sat_setpoint_col")
+        economizer_sig_col = self.get_input_column("economizer_sig_col")
+        cooling_sig_col = self.get_input_column("cooling_sig_col")
+
+        # Get parameter values using accessor methods
+        outdoor_degf_err_thres = self.get_param("outdoor_degf_err_thres")
+        delta_t_supply_fan = self.get_param("delta_t_supply_fan")
+        supply_degf_err_thres = self.get_param("supply_degf_err_thres")
+        ahu_min_oa_dpr = self.get_param("ahu_min_oa_dpr")
+
+        # Check analog outputs [data with units of %] are floats only
+        columns_to_check = [
+            economizer_sig_col,
+            cooling_sig_col,
+        ]
+        self._apply_analog_checks(df, columns_to_check, check_greater_than_one=True)
+
+        # Perform calculations
+        oat_minus_oaterror = df[oat_col] - outdoor_degf_err_thres
+        satsp_delta_saterr = (
+            df[sat_setpoint_col] - delta_t_supply_fan + supply_degf_err_thres
+        )
+
+        combined_check = (
+            (oat_minus_oaterror > satsp_delta_saterr)
+            # verify AHU is in OS2 only free cooling mode
+            & (df[economizer_sig_col] > ahu_min_oa_dpr)
+            & (df[cooling_sig_col] < 0.1)
+        )
+
+        # Set fault flag
+        self._set_fault_flag(df, combined_check, "fc9_flag")
+
+        return df

open_fdd/air_handling_unit/faults/fault_condition_one.py

@@ -0,0 +1,113 @@
+import pandas as pd
+
+from open_fdd.core.base_fault import BaseFaultCondition
+from open_fdd.core.components import FaultInputColumn, InstanceAttribute
+from open_fdd.core.mixins import FaultConditionMixin
+
+INPUT_COLS = [
+    FaultInputColumn(
+        name="duct_static_col",
+        constant_form="DUCT_STATIC_COL",
+        description="Duct static pressure",
+        unit="inches of water",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="supply_vfd_speed_col",
+        constant_form="SUPPLY_VFD_SPEED_COL",
+        description="Supply fan VFD speed",
+        unit="%",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="duct_static_setpoint_col",
+        constant_form="DUCT_STATIC_SETPOINT_COL",
+        description="Duct static pressure setpoint",
+        unit="inches of water",
+        required=True,
+        type=float,
+    ),
+]
+
+FAULT_PARAMS = [
+    InstanceAttribute(
+        name="duct_static_inches_err_thres",
+        constant_form="DUCT_STATIC_INCHES_ERR_THRES",
+        description="Duct static pressure error threshold",
+        unit="inches of water",
+        type=float,
+        range=(0.0, 1.0),
+    ),
+    InstanceAttribute(
+        name="vfd_speed_percent_max",
+        constant_form="VFD_SPEED_PERCENT_MAX",
+        description="Maximum VFD speed percentage",
+        unit="%",
+        type=float,
+        range=(0.0, 100.0),
+    ),
+    InstanceAttribute(
+        name="vfd_speed_percent_err_thres",
+        constant_form="VFD_SPEED_PERCENT_ERR_THRES",
+        description="VFD speed error threshold",
+        unit="%",
+        type=float,
+        range=(0.0, 100.0),
+    ),
+]
+
+
+class FaultConditionOne(BaseFaultCondition, FaultConditionMixin):
+    """Class provides the definitions for Fault Condition 1.
+    AHU low duct static pressure fan fault.
+
+    py -3.12 -m pytest open_fdd/tests/ahu/test_ahu_fc1.py -rP -s
+    """
+
+    input_columns = INPUT_COLS
+    fault_params = FAULT_PARAMS
+    equation_string = "fc1_flag = 1 if (DP < DPSP - εDP) and (VFDSPD >= VFDSPD_max - εVFDSPD) for N consecutive values else 0 \n"
+    description_string = (
+        "Fault Condition 1: Duct static too low at fan at full speed \n"
+    )
+
+    error_string = "One or more required columns are missing or None \n"
+
+    @FaultConditionMixin._handle_errors
+    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
+        self._apply_common_checks(df)
+
+        # Get column values using accessor methods
+        supply_vfd_speed_col = self.get_input_column("supply_vfd_speed_col")
+        duct_static_col = self.get_input_column("duct_static_col")
+        duct_static_setpoint_col = self.get_input_column("duct_static_setpoint_col")
+
+        # Get parameter values using accessor methods
+        vfd_speed_percent_max = self.get_param("vfd_speed_percent_max")
+        vfd_speed_percent_err_thres = self.get_param("vfd_speed_percent_err_thres")
+        duct_static_inches_err_thres = self.get_param("duct_static_inches_err_thres")
+
+        self._apply_analog_checks(
+            df, [supply_vfd_speed_col], check_greater_than_one=True
+        )
+
+        # Convert VFD speed from percentage to fraction if needed
+        if (df[supply_vfd_speed_col] > 1.0).any():
+            df[supply_vfd_speed_col] = df[supply_vfd_speed_col] / 100.0
+
+        # Convert thresholds from percentage to fraction
+        vfd_speed_max = vfd_speed_percent_max / 100.0
+        vfd_speed_err_thres = vfd_speed_percent_err_thres / 100.0
+
+        # Specific checks
+        static_check = (
+            df[duct_static_col]
+            < df[duct_static_setpoint_col] - duct_static_inches_err_thres
+        )
+        fan_check = df[supply_vfd_speed_col] >= vfd_speed_max - vfd_speed_err_thres
+        combined_check = static_check & fan_check
+
+        self._set_fault_flag(df, combined_check, "fc1_flag")
+        return df

open_fdd/air_handling_unit/faults/fault_condition_seven.py

@@ -0,0 +1,106 @@
+import pandas as pd
+
+from open_fdd.core.base_fault import BaseFaultCondition
+from open_fdd.core.components import FaultInputColumn, InstanceAttribute
+from open_fdd.core.exceptions import InvalidParameterError, MissingColumnError
+from open_fdd.core.mixins import FaultConditionMixin
+
+INPUT_COLS = [
+    FaultInputColumn(
+        name="sat_col",
+        constant_form="SAT_COL",
+        description="Supply air temperature",
+        unit="°F",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="sat_setpoint_col",
+        constant_form="SAT_SETPOINT_COL",
+        description="Supply air temperature setpoint",
+        unit="°F",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="heating_sig_col",
+        constant_form="HEATING_SIG_COL",
+        description="Heating signal",
+        unit="%",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="supply_vfd_speed_col",
+        constant_form="SUPPLY_VFD_SPEED_COL",
+        description="Supply fan VFD speed",
+        unit="%",
+        required=True,
+        type=float,
+    ),
+]
+
+FAULT_PARAMS = [
+    InstanceAttribute(
+        name="supply_degf_err_thres",
+        constant_form="SUPPLY_DEGF_ERR_THRES",
+        description="Supply air temperature error threshold",
+        unit="°F",
+        type=float,
+        range=(0.0, 10.0),
+    ),
+]
+
+
+class FaultConditionSeven(BaseFaultCondition, FaultConditionMixin):
+    """Class provides the definitions for Fault Condition 7.
+    Very similar to FC 13 but uses heating valve.
+    Supply air temperature too low in full heating.
+
+    py -3.12 -m pytest open_fdd/tests/ahu/test_ahu_fc7.py -rP -s
+    """
+
+    input_columns = INPUT_COLS
+    fault_params = FAULT_PARAMS
+    equation_string = (
+        "fc7_flag = 1 if SAT < (SATSP - εSAT) in full heating mode "
+        "and VFD speed > 0 for N consecutive values else 0 \n"
+    )
+    description_string = (
+        "Fault Condition 7: Supply air temperature too low in full heating mode "
+        "with heating valve fully open \n"
+    )
+    error_string = "One or more required columns are missing or None \n"
+
+    @FaultConditionMixin._handle_errors
+    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
+        """Apply the fault condition to the DataFrame."""
+        # Apply common checks
+        self._apply_common_checks(df)
+
+        # Get column values using accessor methods
+        sat_col = self.get_input_column("sat_col")
+        sat_setpoint_col = self.get_input_column("sat_setpoint_col")
+        supply_vfd_speed_col = self.get_input_column("supply_vfd_speed_col")
+        heating_sig_col = self.get_input_column("heating_sig_col")
+
+        # Get parameter values using accessor methods
+        supply_degf_err_thres = self.get_param("supply_degf_err_thres")
+
+        # Check analog outputs [data with units of %] are floats only
+        columns_to_check = [supply_vfd_speed_col, heating_sig_col]
+        self._apply_analog_checks(df, columns_to_check, check_greater_than_one=True)
+
+        # Perform checks
+        sat_check = df[sat_setpoint_col] - supply_degf_err_thres
+
+        combined_check = (
+            (df[sat_col] < sat_check)
+            & (df[heating_sig_col] > 0.9)
+            & (df[supply_vfd_speed_col] > 0)
+        )
+
+        # Set fault flag
+        self._set_fault_flag(df, combined_check, "fc7_flag")
+
+        return df