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

open_fdd/air_handling_unit/faults/fault_condition_nine.py

@@ -1,7 +1,9 @@
 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
+from open_fdd.air_handling_unit.faults.fault_condition import (
+    FaultCondition,
+    MissingColumnError,
+)
 import sys
 
 
@@ -12,6 +14,7 @@ class FaultConditionNine(FaultCondition):
     """
 
     def __init__(self, dict_):
+        super().__init__()
         self.delta_t_supply_fan = float
         self.outdoor_degf_err_thres = float
         self.supply_degf_err_thres = float
@@ -23,46 +26,103 @@ class FaultConditionNine(FaultCondition):
         self.troubleshoot_mode = bool  # default should be False
         self.rolling_window_size = int
 
-        self.set_attributes(dict_)
+        self.equation_string = (
+            "fc9_flag = 1 if OAT > (SATSP - ΔT_fan + εSAT) "
+            "in free cooling mode for N consecutive values else 0 \n"
+        )
+        self.description_string = (
+            "Fault Condition 9: Outside air temperature too high in free cooling mode "
+            "without additional mechanical cooling in economizer mode \n"
+        )
+        self.required_column_description = (
+            "Required inputs are the supply air temperature setpoint, outside air temperature, "
+            "cooling signal, and economizer signal \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.sat_setpoint_col,
+            self.oat_col,
             self.cooling_sig_col,
+            self.economizer_sig_col,
         ]
-        self.check_analog_pct(df, columns_to_check)
-
-        # Create helper columns
-        df["oat_minus_oaterror"] = df[self.oat_col] - self.outdoor_degf_err_thres
-        df["satsp_delta_saterr"] = (
-            df[self.sat_setpoint_col]
-            - self.delta_t_supply_fan
-            + self.supply_degf_err_thres
-        )
 
-        df["combined_check"] = (
-            (df["oat_minus_oaterror"] > df["satsp_delta_saterr"])
-            # 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)
+        # 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)}"
         )
 
-        # 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["fc9_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["oat_minus_oaterror"]
-            del df["satsp_delta_saterr"]
-            del df["combined_check"]
+    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
+        try:
+            # Ensure all required columns are present
+            self.check_required_columns(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.check_analog_pct(df, columns_to_check)
+
+            # Create helper columns
+            df["oat_minus_oaterror"] = df[self.oat_col] - self.outdoor_degf_err_thres
+            df["satsp_delta_saterr"] = (
+                df[self.sat_setpoint_col]
+                - self.delta_t_supply_fan
+                + self.supply_degf_err_thres
+            )
 
-        return df
+            df["combined_check"] = (
+                (df["oat_minus_oaterror"] > df["satsp_delta_saterr"])
+                # 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)
+            )
+
+            # 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["fc9_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["oat_minus_oaterror"]
+                del df["satsp_delta_saterr"]
+                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_one.py

@@ -1,5 +1,8 @@
 import pandas as pd
-from open_fdd.air_handling_unit.faults.fault_condition import FaultCondition
+from open_fdd.air_handling_unit.faults.fault_condition import (
+    FaultCondition,
+    MissingColumnError,
+)
 import sys
 
 
@@ -9,9 +12,7 @@ class FaultConditionOne(FaultCondition):
     """
 
     def __init__(self, dict_):
-        """
-        :param dict_:
-        """
+        super().__init__()
         self.vfd_speed_percent_err_thres = float
         self.vfd_speed_percent_max = float
         self.duct_static_inches_err_thres = float
@@ -21,40 +22,91 @@ class FaultConditionOne(FaultCondition):
         self.troubleshoot_mode = bool  # default should be False
         self.rolling_window_size = int
 
+        self.equation_string = "fc1_flag = 1 if (DSP < DPSP - εDSP) and (VFDSPD >= VFDSPD_max - εVFDSPD) for N consecutive values else 0 \n"
+        self.description_string = (
+            "Fault Condition 1: Duct static too low at fan at full speed \n"
+        )
+        self.required_column_description = "Required inputs are the duct static pressure, setpoint, and supply fan VFD speed \n"
+        self.error_string = f"One or more required columns are missing or None \n"
+
         self.set_attributes(dict_)
 
-    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
-        if self.troubleshoot_mode:
-            self.troubleshoot_cols(df)
+        # Set required columns specific to this fault condition manually
+        self.required_columns = [
+            self.duct_static_col,
+            self.supply_vfd_speed_col,
+            self.duct_static_setpoint_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}"
+            )
 
-        # check analog outputs [data with units of %] are floats only
-        columns_to_check = [self.supply_vfd_speed_col]
-        self.check_analog_pct(df, columns_to_check)
+        # Ensure all required columns are strings
+        self.required_columns = [str(col) for col in self.required_columns]
 
-        df["static_check_"] = (
-            df[self.duct_static_col]
-            < df[self.duct_static_setpoint_col] - self.duct_static_inches_err_thres
+        self.mapped_columns = (
+            f"Your config dictionary is mapped as: {', '.join(self.required_columns)}"
         )
-        df["fan_check_"] = (
-            df[self.supply_vfd_speed_col]
-            >= self.vfd_speed_percent_max - self.vfd_speed_percent_err_thres
+
+    def get_required_columns(self) -> str:
+        """called from IPython to print out"""
+        return (
+            f"{self.equation_string}"
+            f"{self.description_string}"
+            f"{self.required_column_description}"
+            f"{self.mapped_columns}"
         )
 
-        # Combined condition check
-        df["combined_check"] = df["static_check_"] & df["fan_check_"]
+    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
+        try:
+            # Ensure all required columns are present
+            self.check_required_columns(df)
 
-        # 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["fc1_flag"] = (rolling_sum == self.rolling_window_size).astype(int)
+            if self.troubleshoot_mode:
+                self.troubleshoot_cols(df)
 
-        if self.troubleshoot_mode:
-            print("Troubleshoot mode enabled - not removing helper columns")
-            sys.stdout.flush()
-            del df["static_check_"]
-            del df["fan_check_"]
-            del df["combined_check"]
+            # Check analog outputs [data with units of %] are floats only
+            columns_to_check = [self.supply_vfd_speed_col]
+            self.check_analog_pct(df, columns_to_check)
 
-        return df
+            df["static_check_"] = (
+                df[self.duct_static_col]
+                < df[self.duct_static_setpoint_col] - self.duct_static_inches_err_thres
+            )
+            df["fan_check_"] = (
+                df[self.supply_vfd_speed_col]
+                >= self.vfd_speed_percent_max - self.vfd_speed_percent_err_thres
+            )
+
+            # Combined condition check
+            df["combined_check"] = df["static_check_"] & df["fan_check_"]
+
+            # 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["fc1_flag"] = (rolling_sum == self.rolling_window_size).astype(int)
+
+            if self.troubleshoot_mode:
+                print("Troubleshoot mode enabled - not removing helper columns")
+                sys.stdout.flush()
+
+            # Optionally remove temporary columns
+            df.drop(
+                columns=["static_check_", "fan_check_", "combined_check"], inplace=True
+            )
+
+            return df
+
+        except MissingColumnError as e:
+            print(f"Error: {e.message}")
+            sys.stdout.flush()
+            raise e

open_fdd/air_handling_unit/faults/fault_condition_seven.py

@@ -1,7 +1,8 @@
 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
+from open_fdd.air_handling_unit.faults.fault_condition import (
+    FaultCondition,
+    MissingColumnError,
+)
 import sys
 
 
@@ -12,6 +13,7 @@ class FaultConditionSeven(FaultCondition):
     """
 
     def __init__(self, dict_):
+        super().__init__()
         self.supply_degf_err_thres = float
         self.sat_col = str
         self.sat_setpoint_col = str
@@ -20,36 +22,93 @@ class FaultConditionSeven(FaultCondition):
         self.troubleshoot_mode = bool  # default to False
         self.rolling_window_size = int
 
+        self.equation_string = (
+            "fc7_flag = 1 if SAT < (SATSP - εSAT) in full heating mode "
+            "and VFD speed > 0 for N consecutive values else 0 \n"
+        )
+        self.description_string = (
+            "Fault Condition 7: Supply air temperature too low in full heating mode "
+            "with heating valve fully open \n"
+        )
+        self.required_column_description = (
+            "Required inputs are the supply air temperature, supply air temperature setpoint, "
+            "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_)
 
-    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.sat_col,
+            self.sat_setpoint_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]
-        self.check_analog_pct(df, columns_to_check)
+        # 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}"
+            )
 
-        # Fault condition-specific checks / flags
-        df["sat_check"] = df[self.sat_setpoint_col] - self.supply_degf_err_thres
+        # Ensure all required columns are strings
+        self.required_columns = [str(col) for col in self.required_columns]
 
-        df["combined_check"] = (
-            (df[self.sat_col] < df["sat_check"])
-            & (df[self.heating_sig_col] > 0.9)
-            & (df[self.supply_vfd_speed_col] > 0)
+        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["fc7_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["sat_check"]
-            del df["combined_check"]
+    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
+        try:
+            # Ensure all required columns are present
+            self.check_required_columns(df)
+
+            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]
+            self.check_analog_pct(df, columns_to_check)
+
+            # Fault condition-specific checks / flags
+            df["sat_check"] = df[self.sat_setpoint_col] - self.supply_degf_err_thres
+
+            df["combined_check"] = (
+                (df[self.sat_col] < df["sat_check"])
+                & (df[self.heating_sig_col] > 0.9)
+                & (df[self.supply_vfd_speed_col] > 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["fc7_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["sat_check"]
+                del df["combined_check"]
+
+            return df
+
+        except MissingColumnError as e:
+            print(f"Error: {e.message}")
+            sys.stdout.flush()
+            raise e