open-fdd 0.1.1__py3-none-any.whl → 0.1.4__py3-none-any.whl

open_fdd/air_handling_unit/faults/fault_condition_five.py

@@ -1,7 +1,9 @@
 import pandas as pd
 import pandas.api.types as pdtypes
-from open_fdd.air_handling_unit.faults.fault_condition import FaultCondition
-from open_fdd.air_handling_unit.faults.helper_utils import HelperUtils
+from open_fdd.air_handling_unit.faults.fault_condition import (
+    FaultCondition,
+    MissingColumnError,
+)
 import sys
 
 
@@ -13,6 +15,7 @@ class FaultConditionFive(FaultCondition):
     """
 
     def __init__(self, dict_):
+        super().__init__()
         self.mix_degf_err_thres = float
         self.supply_degf_err_thres = float
         self.delta_t_supply_fan = float
@@ -23,46 +26,98 @@ class FaultConditionFive(FaultCondition):
         self.troubleshoot_mode = bool  # default to False
         self.rolling_window_size = int
 
+        self.equation_string = (
+            "fc5_flag = 1 if (SAT + εSAT <= MAT - εMAT + ΔT_supply_fan) and "
+            "(heating signal > 0) and (VFDSPD > 0) for N consecutive values else 0 \n"
+        )
+        self.description_string = (
+            "Fault Condition 5: SAT too low; should be higher than MAT in HTG MODE, "
+            "potential broken heating valve or mechanical issue \n"
+        )
+        self.required_column_description = (
+            "Required inputs are the mixed air temperature, supply air temperature, "
+            "heating signal, and supply fan VFD speed \n"
+        )
+        self.error_string = f"One or more required columns are missing or None \n"
+
         self.set_attributes(dict_)
 
-    # fault only active if fan is running and htg vlv is modulating
-    # OS 1 is heating mode only fault
-    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
-        if self.troubleshoot_mode:
-            self.troubleshoot_cols(df)
+        # Set required columns specific to this fault condition
+        self.required_columns = [
+            self.mat_col,
+            self.sat_col,
+            self.heating_sig_col,
+            self.supply_vfd_speed_col,
+        ]
 
-        # check analog outputs [data with units of %] are floats only
-        columns_to_check = [self.supply_vfd_speed_col, self.heating_sig_col]
+        # Check if any of the required columns are None
+        if any(col is None for col in self.required_columns):
+            raise MissingColumnError(
+                f"{self.error_string}"
+                f"{self.equation_string}"
+                f"{self.description_string}"
+                f"{self.required_column_description}"
+                f"{self.required_columns}"
+            )
 
-        for col in columns_to_check:
-            self.check_analog_pct(df, [col])
+        # Ensure all required columns are strings
+        self.required_columns = [str(col) for col in self.required_columns]
 
-        df["sat_check"] = df[self.sat_col] + self.supply_degf_err_thres
-        df["mat_check"] = (
-            df[self.mat_col] - self.mix_degf_err_thres + self.delta_t_supply_fan
+        self.mapped_columns = (
+            f"Your config dictionary is mapped as: {', '.join(self.required_columns)}"
         )
 
-        df["combined_check"] = (
-            (df["sat_check"] <= df["mat_check"])
-            # this is to make fault only active in OS1 for htg mode only
-            # and fan is running. Some control programming may use htg
-            # vlv when AHU is off to prevent low limit freeze alarms
-            & (df[self.heating_sig_col] > 0.01)
-            & (df[self.supply_vfd_speed_col] > 0.01)
+    def get_required_columns(self) -> str:
+        """Returns a string representation of the required columns."""
+        return (
+            f"{self.equation_string}"
+            f"{self.description_string}"
+            f"{self.required_column_description}"
+            f"{self.mapped_columns}"
         )
 
-        # Rolling sum to count consecutive trues
-        rolling_sum = (
-            df["combined_check"].rolling(window=self.rolling_window_size).sum()
-        )
-        # Set flag to 1 if rolling sum equals the window size
-        df["fc5_flag"] = (rolling_sum == self.rolling_window_size).astype(int)
+    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
+        try:
+            # Ensure all required columns are present
+            self.check_required_columns(df)
 
-        if self.troubleshoot_mode:
-            print("Troubleshoot mode enabled - not removing helper columns")
-            sys.stdout.flush()
-            del df["mat_check"]
-            del df["sat_check"]
-            del df["combined_check"]
+            if self.troubleshoot_mode:
+                self.troubleshoot_cols(df)
 
-        return df
+            # Check analog outputs [data with units of %] are floats only
+            columns_to_check = [self.supply_vfd_speed_col, self.heating_sig_col]
+
+            for col in columns_to_check:
+                self.check_analog_pct(df, [col])
+
+            df["sat_check"] = df[self.sat_col] + self.supply_degf_err_thres
+            df["mat_check"] = (
+                df[self.mat_col] - self.mix_degf_err_thres + self.delta_t_supply_fan
+            )
+
+            df["combined_check"] = (
+                (df["sat_check"] <= df["mat_check"])
+                & (df[self.heating_sig_col] > 0.01)
+                & (df[self.supply_vfd_speed_col] > 0.01)
+            )
+
+            # Rolling sum to count consecutive trues
+            rolling_sum = (
+                df["combined_check"].rolling(window=self.rolling_window_size).sum()
+            )
+            # Set flag to 1 if rolling sum equals the window size
+            df["fc5_flag"] = (rolling_sum == self.rolling_window_size).astype(int)
+
+            if self.troubleshoot_mode:
+                print("Troubleshoot mode enabled - not removing helper columns")
+                sys.stdout.flush()
+                del df["mat_check"]
+                del df["sat_check"]
+                del df["combined_check"]
+
+            return df
+
+        except MissingColumnError as e:
+            print(f"Error: {e.message}")
+            sys.stdout.flush()
+            raise e

open_fdd/air_handling_unit/faults/fault_condition_four.py

@@ -1,6 +1,8 @@
 import pandas as pd
-from open_fdd.air_handling_unit.faults.fault_condition import FaultCondition
-from open_fdd.air_handling_unit.faults.helper_utils import HelperUtils
+from open_fdd.air_handling_unit.faults.fault_condition import (
+    FaultCondition,
+    MissingColumnError,
+)
 import sys
 
 
@@ -8,14 +10,14 @@ class FaultConditionFour(FaultCondition):
     """Class provides the definitions for Fault Condition 4.
 
     This fault flags excessive operating states on the AHU
-    if its hunting between heating, econ, econ+mech, and
+    if it's hunting between heating, econ, econ+mech, and
     a mech clg modes. The code counts how many operating
     changes in an hour and will throw a fault if there is
     excessive OS changes to flag control sys hunting.
-
     """
 
     def __init__(self, dict_):
+        super().__init__()
         self.delta_os_max = float
         self.ahu_min_oa_dpr = float
         self.economizer_sig_col = str
@@ -24,70 +26,143 @@ class FaultConditionFour(FaultCondition):
         self.supply_vfd_speed_col = str
         self.troubleshoot_mode = bool  # default to False
 
-        self.set_attributes(dict_)
+        self.equation_string = (
+            "fc4_flag = 1 if excessive mode changes (> δOS_max) occur "
+            "within an hour across heating, econ, econ+mech, mech clg, and min OA modes \n"
+        )
+        self.description_string = "Fault Condition 4: Excessive AHU operating state changes detected (hunting behavior) \n"
+        self.required_column_description = (
+            "Required inputs are the economizer signal, supply fan VFD speed, "
+            "and optionally heating and cooling signals \n"
+        )
+        self.error_string = f"One or more required columns are missing or None \n"
 
-    # adds in these boolean columns to the dataframe
-    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
-        if self.troubleshoot_mode:
-            self.troubleshoot_cols(df)
+        self.set_attributes(dict_)
 
-        # check analog outputs [data with units of %] are floats only
-        columns_to_check = [
+        # Set required columns, making heating and cooling optional
+        self.required_columns = [
             self.economizer_sig_col,
-            self.heating_sig_col,
-            self.cooling_sig_col,
             self.supply_vfd_speed_col,
         ]
 
-        for col in columns_to_check:
-            self.check_analog_pct(df, [col])
-
-        print("=" * 50)
-        print("Warning: The program is in FC4 and resampling the data")
-        print("to compute AHU OS state changes per hour")
-        print("to flag any hunting issue")
-        print("and this usually takes a while to run...")
-        print("=" * 50)
-
-        sys.stdout.flush()
-
-        # AHU htg only mode based on OA damper @ min oa and only htg pid/vlv modulating
-        df["heating_mode"] = (
-            (df[self.heating_sig_col] > 0)
-            & (df[self.cooling_sig_col] == 0)
-            & (df[self.supply_vfd_speed_col] > 0)
-            & (df[self.economizer_sig_col] == self.ahu_min_oa_dpr)
-        )
-
-        # AHU econ only mode based on OA damper modulating and clg htg = zero
-        df["econ_only_cooling_mode"] = (
-            (df[self.heating_sig_col] == 0)
-            & (df[self.cooling_sig_col] == 0)
-            & (df[self.supply_vfd_speed_col] > 0)
-            & (df[self.economizer_sig_col] > self.ahu_min_oa_dpr)
-        )
-
-        # AHU econ+mech clg mode based on OA damper modulating for cooling and clg pid/vlv modulating
-        df["econ_plus_mech_cooling_mode"] = (
-            (df[self.heating_sig_col] == 0)
-            & (df[self.cooling_sig_col] > 0)
-            & (df[self.supply_vfd_speed_col] > 0)
-            & (df[self.economizer_sig_col] > self.ahu_min_oa_dpr)
+        # If heating or cooling columns are provided, add them to the required columns
+        if self.heating_sig_col:
+            self.required_columns.append(self.heating_sig_col)
+        if self.cooling_sig_col:
+            self.required_columns.append(self.cooling_sig_col)
+
+        # Check if any of the required columns are None
+        if any(col is None for col in self.required_columns):
+            raise MissingColumnError(
+                f"{self.error_string}"
+                f"{self.equation_string}"
+                f"{self.description_string}"
+                f"{self.required_column_description}"
+                f"{self.required_columns}"
+            )
+        # Ensure all required columns are strings
+        self.required_columns = [str(col) for col in self.required_columns]
+
+        self.mapped_columns = (
+            f"Your config dictionary is mapped as: {', '.join(self.required_columns)}"
         )
 
-        # AHU mech mode based on OA damper @ min OA and clg pid/vlv modulating
-        df["mech_cooling_only_mode"] = (
-            (df[self.heating_sig_col] == 0)
-            & (df[self.cooling_sig_col] > 0)
-            & (df[self.supply_vfd_speed_col] > 0)
-            & (df[self.economizer_sig_col] == self.ahu_min_oa_dpr)
+    def get_required_columns(self) -> str:
+        """Returns a string representation of the required columns."""
+        return (
+            f"{self.equation_string}"
+            f"{self.description_string}"
+            f"{self.required_column_description}"
+            f"{self.mapped_columns}"
         )
 
-        # Fill non-finite values with zero or drop them
-        df = df.fillna(0)
-
-        df = df.astype(int)
-        df = df.resample("60min").apply(lambda x: (x.eq(1) & x.shift().ne(1)).sum())
-
-        df["fc4_flag"] = df[df.columns].gt(self.delta_os_max).any(axis=1).astype(int)
-        return df
+    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
+        try:
+            # Ensure all required columns are present
+            self.check_required_columns(df)
+
+            # If the optional columns are not present, create them with all values set to 0.0
+            if self.heating_sig_col not in df.columns:
+                df[self.heating_sig_col] = 0.0
+            if self.cooling_sig_col not in df.columns:
+                df[self.cooling_sig_col] = 0.0
+
+            if self.troubleshoot_mode:
+                self.troubleshoot_cols(df)
+
+            # Check analog outputs [data with units of %] are floats only
+            columns_to_check = [
+                self.economizer_sig_col,
+                self.heating_sig_col,
+                self.cooling_sig_col,
+                self.supply_vfd_speed_col,
+            ]
+
+            for col in columns_to_check:
+                self.check_analog_pct(df, [col])
+
+            print("=" * 50)
+            print("Warning: The program is in FC4 and resampling the data")
+            print("to compute AHU OS state changes per hour")
+            print("to flag any hunting issue")
+            print("and this usually takes a while to run...")
+            print("=" * 50)
+
+            sys.stdout.flush()
+
+            # AHU htg only mode based on OA damper @ min oa and only htg pid/vlv modulating
+            df["heating_mode"] = (
+                (df[self.heating_sig_col] > 0)
+                & (df[self.cooling_sig_col] == 0)
+                & (df[self.supply_vfd_speed_col] > 0)
+                & (df[self.economizer_sig_col] == self.ahu_min_oa_dpr)
+            )
+
+            # AHU econ only mode based on OA damper modulating and clg htg = zero
+            df["econ_only_cooling_mode"] = (
+                (df[self.heating_sig_col] == 0)
+                & (df[self.cooling_sig_col] == 0)
+                & (df[self.supply_vfd_speed_col] > 0)
+                & (df[self.economizer_sig_col] > self.ahu_min_oa_dpr)
+            )
+
+            # AHU econ+mech clg mode based on OA damper modulating for cooling and clg pid/vlv modulating
+            df["econ_plus_mech_cooling_mode"] = (
+                (df[self.heating_sig_col] == 0)
+                & (df[self.cooling_sig_col] > 0)
+                & (df[self.supply_vfd_speed_col] > 0)
+                & (df[self.economizer_sig_col] > self.ahu_min_oa_dpr)
+            )
+
+            # AHU mech mode based on OA damper @ min OA and clg pid/vlv modulating
+            df["mech_cooling_only_mode"] = (
+                (df[self.heating_sig_col] == 0)
+                & (df[self.cooling_sig_col] > 0)
+                & (df[self.supply_vfd_speed_col] > 0)
+                & (df[self.economizer_sig_col] == self.ahu_min_oa_dpr)
+            )
+
+            # AHU minimum OA mode without heating or cooling (ventilation mode)
+            df["min_oa_mode_only"] = (
+                (df[self.heating_sig_col] == 0)
+                & (df[self.cooling_sig_col] == 0)
+                & (df[self.supply_vfd_speed_col] > 0)
+                & (df[self.economizer_sig_col] == self.ahu_min_oa_dpr)
+            )
+
+            # Fill non-finite values with zero or drop them
+            df = df.fillna(0)
+
+            df = df.astype(int)
+            df = df.resample("60min").apply(lambda x: (x.eq(1) & x.shift().ne(1)).sum())
+
+            df["fc4_flag"] = (
+                df[df.columns].gt(self.delta_os_max).any(axis=1).astype(int)
+            )
+
+            return df
+
+        except MissingColumnError as e:
+            print(f"Error: {e.message}")
+            sys.stdout.flush()
+            raise e

open_fdd/air_handling_unit/faults/fault_condition_fourteen.py

@@ -1,8 +1,10 @@
 import pandas as pd
 import numpy as np
-from open_fdd.air_handling_unit.faults.fault_condition import FaultCondition
-from open_fdd.air_handling_unit.faults.helper_utils import HelperUtils
 import operator
+from open_fdd.air_handling_unit.faults.fault_condition import (
+    FaultCondition,
+    MissingColumnError,
+)
 import sys
 
 
@@ -13,6 +15,7 @@ class FaultConditionFourteen(FaultCondition):
     """
 
     def __init__(self, dict_):
+        super().__init__()
         self.delta_t_supply_fan = float
         self.coil_temp_enter_err_thres = float
         self.coil_temp_leav_err_thres = float
@@ -26,55 +29,115 @@ class FaultConditionFourteen(FaultCondition):
         self.troubleshoot_mode = bool  # default to False
         self.rolling_window_size = int
 
-        self.set_attributes(dict_)
+        self.equation_string = (
+            "fc14_flag = 1 if ΔT_coil >= √(εcoil_enter² + εcoil_leave²) + ΔT_fan "
+            "in inactive cooling coil mode for N consecutive values else 0 \n"
+        )
+        self.description_string = (
+            "Fault Condition 14: Temperature drop across inactive cooling coil "
+            "detected, requiring coil leaving temperature sensor \n"
+        )
+        self.required_column_description = (
+            "Required inputs are the cooling coil entering temperature, cooling coil leaving temperature, "
+            "cooling signal, heating signal, economizer signal, and supply fan VFD speed \n"
+        )
+        self.error_string = f"One or more required columns are missing or None \n"
 
-    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
-        if self.troubleshoot_mode:
-            self.troubleshoot_cols(df)
+        self.set_attributes(dict_)
 
-        # Check analog outputs [data with units of %] are floats only
-        columns_to_check = [
-            self.economizer_sig_col,
+        # Set required columns specific to this fault condition
+        self.required_columns = [
+            self.clg_coil_enter_temp_col,
+            self.clg_coil_leave_temp_col,
             self.cooling_sig_col,
             self.heating_sig_col,
+            self.economizer_sig_col,
             self.supply_vfd_speed_col,
         ]
-        self.check_analog_pct(df, columns_to_check)
-
-        # Create helper columns
-        df["clg_delta_temp"] = (
-            df[self.clg_coil_enter_temp_col] - df[self.clg_coil_leave_temp_col]
-        )
 
-        df["clg_delta_sqrted"] = (
-            np.sqrt(
-                self.coil_temp_enter_err_thres**2 + self.coil_temp_leav_err_thres**2
+        # Check if any of the required columns are None
+        if any(col is None for col in self.required_columns):
+            raise MissingColumnError(
+                f"{self.error_string}"
+                f"{self.equation_string}"
+                f"{self.description_string}"
+                f"{self.required_column_description}"
+                f"{self.required_columns}"
             )
-            + self.delta_t_supply_fan
-        )
 
-        df["combined_check"] = operator.or_(
-            (df["clg_delta_temp"] >= df["clg_delta_sqrted"])
-            # verify AHU is in OS2 only free cooling mode
-            & (df[self.economizer_sig_col] > self.ahu_min_oa_dpr)
-            & (df[self.cooling_sig_col] < 0.1),  # OR
-            (df["clg_delta_temp"] >= df["clg_delta_sqrted"])
-            # verify AHU is running in OS 1 at near full heat
-            & (df[self.heating_sig_col] > 0.0) & (df[self.supply_vfd_speed_col] > 0.0),
+        # Ensure all required columns are strings
+        self.required_columns = [str(col) for col in self.required_columns]
+
+        self.mapped_columns = (
+            f"Your config dictionary is mapped as: {', '.join(self.required_columns)}"
         )
 
-        # Rolling sum to count consecutive trues
-        rolling_sum = (
-            df["combined_check"].rolling(window=self.rolling_window_size).sum()
+    def get_required_columns(self) -> str:
+        """Returns a string representation of the required columns."""
+        return (
+            f"{self.equation_string}"
+            f"{self.description_string}"
+            f"{self.required_column_description}"
+            f"{self.mapped_columns}"
         )
-        # Set flag to 1 if rolling sum equals the window size
-        df["fc14_flag"] = (rolling_sum >= self.rolling_window_size).astype(int)
 
-        if self.troubleshoot_mode:
-            print("Troubleshoot mode enabled - not removing helper columns")
-            sys.stdout.flush()
-            del df["clg_delta_temp"]
-            del df["clg_delta_sqrted"]
-            del df["combined_check"]
+    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
+        try:
+            # Ensure all required columns are present
+            self.check_required_columns(df)
 
-        return df
+            if self.troubleshoot_mode:
+                self.troubleshoot_cols(df)
+
+            # Check analog outputs [data with units of %] are floats only
+            columns_to_check = [
+                self.economizer_sig_col,
+                self.cooling_sig_col,
+                self.heating_sig_col,
+                self.supply_vfd_speed_col,
+            ]
+            self.check_analog_pct(df, columns_to_check)
+
+            # Create helper columns
+            df["clg_delta_temp"] = (
+                df[self.clg_coil_enter_temp_col] - df[self.clg_coil_leave_temp_col]
+            )
+
+            df["clg_delta_sqrted"] = (
+                np.sqrt(
+                    self.coil_temp_enter_err_thres**2 + self.coil_temp_leav_err_thres**2
+                )
+                + self.delta_t_supply_fan
+            )
+
+            df["combined_check"] = operator.or_(
+                (df["clg_delta_temp"] >= df["clg_delta_sqrted"])
+                # verify AHU is in OS2 only free cooling mode
+                & (df[self.economizer_sig_col] > self.ahu_min_oa_dpr)
+                & (df[self.cooling_sig_col] < 0.1),  # OR
+                (df["clg_delta_temp"] >= df["clg_delta_sqrted"])
+                # verify AHU is running in OS 1 at near full heat
+                & (df[self.heating_sig_col] > 0.0)
+                & (df[self.supply_vfd_speed_col] > 0.0),
+            )
+
+            # Rolling sum to count consecutive trues
+            rolling_sum = (
+                df["combined_check"].rolling(window=self.rolling_window_size).sum()
+            )
+            # Set flag to 1 if rolling sum equals the window size
+            df["fc14_flag"] = (rolling_sum >= self.rolling_window_size).astype(int)
+
+            if self.troubleshoot_mode:
+                print("Troubleshoot mode enabled - not removing helper columns")
+                sys.stdout.flush()
+                del df["clg_delta_temp"]
+                del df["clg_delta_sqrted"]
+                del df["combined_check"]
+
+            return df
+
+        except MissingColumnError as e:
+            print(f"Error: {e.message}")
+            sys.stdout.flush()
+            raise e