open-fdd 0.1.6__py3-none-any.whl → 0.1.7__py3-none-any.whl

open_fdd/air_handling_unit/faults/__init__.py

@@ -5,6 +5,7 @@ from open_fdd.air_handling_unit.faults.fault_condition import (
     MissingColumnError,
     InvalidParameterError,
 )
+from open_fdd.air_handling_unit.faults.helper_utils import SharedUtils
 import operator
 import sys
 
@@ -800,6 +801,13 @@ class FaultConditionSix(FaultCondition):
             # Ensure all required columns are present
             self.check_required_columns(df)
 
+            # Check for zeros in the columns that could lead to division by zero errors
+            cols_to_check = [self.rat_col, self.oat_col, self.supply_fan_air_volume_col]
+            if df[cols_to_check].eq(0).any().any():
+                print(f"Warning: Zero values found in columns: {cols_to_check}")
+                print("This may cause division by zero errors.")
+                sys.stdout.flush()
+
             # Check analog outputs [data with units of %] are floats only
             columns_to_check = [
                 self.supply_vfd_speed_col,
@@ -2088,6 +2096,7 @@ class FaultConditionSixteen(FaultCondition):
 
         self.oat_low_threshold = dict_.get("OAT_LOW_THRES", 32.0)
         self.oat_high_threshold = dict_.get("OAT_HIGH_THRES", 80.0)
+        self.oat_rat_delta_min = dict_.get("OAT_RAT_DELTA_MIN", None)
 
         # Validate that threshold parameters are floats and within 0.0 and 1.0 for efficiency values
         for param, value in [
@@ -2097,6 +2106,7 @@ class FaultConditionSixteen(FaultCondition):
             ("erv_efficiency_max_cooling", self.erv_efficiency_max_cooling),
             ("oat_low_threshold", self.oat_low_threshold),
             ("oat_high_threshold", self.oat_high_threshold),
+            ("oat_rat_delta_min", self.oat_rat_delta_min),
         ]:
             if not isinstance(value, float):
                 raise InvalidParameterError(
@@ -2177,6 +2187,15 @@ class FaultConditionSixteen(FaultCondition):
         )
 
     def calculate_erv_efficiency(self, df: pd.DataFrame) -> pd.DataFrame:
+
+        df = SharedUtils.clean_nan_values(df)
+
+        cols_to_check = [self.erv_eat_enter_col, self.erv_oat_enter_col]
+        if df[cols_to_check].eq(0).any().any():
+            print(f"Warning: Zero values found in columns: {cols_to_check}")
+            print(f"This may cause division by zero errors.")
+            sys.stdout.flush()
+
         # Calculate the temperature differences
         delta_temp_oa = df[self.erv_oat_leaving_col] - df[self.erv_oat_enter_col]
         delta_temp_ea = df[self.erv_eat_enter_col] - df[self.erv_oat_enter_col]
@@ -2194,31 +2213,43 @@ class FaultConditionSixteen(FaultCondition):
             # Fan must be on for a fault to be considered
             fan_on = df[self.supply_vfd_speed_col] > 0.1
 
-            # Combined heating and cooling checks
+            # Determine if the conditions are for heating or cooling based on OAT
             cold_outside = df[self.erv_oat_enter_col] <= self.oat_low_threshold
             hot_outside = df[self.erv_oat_enter_col] >= self.oat_high_threshold
 
+            # Calculate the temperature difference between the exhaust air entering and outside air entering
+            rat_minus_oat = abs(df[self.erv_eat_enter_col] - df[self.erv_oat_enter_col])
+            good_delta_check = rat_minus_oat >= self.oat_rat_delta_min
+
+            # Initialize the fault condition to False (no fault)
+            df["fc16_flag"] = 0
+
+            # Apply heating fault logic
             heating_fault = (
                 (
                     (df["erv_efficiency_oa"] < self.erv_efficiency_min_heating)
                     | (df["erv_efficiency_oa"] > self.erv_efficiency_max_heating)
                 )
                 & cold_outside
+                & good_delta_check
                 & fan_on
             )
 
+            # Apply cooling fault logic
             cooling_fault = (
                 (
                     (df["erv_efficiency_oa"] < self.erv_efficiency_min_cooling)
                     | (df["erv_efficiency_oa"] > self.erv_efficiency_max_cooling)
                 )
                 & hot_outside
+                & good_delta_check
                 & fan_on
             )
 
+            # Combine the faults
             df["combined_checks"] = heating_fault | cooling_fault
 
-            # Apply rolling sum
+            # Apply rolling sum to combined checks to account for rolling window
             df["fc16_flag"] = (
                 df["combined_checks"]
                 .rolling(window=self.rolling_window_size)

open_fdd/air_handling_unit/faults/helper_utils.py

@@ -11,6 +11,9 @@ class HelperUtils:
     def set_config_dict(self, config_dict):
         self.config_dict = config_dict
 
+    def clean_nan_values(self, df):
+        return SharedUtils.clean_nan_values(df)
+
     def float_int_check_err(self, col):
         return SharedUtils.float_int_check_err(col)
 

open_fdd/air_handling_unit/faults/shared_utils.py

@@ -48,8 +48,10 @@ class SharedUtils:
         """
 
         print(
-            "Warning: If data has a one minute or less sampling frequency a rolling average will be automatically applied"
+            "Warning: If data has a one minute or less sampling \n"
+            "frequency a rolling average will be automatically applied"
         )
+
         sys.stdout.flush()
 
         time_diff = df.index.to_series().diff().iloc[1:]
@@ -73,3 +75,16 @@ class SharedUtils:
             )
             sys.stdout.flush()
         return df
+
+    @staticmethod
+    def clean_nan_values(df: pd.DataFrame) -> pd.DataFrame:
+        for col in df.columns:
+            if df[col].isnull().any():
+                print(f"NaN values found in column: {col}")
+
+                # Remove rows with any NaN values, then forward and backfill
+                df = df.dropna().ffill().bfill()
+                print("DataFrame has been cleaned for NaNs")
+                print("and has also been forward and backfilled.")
+                sys.stdout.flush()
+        return df

open_fdd/air_handling_unit/reports/__init__.py

@@ -914,16 +914,8 @@ class FaultCodeSixteenReport(BaseFaultReport):
         # Calculate the efficiency before plotting using FaultConditionSixteen method
         df = self.fc16.calculate_erv_efficiency(df)
 
-        print("=" * 50)
-        print("Info: ERV calculated efficiency ")
-        print("summary statistics ")
-        print(df["erv_efficiency_oa"].describe())
-        print("=" * 50)
-
-        sys.stdout.flush()
-
-        # Create the plot with four subplots
-        fig, (ax1, ax2, ax3, ax4) = plt.subplots(4, 1, figsize=(25, 10))
+        # Create the plot with five subplots
+        fig, (ax1, ax2, ax3, ax4, ax5) = plt.subplots(5, 1, figsize=(25, 14))
         fig.suptitle("Fault Conditions 16 Plot")
 
         # Plot ERV Outdoor Air Side Temps
@@ -953,6 +945,27 @@ class FaultCodeSixteenReport(BaseFaultReport):
         ax4.set_ylabel("Fault Flags")
         ax4.legend(loc="best")
 
+        # New Plot: Compare Distribution of OAT (Overall vs Fault True)
+        fault_true_df = df[df[self.fault_col] == 1]
+        data_to_plot = [
+            df[self.erv_oat_enter_col].dropna(),  # Overall OAT
+            fault_true_df[self.erv_oat_enter_col].dropna(),  # OAT when Fault is True
+        ]
+        ax5.boxplot(
+            data_to_plot,
+            vert=False,
+            patch_artist=True,
+            labels=["Overall OAT", "OAT when Fault 16 is True"],
+            boxprops=dict(facecolor="lightblue"),
+            medianprops=dict(color="red"),
+            showmeans=True,
+            meanline=True,
+            meanprops=dict(color="green"),
+        )
+        ax5.set_xlabel("Outside Air Temperature (°F)")
+        ax5.set_title("Comparison of OAT Distribution")
+        ax5.grid(True)
+
         plt.tight_layout(rect=[0, 0.03, 1, 0.95])
         plt.show()
         plt.close()

open_fdd/tests/ahu/test_ahu_fc1.py

@@ -12,6 +12,7 @@ TEST_DUCT_STATIC_ERR_THRESHOLD = 0.1
 TEST_DUCT_STATIC_COL = "duct_static"
 TEST_DUCT_STATIC_SETPOINT_COL = "duct_static_setpoint"
 TEST_SUPPLY_VFD_SPEED_COL = "supply_vfd_speed"
+
 ROLLING_WINDOW_SIZE = 5
 
 # Initialize FaultConditionOne with a dictionary

open_fdd/tests/ahu/test_ahu_fc16.py

@@ -13,7 +13,6 @@ $ py -3.12 -m pytest open_fdd/tests/ahu/test_ahu_fc16.py -rP -s
 ERV effectiveness should be within specified thresholds based on OAT.
 """
 
-
 # Constants
 TEST_ERV_EFFICIENCY_MIN_HEATING = 0.65
 TEST_ERV_EFFICIENCY_MAX_HEATING = 0.8
@@ -21,7 +20,7 @@ TEST_ERV_EFFICIENCY_MIN_COOLING = 0.45
 TEST_ERV_EFFICIENCY_MAX_COOLING = 0.6
 TEST_OAT_LOW_THRESHOLD = 32.0
 TEST_OAT_HIGH_THRESHOLD = 80.0
-TEST_ERV_DEGF_ERR_THRES = 2.0
+TEST_OAT_RAT_DELTA_THRES = 15.0
 TEST_ERV_OAT_ENTER_COL = "erv_oat_enter"
 TEST_ERV_OAT_LEAVING_COL = "erv_oat_leaving"
 TEST_ERV_EAT_ENTER_COL = "erv_eat_enter"
@@ -37,7 +36,7 @@ fault_condition_params = {
     "ERV_EFFICIENCY_MAX_COOLING": TEST_ERV_EFFICIENCY_MAX_COOLING,
     "OAT_LOW_THRESHOLD": TEST_OAT_LOW_THRESHOLD,
     "OAT_HIGH_THRESHOLD": TEST_OAT_HIGH_THRESHOLD,
-    "ERV_DEGF_ERR_THRES": TEST_ERV_DEGF_ERR_THRES,
+    "OAT_RAT_DELTA_MIN": TEST_OAT_RAT_DELTA_THRES,
     "ERV_OAT_ENTER_COL": TEST_ERV_OAT_ENTER_COL,
     "ERV_OAT_LEAVING_COL": TEST_ERV_OAT_LEAVING_COL,
     "ERV_EAT_ENTER_COL": TEST_ERV_EAT_ENTER_COL,
@@ -107,6 +106,22 @@ class TestFaultConditionSixteen:
         )
         assert actual == expected, message
 
+    def test_fault_with_insufficient_oat_rat_delta(self):
+        """Test that no fault is raised when the OAT-RAT delta is below the minimum threshold."""
+        data = {
+            TEST_ERV_OAT_ENTER_COL: [10, 10, 10, 10, 10, 10],
+            TEST_ERV_OAT_LEAVING_COL: [20.0, 20.5, 20.8, 20.6, 20.2, 20.4],
+            TEST_ERV_EAT_ENTER_COL: [24, 24, 24, 24, 24, 24],  # Low delta with OAT
+            TEST_ERV_EAT_LEAVING_COL: [22, 22.5, 22.2, 22.4, 22.1, 22.3],
+            TEST_SUPPLY_VFD_SPEED_COL: [0.5, 0.6, 0.5, 0.7, 0.5, 0.6],
+        }
+        df = pd.DataFrame(data)
+        results = fc16.apply(df)
+        actual = results["fc16_flag"].sum()
+        expected = 0  # No fault should be triggered due to insufficient delta
+        message = f"FC16 fault_with_insufficient_oat_rat_delta actual is {actual} and expected is {expected}"
+        assert actual == expected, message
+
 
 class TestFaultOnInvalidParams:
 
@@ -121,7 +136,7 @@ class TestFaultOnInvalidParams:
                     "ERV_EFFICIENCY_MAX_COOLING": 0.6,
                     "OAT_LOW_THRESHOLD": 32.0,
                     "OAT_HIGH_THRESHOLD": 80.0,
-                    "ERV_DEGF_ERR_THRES": 2.0,
+                    "OAT_RAT_DELTA_MIN": TEST_OAT_RAT_DELTA_THRES,
                     "ERV_OAT_ENTER_COL": TEST_ERV_OAT_ENTER_COL,
                     "ERV_OAT_LEAVING_COL": TEST_ERV_OAT_LEAVING_COL,
                     "ERV_EAT_ENTER_COL": TEST_ERV_EAT_ENTER_COL,
@@ -142,7 +157,7 @@ class TestFaultOnInvalidParams:
                     "ERV_EFFICIENCY_MAX_COOLING": 0.6,
                     "OAT_LOW_THRESHOLD": 32.0,
                     "OAT_HIGH_THRESHOLD": 80.0,
-                    "ERV_DEGF_ERR_THRES": 2.0,
+                    "OAT_RAT_DELTA_MIN": TEST_OAT_RAT_DELTA_THRES,
                     "ERV_OAT_ENTER_COL": TEST_ERV_OAT_ENTER_COL,
                     "ERV_OAT_LEAVING_COL": TEST_ERV_OAT_LEAVING_COL,
                     "ERV_EAT_ENTER_COL": TEST_ERV_EAT_ENTER_COL,
@@ -166,7 +181,7 @@ class TestFaultOnMissingColumns:
                     "ERV_EFFICIENCY_MAX_COOLING": 0.6,
                     "OAT_LOW_THRESHOLD": 32.0,
                     "OAT_HIGH_THRESHOLD": 80.0,
-                    "ERV_DEGF_ERR_THRES": 2.0,
+                    "OAT_RAT_DELTA_MIN": TEST_OAT_RAT_DELTA_THRES,
                     "ERV_OAT_ENTER_COL": TEST_ERV_OAT_ENTER_COL,
                     "ERV_OAT_LEAVING_COL": None,  # Missing column
                     "ERV_EAT_ENTER_COL": TEST_ERV_EAT_ENTER_COL,

{open_fdd-0.1.6.dist-info → open_fdd-0.1.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: open_fdd
-Version: 0.1.6
+Version: 0.1.7
 Summary: A package for fault detection and diagnosis in HVAC systems
 Home-page: https://github.com/bbartling/open-fdd
 Author: Ben Bartling

{open_fdd-0.1.6.dist-info → open_fdd-0.1.7.dist-info}/RECORD

@@ -1,21 +1,21 @@
 open_fdd/__init__.py,sha256=iGj8QTOZJUTE4nNnBiCHXEXsOdV6YvKcGiLrnOusJCg,1411
 open_fdd/air_handling_unit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-open_fdd/air_handling_unit/faults/__init__.py,sha256=NBdGNlp0MTUPNB-43zgnYs3iYqFhEeNa3q_VgDPGAoo,91603
+open_fdd/air_handling_unit/faults/__init__.py,sha256=Gc2VjfRDEX0-JcIrPuV692T3Ek3GGlTgrscqUXslrwY,93217
 open_fdd/air_handling_unit/faults/fault_condition.py,sha256=UN2_k2AZWMDoO4oPAnJW3fvhkHlMkLXZikzU2lXAOuQ,2364
-open_fdd/air_handling_unit/faults/helper_utils.py,sha256=-Bd1mMMLnFmpNPe7eC23kMJxPtazsIyz5P7W6Yqlu4w,12580
-open_fdd/air_handling_unit/faults/shared_utils.py,sha256=Kp8ZUBhtrh-jU2Q_bbXTpnbVVUAyacp41tDMknY50i4,2252
-open_fdd/air_handling_unit/reports/__init__.py,sha256=iXIqEaaO_8yRnlVUuYMcc_L0xQf3iqSYi3ykIzeGBf8,40124
+open_fdd/air_handling_unit/faults/helper_utils.py,sha256=el_s2BC9Q14GXUGnazOiBBhzVUMsPBP9sxEG1UIQ6Gw,12668
+open_fdd/air_handling_unit/faults/shared_utils.py,sha256=rAx27IsG_7OEHLLFHool6o9LAuaMyYisit9gLu8ZVQk,2802
+open_fdd/air_handling_unit/reports/__init__.py,sha256=JccL19Spj6vE0Jo_57CmZEFucu4WbCPj1-pIwR5LmPg,40741
 open_fdd/air_handling_unit/reports/fault_report.py,sha256=QxYLJzoLTwf1N0nls2XMmhHJvBSgGCBNT0KxA59QG4Y,1442
 open_fdd/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 open_fdd/tests/ahu/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-open_fdd/tests/ahu/test_ahu_fc1.py,sha256=ojpdYGZtuIYAKnZ4W9KhxQuoyXnGEI5N7braQXh3kAw,5437
+open_fdd/tests/ahu/test_ahu_fc1.py,sha256=Pw5XlQ19c5Sit0Lyuor8L8lKgxl5PFn4UhruIHyKDfc,5439
 open_fdd/tests/ahu/test_ahu_fc10.py,sha256=niYL7fi6OlgP0wnF8hNh9A07PLzHiRZkyRkrA1zoL2s,4577
 open_fdd/tests/ahu/test_ahu_fc11.py,sha256=mdXlGiEMPkPfshf3NN_nJavL74e4HCmkJQMu86aZc6Q,4723
 open_fdd/tests/ahu/test_ahu_fc12.py,sha256=5T-XcM6xm9KHrc121uPGC9JWLCYehrAYk0KcbmGgYjw,5848
 open_fdd/tests/ahu/test_ahu_fc13.py,sha256=vJlSy4e2WV9hx02P0SiJ75I1DWL2lZ0p7-AWlw97pks,5725
 open_fdd/tests/ahu/test_ahu_fc14.py,sha256=MU0LKqIuoQ_dJ0Kij8_A0YyimCMvUwL6IlMwpQhDbqI,8052
 open_fdd/tests/ahu/test_ahu_fc15.py,sha256=SIolJ9vnJwnpKfRW2ALugYWySuIiZ9_repWP9fdb5H4,7661
-open_fdd/tests/ahu/test_ahu_fc16.py,sha256=3xhNfN2pKon-2_jyCUSh_JEKSv9jYGiTxRjLOL7uvVI,8052
+open_fdd/tests/ahu/test_ahu_fc16.py,sha256=f656EZCWEKOXE2GZHUayaLc8bjMZWX_QB99QDBJxF4Y,9020
 open_fdd/tests/ahu/test_ahu_fc2.py,sha256=CjmO_WUyaSHs17ifCCew3GBJ43nYG55uGL0vHDZpAq8,4736
 open_fdd/tests/ahu/test_ahu_fc3.py,sha256=NB6pOXDS-R4P0LNoRN8ItAqhhLnGnGuAHZha32Qw-hE,4658
 open_fdd/tests/ahu/test_ahu_fc4.py,sha256=vV8jEnFuNGLfhCoTVz29RsIcoDpDOMWg722G0aBEXaE,6304
@@ -24,8 +24,8 @@ open_fdd/tests/ahu/test_ahu_fc6.py,sha256=66dwv0EBU_ujZK-J9Ki5a3fnXlk17nOwmtKDiQ
 open_fdd/tests/ahu/test_ahu_fc7.py,sha256=sABbw2m7WlAXbsqfDD323vfEfg606ThI0QzQyB-OjFo,2469
 open_fdd/tests/ahu/test_ahu_fc8.py,sha256=UZy6BP2PgV1FROUPqMORTx8YnT5ZvqVDhut_Ar81494,4663
 open_fdd/tests/ahu/test_ahu_fc9.py,sha256=b-eIzhNzjZUjVNsP0JAHkOgZu-BtDuPeNnblVVm-jU8,4796
-open_fdd-0.1.6.dist-info/LICENSE,sha256=eghao_GGx_0gB2Sll3x2vV29knONEzUQKrkaXpX1F7w,1087
-open_fdd-0.1.6.dist-info/METADATA,sha256=IER_eG7nwqbDIoDA2a9LyFgh20pOeBYhAGHlhT1PFLo,6958
-open_fdd-0.1.6.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
-open_fdd-0.1.6.dist-info/top_level.txt,sha256=Q7sB6UB2d8Ch1v_xIsTiNegmgcCXPkwkrxK3ug6VEOs,9
-open_fdd-0.1.6.dist-info/RECORD,,
+open_fdd-0.1.7.dist-info/LICENSE,sha256=eghao_GGx_0gB2Sll3x2vV29knONEzUQKrkaXpX1F7w,1087
+open_fdd-0.1.7.dist-info/METADATA,sha256=891NmSrFes9HOcjBiW0Lp7ixCbjN4lhorEWtOWICg0E,6958
+open_fdd-0.1.7.dist-info/WHEEL,sha256=uCRv0ZEik_232NlR4YDw4Pv3Ajt5bKvMH13NUU7hFuI,91
+open_fdd-0.1.7.dist-info/top_level.txt,sha256=Q7sB6UB2d8Ch1v_xIsTiNegmgcCXPkwkrxK3ug6VEOs,9
+open_fdd-0.1.7.dist-info/RECORD,,

{open_fdd-0.1.6.dist-info → open_fdd-0.1.7.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.0.0)
+Generator: setuptools (74.1.1)
 Root-Is-Purelib: true
 Tag: py3-none-any