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

open_fdd/air_handling_unit/faults/fault_condition_six.py

@@ -1,33 +1,29 @@
 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
 import operator
+from open_fdd.air_handling_unit.faults.fault_condition import (
+    FaultCondition,
+    MissingColumnError,
+)
 import sys
 
 
 class FaultConditionSix(FaultCondition):
     """Class provides the definitions for Fault Condition 6.
 
-            This fault related to knowing the design air flow for
-            ventilation AHU_MIN_CFM_DESIGN which comes from the
-            design mech engineered records where then the fault
-            tries to calculate that based on totalized measured
-            AHU air flow and outside air fraction calc from
-            AHU temp sensors. The fault could flag issues where
-            flow stations are either not in calibration, temp
-            sensors used in the OA frac calc, or possibly the AHU
-            not bringing in design air flow when not operating in
-            economizer free cooling modes. Troubleshoot by TAB tech
-            verifying flow sensor and temp sensor precisions from
-            3rd party sensing tools.
-
-            this fault is confusing if you want to play around
-            in py code sandbox try this:
-    https://gist.github.com/bbartling/e0fb8427b1e0d148a06e3f09121ed5dc#file-fc6-py
+    This fault related to knowing the design air flow for
+    ventilation AHU_MIN_CFM_DESIGN which comes from the
+    design mech engineered records where then the fault
+    tries to calculate that based on totalized measured
+    AHU air flow and outside air fraction calc from
+    AHU temp sensors. The fault could flag issues where
+    flow stations are either not in calibration, temp
+    sensors used in the OA frac calc, or possibly the AHU
+    not bringing in design air flow when not operating in
+    economizer free cooling modes.
     """
 
     def __init__(self, dict_):
+        super().__init__()
         self.airflow_err_thres = float
         self.ahu_min_oa_cfm_design = float
         self.outdoor_degf_err_thres = float
@@ -45,76 +41,141 @@ class FaultConditionSix(FaultCondition):
         self.troubleshoot_mode = bool  # default should be False
         self.rolling_window_size = int
 
-        self.set_attributes(dict_)
+        self.equation_string = (
+            "fc6_flag = 1 if |OA_frac_calc - OA_min| > airflow_err_thres "
+            "in non-economizer modes, considering htg and mech clg OS \n"
+        )
+        self.description_string = (
+            "Fault Condition 6: Issues detected with OA fraction calculation or AHU "
+            "not maintaining design air flow in non-economizer conditions \n"
+        )
+        self.required_column_description = (
+            "Required inputs are the supply fan air volume, mixed air temperature, "
+            "outside air temperature, return air temperature, and VFD speed. "
+            "Optional inputs include economizer signal, heating signal, and cooling 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 = [
+        # Set required columns specific to this fault condition
+        self.required_columns = [
+            self.supply_fan_air_volume_col,
+            self.mat_col,
+            self.oat_col,
+            self.rat_col,
             self.supply_vfd_speed_col,
             self.economizer_sig_col,
             self.heating_sig_col,
             self.cooling_sig_col,
         ]
 
-        for col in columns_to_check:
-            self.check_analog_pct(df, [col])
-
-        # create helper columns
-        df["rat_minus_oat"] = abs(df[self.rat_col] - df[self.oat_col])
-        df["percent_oa_calc"] = (df[self.mat_col] - df[self.rat_col]) / (
-            df[self.oat_col] - df[self.rat_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}"
+            )
 
-        # weed out any negative values
-        df["percent_oa_calc"] = df["percent_oa_calc"].apply(lambda x: x if x > 0 else 0)
+        # Ensure all required columns are strings
+        self.required_columns = [str(col) for col in self.required_columns]
 
-        df["perc_OAmin"] = (
-            self.ahu_min_oa_cfm_design / df[self.supply_fan_air_volume_col]
+        self.mapped_columns = (
+            f"Your config dictionary is mapped as: {', '.join(self.required_columns)}"
         )
 
-        df["percent_oa_calc_minus_perc_OAmin"] = abs(
-            df["percent_oa_calc"] - df["perc_OAmin"]
+    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}"
         )
 
-        df["combined_check"] = operator.or_(
-            # OS 1 htg mode
-            (
-                (df["rat_minus_oat"] >= self.oat_rat_delta_min)
-                & (df["percent_oa_calc_minus_perc_OAmin"] > self.airflow_err_thres)
+    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.supply_vfd_speed_col,
+                self.economizer_sig_col,
+                self.heating_sig_col,
+                self.cooling_sig_col,
+            ]
+
+            for col in columns_to_check:
+                self.check_analog_pct(df, [col])
+
+            # Create helper columns
+            df["rat_minus_oat"] = abs(df[self.rat_col] - df[self.oat_col])
+            df["percent_oa_calc"] = (df[self.mat_col] - df[self.rat_col]) / (
+                df[self.oat_col] - df[self.rat_col]
+            )
+
+            # Weed out any negative values
+            df["percent_oa_calc"] = df["percent_oa_calc"].apply(
+                lambda x: x if x > 0 else 0
             )
-            # verify ahu is running in OS 1 htg mode in min OA
-            & (
-                (df[self.heating_sig_col] > 0.0) & (df[self.supply_vfd_speed_col] > 0.0)
-            ),  # OR
-            # OS 4 mech clg mode
-            (
-                (df["rat_minus_oat"] >= self.oat_rat_delta_min)
-                & (df["percent_oa_calc_minus_perc_OAmin"] > self.airflow_err_thres)
+
+            df["perc_OAmin"] = (
+                self.ahu_min_oa_cfm_design / df[self.supply_fan_air_volume_col]
             )
-            # verify ahu is running in OS 4 clg mode in min OA
-            & (df[self.heating_sig_col] == 0.0)
-            & (df[self.cooling_sig_col] > 0.0)
-            & (df[self.supply_vfd_speed_col] > 0.0)
-            & (df[self.economizer_sig_col] == self.ahu_min_oa_dpr),
-        )
 
-        # 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["fc6_flag"] = (rolling_sum == self.rolling_window_size).astype(int)
+            df["percent_oa_calc_minus_perc_OAmin"] = abs(
+                df["percent_oa_calc"] - df["perc_OAmin"]
+            )
 
-        if self.troubleshoot_mode:
-            print("Troubleshoot mode enabled - not removing helper columns")
-            sys.stdout.flush()
-            del df["rat_minus_oat"]
-            del df["percent_oa_calc"]
-            del df["perc_OAmin"]
-            del df["percent_oa_calc_minus_perc_OAmin"]
-            del df["combined_check"]
+            df["combined_check"] = operator.or_(
+                # OS 1 htg mode
+                (
+                    (df["rat_minus_oat"] >= self.oat_rat_delta_min)
+                    & (df["percent_oa_calc_minus_perc_OAmin"] > self.airflow_err_thres)
+                )
+                # Verify AHU is running in OS 1 htg mode in min OA
+                & (
+                    (df[self.heating_sig_col] > 0.0)
+                    & (df[self.supply_vfd_speed_col] > 0.0)
+                ),  # OR
+                # OS 4 mech clg mode
+                (
+                    (df["rat_minus_oat"] >= self.oat_rat_delta_min)
+                    & (df["percent_oa_calc_minus_perc_OAmin"] > self.airflow_err_thres)
+                )
+                # Verify AHU is running in OS 4 clg mode in min OA
+                & (df[self.heating_sig_col] == 0.0)
+                & (df[self.cooling_sig_col] > 0.0)
+                & (df[self.supply_vfd_speed_col] > 0.0)
+                & (df[self.economizer_sig_col] == self.ahu_min_oa_dpr),
+            )
 
-        return 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["fc6_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["rat_minus_oat"]
+                del df["percent_oa_calc"]
+                del df["perc_OAmin"]
+                del df["percent_oa_calc_minus_perc_OAmin"]
+                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_ten.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 FaultConditionTen(FaultCondition):
     """
 
     def __init__(self, dict_):
+        super().__init__()
         self.outdoor_degf_err_thres = float
         self.mix_degf_err_thres = float
         self.oat_col = str
@@ -21,42 +24,100 @@ class FaultConditionTen(FaultCondition):
         self.troubleshoot_mode = bool  # default False,
         self.rolling_window_size = int
 
-        self.set_attributes(dict_)
+        self.equation_string = (
+            "fc10_flag = 1 if |OAT - MAT| > √(εOAT² + εMAT²) in "
+            "economizer + mech cooling mode for N consecutive values else 0 \n"
+        )
+        self.description_string = (
+            "Fault Condition 10: Outdoor air temperature and mixed air temperature "
+            "should be approximately equal in economizer plus mechanical cooling mode \n"
+        )
+        self.required_column_description = (
+            "Required inputs are the outside air temperature, mixed 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.oat_col,
+            self.mat_col,
             self.cooling_sig_col,
+            self.economizer_sig_col,
         ]
-        self.check_analog_pct(df, columns_to_check)
 
-        df["abs_mat_minus_oat"] = abs(df[self.mat_col] - df[self.oat_col])
-        df["mat_oat_sqrted"] = np.sqrt(
-            self.mix_degf_err_thres**2 + self.outdoor_degf_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}"
+            )
 
-        df["combined_check"] = (
-            (df["abs_mat_minus_oat"] > df["mat_oat_sqrted"])
-            # verify ahu is running in OS 3 clg mode in min OA
-            & (df[self.cooling_sig_col] > 0.01)
-            & (df[self.economizer_sig_col] > 0.9)
+        # 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["fc10_flag"] = (rolling_sum >= self.rolling_window_size).astype(int)
 
-        if self.troubleshoot_mode:
-            print("Troubleshoot mode enabled - not removing helper columns")
-            del df["abs_mat_minus_oat"]
-            del df["mat_oat_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)
+
+            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)
+
+            df["abs_mat_minus_oat"] = abs(df[self.mat_col] - df[self.oat_col])
+            df["mat_oat_sqrted"] = np.sqrt(
+                self.mix_degf_err_thres**2 + self.outdoor_degf_err_thres**2
+            )
+
+            df["combined_check"] = (
+                (df["abs_mat_minus_oat"] > df["mat_oat_sqrted"])
+                # verify AHU is running in OS 3 clg mode in min OA
+                & (df[self.cooling_sig_col] > 0.01)
+                & (df[self.economizer_sig_col] > 0.9)
+            )
+
+            # 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["fc10_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["abs_mat_minus_oat"]
+                del df["mat_oat_sqrted"]
+                del df["combined_check"]
+
+            return df
 
-        return df
+        except MissingColumnError as e:
+            print(f"Error: {e.message}")
+            sys.stdout.flush()
+            raise e

open_fdd/air_handling_unit/faults/fault_condition_thirteen.py

@@ -1,8 +1,9 @@
 import pandas as pd
-import numpy as np
 import operator
-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 +14,7 @@ class FaultConditionThirteen(FaultCondition):
     """
 
     def __init__(self, dict_):
+        super().__init__()
         self.supply_degf_err_thres = float
         self.ahu_min_oa_dpr = float
         self.sat_col = str
@@ -22,45 +24,104 @@ class FaultConditionThirteen(FaultCondition):
         self.troubleshoot_mode = bool  # default False
         self.rolling_window_size = int
 
-        self.set_attributes(dict_)
+        self.equation_string = (
+            "fc13_flag = 1 if SAT > (SATSP + εSAT) in "
+            "economizer + mech cooling mode for N consecutive values else 0 \n"
+        )
+        self.description_string = (
+            "Fault Condition 13: Supply air temperature too high in full cooling "
+            "in economizer plus mechanical cooling mode \n"
+        )
+        self.required_column_description = (
+            "Required inputs are the supply air temperature, supply air temperature setpoint, "
+            "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_col,
+            self.sat_setpoint_col,
             self.cooling_sig_col,
+            self.economizer_sig_col,
         ]
-        self.check_analog_pct(df, columns_to_check)
 
-        # Create helper columns
-        df["sat_greater_than_sp_calc"] = (
-            df[self.sat_col] > df[self.sat_setpoint_col] + self.supply_degf_err_thres
-        )
+        # 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]
 
-        df["combined_check"] = operator.or_(
-            ((df["sat_greater_than_sp_calc"]))
-            # OS4 AHU state clg @ min OA
-            & (df[self.cooling_sig_col] > 0.01)
-            & (df[self.economizer_sig_col] == self.ahu_min_oa_dpr),  # OR
-            ((df["sat_greater_than_sp_calc"]))
-            # verify ahu is running in OS 3 clg mode in 100 OA
-            & (df[self.cooling_sig_col] > 0.01) & (df[self.economizer_sig_col] > 0.9),
+        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["fc13_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_greater_than_sp_calc"]
-            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["sat_greater_than_sp_calc"] = (
+                df[self.sat_col]
+                > df[self.sat_setpoint_col] + self.supply_degf_err_thres
+            )
 
-        return df
+            df["combined_check"] = operator.or_(
+                ((df["sat_greater_than_sp_calc"]))
+                # OS4 AHU state clg @ min OA
+                & (df[self.cooling_sig_col] > 0.01)
+                & (df[self.economizer_sig_col] == self.ahu_min_oa_dpr),  # OR
+                ((df["sat_greater_than_sp_calc"]))
+                # verify ahu is running in OS 3 clg mode in 100 OA
+                & (df[self.cooling_sig_col] > 0.01)
+                & (df[self.economizer_sig_col] > 0.9),
+            )
+
+            # 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["fc13_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_greater_than_sp_calc"]
+                del df["combined_check"]
+
+            return df
+
+        except MissingColumnError as e:
+            print(f"Error: {e.message}")
+            sys.stdout.flush()
+            raise e