open-fdd 0.1.0__py3-none-any.whl

open_fdd/tests/ahu/test_ahu_fc15.py

@@ -0,0 +1,183 @@
+import pandas as pd
+import pytest
+from open_fdd.air_handling_unit.faults.fault_condition_fifteen import (
+    FaultConditionFifteen,
+)
+from open_fdd.air_handling_unit.faults.helper_utils import HelperUtils
+
+"""
+To see print statements in pytest run with:
+$ py -3.12 -m pytest open_fdd/tests/ahu/test_ahu_fc15.py -rP -s 
+
+Temp rise across inactive htg coil in OS2, OS3, & OS4
+"""
+
+# Constants
+TEST_DELTA_SUPPLY_FAN = 2.0
+TEST_COIL_TEMP_ENTER_ERR_THRES = 1.0
+TEST_COIL_TEMP_LEAVE_ERR_THRES = 1.0
+TEST_AHU_MIN_OA_DPR = 0.2
+TEST_HTG_COIL_ENTER_TEMP_COL = "htg_enter_air_temp"
+TEST_HTG_COIL_LEAVE_TEMP_COL = "htg_leave_air_temp"
+TEST_CLG_COIL_CMD_COL = "cooling_sig_col"
+TEST_HTG_COIL_CMD_COL = "heating_sig_col"
+TEST_MIX_AIR_DAMPER_COL = "economizer_sig_col"
+TEST_SUPPLY_VFD_SPEED_COL = "supply_vfd_speed"
+ROLLING_WINDOW_SIZE = 5
+
+# Initialize FaultConditionFifteen with a dictionary
+fault_condition_params = {
+    "DELTA_SUPPLY_FAN": TEST_DELTA_SUPPLY_FAN,
+    "COIL_TEMP_ENTER_ERR_THRES": TEST_COIL_TEMP_ENTER_ERR_THRES,
+    "COIL_TEMP_LEAV_ERR_THRES": TEST_COIL_TEMP_LEAVE_ERR_THRES,
+    "AHU_MIN_OA_DPR": TEST_AHU_MIN_OA_DPR,
+    "HTG_COIL_ENTER_TEMP_COL": TEST_HTG_COIL_ENTER_TEMP_COL,
+    "HTG_COIL_LEAVE_TEMP_COL": TEST_HTG_COIL_LEAVE_TEMP_COL,
+    "COOLING_SIG_COL": TEST_CLG_COIL_CMD_COL,
+    "HEATING_SIG_COL": TEST_HTG_COIL_CMD_COL,
+    "ECONOMIZER_SIG_COL": TEST_MIX_AIR_DAMPER_COL,
+    "SUPPLY_VFD_SPEED_COL": TEST_SUPPLY_VFD_SPEED_COL,
+    "TROUBLESHOOT_MODE": False,
+    "ROLLING_WINDOW_SIZE": ROLLING_WINDOW_SIZE,
+}
+
+fc15 = FaultConditionFifteen(fault_condition_params)
+
+
+class TestFaultConditionFifteen:
+
+    def no_fault_df_econ(self) -> pd.DataFrame:
+        data = {
+            TEST_HTG_COIL_ENTER_TEMP_COL: [55, 55, 55, 55, 55, 55],
+            TEST_HTG_COIL_LEAVE_TEMP_COL: [56.5, 56.5, 56.5, 56.5, 56.5, 56.5],
+            TEST_HTG_COIL_CMD_COL: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
+            TEST_CLG_COIL_CMD_COL: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
+            TEST_MIX_AIR_DAMPER_COL: [0.55, 0.55, 0.55, 0.55, 0.55, 0.55],
+            TEST_SUPPLY_VFD_SPEED_COL: [0.55, 0.55, 0.55, 0.55, 0.55, 0.55],
+        }
+        return pd.DataFrame(data)
+
+    def no_fault_df_os3(self) -> pd.DataFrame:
+        data = {
+            TEST_HTG_COIL_ENTER_TEMP_COL: [55, 55, 55, 55, 55, 55],
+            TEST_HTG_COIL_LEAVE_TEMP_COL: [56.5, 56.5, 56.5, 56.5, 56.5, 56.5],
+            TEST_HTG_COIL_CMD_COL: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
+            TEST_CLG_COIL_CMD_COL: [0.55, 0.55, 0.55, 0.55, 0.55, 0.55],
+            TEST_MIX_AIR_DAMPER_COL: [0.99, 0.99, 0.99, 0.99, 0.99, 0.99],
+            TEST_SUPPLY_VFD_SPEED_COL: [0.55, 0.55, 0.55, 0.55, 0.55, 0.55],
+        }
+        return pd.DataFrame(data)
+
+    def fault_df_in_econ(self) -> pd.DataFrame:
+        data = {
+            TEST_HTG_COIL_ENTER_TEMP_COL: [136.5, 136.5, 136.5, 136.5, 136.5, 136.5],
+            TEST_HTG_COIL_LEAVE_TEMP_COL: [140, 140, 140, 140, 140, 140],
+            TEST_HTG_COIL_CMD_COL: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
+            TEST_CLG_COIL_CMD_COL: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
+            TEST_MIX_AIR_DAMPER_COL: [0.55, 0.55, 0.55, 0.55, 0.55, 0.55],
+            TEST_SUPPLY_VFD_SPEED_COL: [0.55, 0.55, 0.55, 0.55, 0.55, 0.55],
+        }
+        return pd.DataFrame(data)
+
+    def fault_df_in_os3(self) -> pd.DataFrame:
+        data = {
+            TEST_HTG_COIL_ENTER_TEMP_COL: [136.5, 136.5, 136.5, 136.5, 136.5, 136.5],
+            TEST_HTG_COIL_LEAVE_TEMP_COL: [140, 140, 140, 140, 140, 140],
+            TEST_HTG_COIL_CMD_COL: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
+            TEST_CLG_COIL_CMD_COL: [0.55, 0.55, 0.55, 0.55, 0.55, 0.55],
+            TEST_MIX_AIR_DAMPER_COL: [0.99, 0.99, 0.99, 0.99, 0.99, 0.99],
+            TEST_SUPPLY_VFD_SPEED_COL: [0.55, 0.55, 0.55, 0.55, 0.55, 0.55],
+        }
+        return pd.DataFrame(data)
+
+    def test_no_fault_econ(self):
+        results = fc15.apply(self.no_fault_df_econ())
+        actual = results["fc15_flag"].sum()
+        expected = 0
+        message = f"FC15 no_fault_df_econ actual is {actual} and expected is {expected}"
+        assert actual == expected, message
+
+    def test_no_fault_os3(self):
+        results = fc15.apply(self.no_fault_df_os3())
+        actual = results["fc15_flag"].sum()
+        expected = 0
+        message = f"FC15 no_fault_df_os3 actual is {actual} and expected is {expected}"
+        assert actual == expected, message
+
+    def test_fault_in_econ(self):
+        results = fc15.apply(self.fault_df_in_econ())
+        actual = results["fc15_flag"].sum()
+        expected = 2
+        message = f"FC15 fault_df_in_econ actual is {actual} and expected is {expected}"
+        assert actual == expected, message
+
+    def test_fault_in_os3(self):
+        results = fc15.apply(self.fault_df_in_os3())
+        actual = results["fc15_flag"].sum()
+        expected = 2
+        message = f"FC15 fault_df_in_os3 actual is {actual} and expected is {expected}"
+        assert actual == expected, message
+
+
+class TestFaultOnInt:
+
+    def fault_df_on_output_int(self) -> pd.DataFrame:
+        data = {
+            TEST_HTG_COIL_ENTER_TEMP_COL: [50.5, 50.5, 50.5, 50.5, 50.5, 50.5],
+            TEST_HTG_COIL_LEAVE_TEMP_COL: [55, 55, 55, 55, 55, 55],
+            TEST_HTG_COIL_CMD_COL: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
+            TEST_CLG_COIL_CMD_COL: [0.55, 0.55, 0.55, 0.55, 0.55, 0.55],
+            TEST_MIX_AIR_DAMPER_COL: [55, 55, 55, 55, 55, 55],  # Incorrect type
+            TEST_SUPPLY_VFD_SPEED_COL: [0.55, 0.55, 0.55, 0.55, 0.55, 0.55],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault_on_int(self):
+        with pytest.raises(
+            TypeError, match=HelperUtils().float_int_check_err(TEST_MIX_AIR_DAMPER_COL)
+        ):
+            fc15.apply(self.fault_df_on_output_int())
+
+
+class TestFaultOnFloatGreaterThanOne:
+
+    def fault_df_on_output_greater_than_one(self) -> pd.DataFrame:
+        data = {
+            TEST_HTG_COIL_ENTER_TEMP_COL: [50.5, 50.5, 50.5, 50.5, 50.5, 50.5],
+            TEST_HTG_COIL_LEAVE_TEMP_COL: [55, 55, 55, 55, 55, 55],
+            TEST_HTG_COIL_CMD_COL: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
+            TEST_CLG_COIL_CMD_COL: [0.55, 0.55, 0.55, 0.55, 0.55, 0.55],
+            TEST_MIX_AIR_DAMPER_COL: [1.1, 1.2, 1.1, 1.3, 1.1, 1.2],  # Values > 1.0
+            TEST_SUPPLY_VFD_SPEED_COL: [0.55, 0.55, 0.55, 0.55, 0.55, 0.55],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault_on_float_greater_than_one(self):
+        with pytest.raises(
+            TypeError, match=HelperUtils().float_max_check_err(TEST_MIX_AIR_DAMPER_COL)
+        ):
+            fc15.apply(self.fault_df_on_output_greater_than_one())
+
+
+class TestFaultOnMixedTypes:
+
+    def fault_df_on_mixed_types(self) -> pd.DataFrame:
+        data = {
+            TEST_HTG_COIL_ENTER_TEMP_COL: [50.5, 50.5, 50.5, 50.5, 50.5, 50.5],
+            TEST_HTG_COIL_LEAVE_TEMP_COL: [55, 55, 55, 55, 55, 55],
+            TEST_HTG_COIL_CMD_COL: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
+            TEST_CLG_COIL_CMD_COL: [0.55, 0.55, 0.55, 0.55, 0.55, 0.55],
+            TEST_MIX_AIR_DAMPER_COL: [1.1, 0.55, 1.2, 1.3, 0.55, 1.1],  # Mixed types
+            TEST_SUPPLY_VFD_SPEED_COL: [0.55, 0.55, 0.55, 0.55, 0.55, 0.55],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault_on_mixed_types(self):
+        with pytest.raises(
+            TypeError, match=HelperUtils().float_max_check_err(TEST_MIX_AIR_DAMPER_COL)
+        ):
+            fc15.apply(self.fault_df_on_mixed_types())
+
+
+if __name__ == "__main__":
+    pytest.main()

open_fdd/tests/ahu/test_ahu_fc2.py

@@ -0,0 +1,132 @@
+import pandas as pd
+import pytest
+from open_fdd.air_handling_unit.faults.fault_condition_two import FaultConditionTwo
+from open_fdd.air_handling_unit.faults.helper_utils import HelperUtils
+
+"""
+To see print statements in pytest run with:
+$ py -3.12 -m pytest tests/ahu/test_ahu_fc2.py -rP -s
+
+Mix air temp lower than out temp
+"""
+
+TEST_OUTDOOR_DEGF_ERR_THRES = 5.0
+TEST_MIX_DEGF_ERR_THRES = 2.0
+TEST_RETURN_DEGF_ERR_THRES = 2.0
+TEST_MIX_TEMP_COL = "mix_air_temp"
+TEST_RETURN_TEMP_COL = "return_air_temp"
+TEST_OUT_TEMP_COL = "out_air_temp"
+TEST_SUPPLY_VFD_SPEED_COL = "supply_vfd_speed"
+TEST_ROLLING_WINDOW_SIZE = 5
+
+# Initialize FaultConditionTwo with a dictionary
+fault_condition_params = {
+    "MIX_DEGF_ERR_THRES": TEST_MIX_DEGF_ERR_THRES,
+    "RETURN_DEGF_ERR_THRES": TEST_RETURN_DEGF_ERR_THRES,
+    "OUTDOOR_DEGF_ERR_THRES": TEST_OUTDOOR_DEGF_ERR_THRES,
+    "MAT_COL": TEST_MIX_TEMP_COL,
+    "RAT_COL": TEST_RETURN_TEMP_COL,
+    "OAT_COL": TEST_OUT_TEMP_COL,
+    "SUPPLY_VFD_SPEED_COL": TEST_SUPPLY_VFD_SPEED_COL,
+    "TROUBLESHOOT_MODE": False,  # default value
+    "ROLLING_WINDOW_SIZE": TEST_ROLLING_WINDOW_SIZE,
+}
+
+fc2 = FaultConditionTwo(fault_condition_params)
+
+
+class TestNoFault(object):
+
+    def no_fault_df(self) -> pd.DataFrame:
+        data = {
+            TEST_MIX_TEMP_COL: [60.0, 62.0, 64.0, 61.0, 63.0, 60.0],
+            TEST_RETURN_TEMP_COL: [72.0, 73.0, 74.0, 72.0, 73.0, 72.0],
+            TEST_OUT_TEMP_COL: [45.0, 46.0, 47.0, 45.0, 46.0, 45.0],
+            TEST_SUPPLY_VFD_SPEED_COL: [0.8, 0.82, 0.85, 0.8, 0.83, 0.8],
+        }
+        return pd.DataFrame(data)
+
+    def test_no_fault(self):
+        results = fc2.apply(self.no_fault_df())
+        actual = results["fc2_flag"].sum()
+        expected = 0
+        message = f"fc2 no_fault_df actual is {actual} and expected is {expected}"
+        print(message)
+        assert actual == expected, message
+
+
+class TestFault(object):
+
+    def fault_df(self) -> pd.DataFrame:
+        data = {
+            TEST_MIX_TEMP_COL: [45.0, 46.0, 45.0, 46.0, 45.0, 45.0],
+            TEST_RETURN_TEMP_COL: [72.0, 72.5, 73.0, 72.0, 72.5, 72.0],
+            TEST_OUT_TEMP_COL: [60.0, 60.5, 61.0, 60.0, 60.5, 60.0],
+            TEST_SUPPLY_VFD_SPEED_COL: [0.8, 0.82, 0.81, 0.8, 0.82, 0.8],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault(self):
+        results = fc2.apply(self.fault_df())
+        actual = results["fc2_flag"].sum()
+        expected = 2
+        message = f"fc2 fault_df actual is {actual} and expected is {expected}"
+        print(message)
+        assert actual == expected, message
+
+
+class TestFaultOnInt(object):
+
+    def fault_df_on_output_int(self) -> pd.DataFrame:
+        data = {
+            TEST_MIX_TEMP_COL: [45.0, 46.0, 45.0, 46.0, 45.0, 45.0],
+            TEST_RETURN_TEMP_COL: [72.0, 72.5, 73.0, 72.0, 72.5, 72.0],
+            TEST_OUT_TEMP_COL: [60.0, 60.5, 61.0, 60.0, 60.5, 60.0],
+            TEST_SUPPLY_VFD_SPEED_COL: [88, 88, 88, 88, 88, 88],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault_on_int(self):
+        with pytest.raises(
+            TypeError,
+            match=HelperUtils().float_int_check_err(TEST_SUPPLY_VFD_SPEED_COL),
+        ):
+            fc2.apply(self.fault_df_on_output_int())
+
+
+class TestFaultOnFloatGreaterThanOne(object):
+
+    def fault_df_on_output_greater_than_one(self) -> pd.DataFrame:
+        data = {
+            TEST_MIX_TEMP_COL: [45.0, 46.0, 45.0, 46.0, 45.0, 45.0],
+            TEST_RETURN_TEMP_COL: [72.0, 72.5, 73.0, 72.0, 72.5, 72.0],
+            TEST_OUT_TEMP_COL: [60.0, 60.5, 61.0, 60.0, 60.5, 60.0],
+            TEST_SUPPLY_VFD_SPEED_COL: [1.1, 1.2, 1.3, 1.1, 1.2, 1.1],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault_on_float_greater_than_one(self):
+        with pytest.raises(
+            TypeError,
+            match=HelperUtils().float_max_check_err(TEST_SUPPLY_VFD_SPEED_COL),
+        ):
+            fc2.apply(self.fault_df_on_output_greater_than_one())
+
+
+class TestFaultOnMixedTypes(object):
+
+    def fault_df_on_mixed_types(self) -> pd.DataFrame:
+        data = {
+            TEST_MIX_TEMP_COL: [45.0, 46.0, 45.0, 46.0, 45.0, 45.0],
+            TEST_RETURN_TEMP_COL: [72.0, 72.5, 73.0, 72.0, 72.5, 72.0],
+            TEST_OUT_TEMP_COL: [60.0, 60.5, 61.0, 60.0, 60.5, 60.0],
+            TEST_SUPPLY_VFD_SPEED_COL: [1.1, 0.82, 1.3, 1.1, 0.82, 1.1],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault_on_mixed_types(self):
+        with pytest.raises(
+            TypeError,
+            match=HelperUtils().float_max_check_err(TEST_SUPPLY_VFD_SPEED_COL),
+        ):
+            fc2.apply(self.fault_df_on_mixed_types())

open_fdd/tests/ahu/test_ahu_fc3.py

@@ -0,0 +1,131 @@
+import pandas as pd
+import pytest
+from open_fdd.air_handling_unit.faults.fault_condition_three import FaultConditionThree
+from open_fdd.air_handling_unit.faults.helper_utils import HelperUtils
+
+"""
+To see print statements in pytest run with:
+$ py -3.12 -m pytest tests/ahu/test_ahu_fc3.py -rP -s
+
+Mix air temp higher than out temp
+"""
+
+# Constants
+TEST_MIX_DEGF_ERR_THRES = 2.0
+TEST_RETURN_DEGF_ERR_THRES = 2.0
+TEST_OUTDOOR_DEGF_ERR_THRES = 5.0
+TEST_MIX_TEMP_COL = "mix_air_temp"
+TEST_RETURN_TEMP_COL = "return_air_temp"
+TEST_OUT_TEMP_COL = "out_air_temp"
+TEST_SUPPLY_VFD_SPEED_COL = "supply_vfd_speed"
+ROLLING_WINDOW_SIZE = 5
+
+# Initialize FaultConditionThree with a dictionary
+fault_condition_params = {
+    "MIX_DEGF_ERR_THRES": TEST_MIX_DEGF_ERR_THRES,
+    "RETURN_DEGF_ERR_THRES": TEST_RETURN_DEGF_ERR_THRES,
+    "OUTDOOR_DEGF_ERR_THRES": TEST_OUTDOOR_DEGF_ERR_THRES,
+    "MAT_COL": TEST_MIX_TEMP_COL,
+    "RAT_COL": TEST_RETURN_TEMP_COL,
+    "OAT_COL": TEST_OUT_TEMP_COL,
+    "SUPPLY_VFD_SPEED_COL": TEST_SUPPLY_VFD_SPEED_COL,
+    "TROUBLESHOOT_MODE": False,  # default value
+    "ROLLING_WINDOW_SIZE": ROLLING_WINDOW_SIZE,
+}
+
+fc3 = FaultConditionThree(fault_condition_params)
+
+
+class TestNoFault:
+
+    def no_fault_df(self) -> pd.DataFrame:
+        data = {
+            TEST_MIX_TEMP_COL: [55.0, 56.0, 57.0, 56.0, 55.5, 55.0],
+            TEST_RETURN_TEMP_COL: [70.0, 71.0, 72.0, 70.0, 71.0, 70.0],
+            TEST_OUT_TEMP_COL: [50.0, 51.0, 52.0, 50.0, 51.0, 50.0],
+            TEST_SUPPLY_VFD_SPEED_COL: [0.8, 0.82, 0.83, 0.8, 0.82, 0.8],
+        }
+        return pd.DataFrame(data)
+
+    def test_no_fault(self):
+        results = fc3.apply(self.no_fault_df())
+        actual = results["fc3_flag"].sum()
+        expected = 0
+        message = f"FC3 no_fault_df actual is {actual} and expected is {expected}"
+        assert actual == expected, message
+
+
+class TestFault:
+
+    def fault_df(self) -> pd.DataFrame:
+        data = {
+            TEST_MIX_TEMP_COL: [80.0, 81.0, 79.0, 80.5, 82.0, 80.0],
+            TEST_RETURN_TEMP_COL: [70.0, 70.5, 71.0, 70.0, 70.5, 70.0],
+            TEST_OUT_TEMP_COL: [50.0, 51.0, 52.0, 50.5, 51.0, 50.0],
+            TEST_SUPPLY_VFD_SPEED_COL: [0.9, 0.91, 0.92, 0.9, 0.91, 0.9],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault(self):
+        results = fc3.apply(self.fault_df())
+        actual = results["fc3_flag"].sum()
+        expected = 2
+        message = f"FC3 fault_df actual is {actual} and expected is {expected}"
+        assert actual == expected, message
+
+
+class TestFaultOnInt:
+
+    def fault_df_on_output_int(self) -> pd.DataFrame:
+        data = {
+            TEST_MIX_TEMP_COL: [80.0, 81.0, 79.0, 80.5, 82.0, 80.0],
+            TEST_RETURN_TEMP_COL: [70.0, 70.5, 71.0, 70.0, 70.5, 70.0],
+            TEST_OUT_TEMP_COL: [50.0, 51.0, 52.0, 50.5, 51.0, 50.0],
+            TEST_SUPPLY_VFD_SPEED_COL: [99, 99, 99, 99, 99, 99],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault_on_int(self):
+        with pytest.raises(
+            TypeError,
+            match=HelperUtils().float_int_check_err(TEST_SUPPLY_VFD_SPEED_COL),
+        ):
+            fc3.apply(self.fault_df_on_output_int())
+
+
+class TestFaultOnFloatGreaterThanOne:
+
+    def fault_df_on_output_greater_than_one(self) -> pd.DataFrame:
+        data = {
+            TEST_MIX_TEMP_COL: [80.0, 81.0, 79.0, 80.5, 82.0, 80.0],
+            TEST_RETURN_TEMP_COL: [70.0, 70.5, 71.0, 70.0, 70.5, 70.0],
+            TEST_OUT_TEMP_COL: [50.0, 51.0, 52.0, 50.5, 51.0, 50.0],
+            TEST_SUPPLY_VFD_SPEED_COL: [1.1, 1.2, 1.3, 1.1, 1.2, 1.1],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault_on_float_greater_than_one(self):
+        with pytest.raises(
+            TypeError,
+            match=HelperUtils().float_max_check_err(TEST_SUPPLY_VFD_SPEED_COL),
+        ):
+            fc3.apply(self.fault_df_on_output_greater_than_one())
+
+
+class TestFaultOnMixedTypes:
+
+    def fault_df_on_mixed_types(self) -> pd.DataFrame:
+        data = {
+            TEST_MIX_TEMP_COL: [80.0, 81.0, 79.0, 80.5, 82.0, 80.0],
+            TEST_RETURN_TEMP_COL: [70.0, 70.5, 71.0, 70.0, 70.5, 70.0],
+            TEST_OUT_TEMP_COL: [50.0, 51.0, 52.0, 50.5, 51.0, 50.0],
+            TEST_SUPPLY_VFD_SPEED_COL: [1.1, 0.91, 1.3, 1.1, 0.92, 1.1],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault_on_mixed_types(self):
+        with pytest.raises(
+            TypeError,
+            match=HelperUtils().float_max_check_err(TEST_SUPPLY_VFD_SPEED_COL),
+        ):
+            fc3.apply(self.fault_df_on_mixed_types())

open_fdd/tests/ahu/test_ahu_fc4.py

@@ -0,0 +1,200 @@
+import pandas as pd
+import pytest
+from open_fdd.air_handling_unit.faults.fault_condition_four import FaultConditionFour
+from open_fdd.air_handling_unit.faults.helper_utils import HelperUtils
+from datetime import datetime, timezone
+
+"""
+To see print statements in pytest run with:
+$ py -3.12 -m pytest open_fdd/tests/ahu/test_ahu_fc4.py -rP -s
+
+Too much hunting in control system
+OS state changes greater than 7 in an hour
+"""
+
+# Constants
+DELTA_OS_MAX = 7
+AHU_MIN_OA = 0.20
+TEST_MIX_AIR_DAMPER_COL = "economizer_sig_col"
+TEST_HEATING_COIL_SIG_COL = "heating_sig_col"
+TEST_COOLING_COIL_SIG_COL = "cooling_sig_col"
+TEST_SUPPLY_VFD_SPEED_COL = "fan_vfd_speed_col"
+TEST_DATASET_ROWS = 60
+
+# Initialize FaultConditionFour with a dictionary
+fault_condition_params = {
+    "DELTA_OS_MAX": DELTA_OS_MAX,
+    "AHU_MIN_OA_DPR": AHU_MIN_OA,
+    "ECONOMIZER_SIG_COL": TEST_MIX_AIR_DAMPER_COL,
+    "HEATING_SIG_COL": TEST_HEATING_COIL_SIG_COL,
+    "COOLING_SIG_COL": TEST_COOLING_COIL_SIG_COL,
+    "SUPPLY_VFD_SPEED_COL": TEST_SUPPLY_VFD_SPEED_COL,
+    "TROUBLESHOOT_MODE": False,  # default value
+}
+
+fc4 = FaultConditionFour(fault_condition_params)
+
+
+def generate_timestamp() -> pd.Series:
+    df = pd.DataFrame()
+    date_range = pd.period_range(
+        # make a time stamp starting at top of
+        # the hour with one min intervals
+        start=datetime(2022, 6, 6, 14, 30, 0, 0, tzinfo=timezone.utc),
+        periods=TEST_DATASET_ROWS,
+        freq="min",
+    )
+    df["Date"] = [x.to_timestamp() for x in date_range]
+    return df["Date"]
+
+
+def econ_plus_mech_clg_row() -> dict:
+    data = {
+        TEST_MIX_AIR_DAMPER_COL: 0.6,
+        TEST_HEATING_COIL_SIG_COL: 0.0,
+        TEST_COOLING_COIL_SIG_COL: 0.6,
+        TEST_SUPPLY_VFD_SPEED_COL: 0.8,
+    }
+    return data
+
+
+def mech_clg_row() -> dict:
+    data = {
+        TEST_MIX_AIR_DAMPER_COL: 0.0,
+        TEST_HEATING_COIL_SIG_COL: 0.0,
+        TEST_COOLING_COIL_SIG_COL: 0.6,
+        TEST_SUPPLY_VFD_SPEED_COL: 0.8,
+    }
+    return data
+
+
+def econ_plus_mech_clg_row_int() -> dict:
+    data = {
+        TEST_MIX_AIR_DAMPER_COL: 0.6,
+        TEST_HEATING_COIL_SIG_COL: 0.0,
+        TEST_COOLING_COIL_SIG_COL: 0.6,
+        TEST_SUPPLY_VFD_SPEED_COL: 88,
+    }
+    return data
+
+
+def econ_plus_mech_clg_row_float_greater_than_one() -> dict:
+    data = {
+        TEST_MIX_AIR_DAMPER_COL: 0.6,
+        TEST_HEATING_COIL_SIG_COL: 0.0,
+        TEST_COOLING_COIL_SIG_COL: 0.6,
+        TEST_SUPPLY_VFD_SPEED_COL: 88.8,
+    }
+    return data
+
+
+class TestFault(object):
+
+    def fault_df(self) -> pd.DataFrame:
+        data = []
+        counter = 0
+        for i in range(TEST_DATASET_ROWS):
+            if i % 2 == 0 and counter < 11:
+                data.append(econ_plus_mech_clg_row())
+                counter += 1  # only simulate 10 OS changes
+            else:
+                data.append(mech_clg_row())
+        return pd.DataFrame(data)
+
+    def test_fault(self):
+        fault_df = self.fault_df().set_index(generate_timestamp())
+        results = fc4.apply(fault_df)
+        actual = results["fc4_flag"].sum()
+        expected = 1
+        message = f"FC4 fault_df actual is {actual} and expected is {expected}"
+        assert actual == expected, message
+
+
+class TestNoFault(object):
+
+    def no_fault_df(self) -> pd.DataFrame:
+        data = []
+        for i in range(TEST_DATASET_ROWS):
+            data.append(mech_clg_row())
+        return pd.DataFrame(data)
+
+    def test_no_fault(self):
+        no_fault_df = self.no_fault_df().set_index(generate_timestamp())
+        results = fc4.apply(no_fault_df)
+        actual = results["fc4_flag"].sum()
+        expected = 0
+        message = f"FC4 no_fault_df actual is {actual} and expected is {expected}"
+        assert actual == expected, message
+
+
+class TestFaultOnInt(object):
+
+    def fault_df_on_output_int(self) -> pd.DataFrame:
+        data = []
+        for i in range(TEST_DATASET_ROWS):
+            if i % 2 == 0:
+                data.append(econ_plus_mech_clg_row_int())
+            else:
+                data.append(mech_clg_row())
+        return pd.DataFrame(data)
+
+    def test_fault_on_int(self):
+        fault_df_on_output_int = self.fault_df_on_output_int().set_index(
+            generate_timestamp()
+        )
+        with pytest.raises(
+            TypeError,
+            match=HelperUtils().float_int_check_err(TEST_SUPPLY_VFD_SPEED_COL),
+        ):
+            fc4.apply(fault_df_on_output_int)
+
+
+class TestFaultOnFloatGreaterThanOne(object):
+
+    def fault_df_on_output_greater_than_one(self) -> pd.DataFrame:
+        data = []
+        for i in range(TEST_DATASET_ROWS):
+            if i % 2 == 0:
+                data.append(econ_plus_mech_clg_row_float_greater_than_one())
+            else:
+                data.append(mech_clg_row())
+        return pd.DataFrame(data)
+
+    def test_fault_on_float_greater_than_one(self):
+        fault_df_on_output_greater_than_one = (
+            self.fault_df_on_output_greater_than_one().set_index(generate_timestamp())
+        )
+        with pytest.raises(
+            TypeError,
+            match=HelperUtils().float_max_check_err(TEST_SUPPLY_VFD_SPEED_COL),
+        ):
+            fc4.apply(fault_df_on_output_greater_than_one)
+
+
+class TestFaultOnMixedTypes(object):
+
+    def fault_df_on_mixed_types(self) -> pd.DataFrame:
+        data = []
+        for i in range(TEST_DATASET_ROWS):
+            if i % 2 == 0:
+                data.append(
+                    {
+                        TEST_MIX_AIR_DAMPER_COL: 0.6,
+                        TEST_HEATING_COIL_SIG_COL: 0.0,
+                        TEST_COOLING_COIL_SIG_COL: 0.6,
+                        TEST_SUPPLY_VFD_SPEED_COL: 1.1,
+                    }
+                )
+            else:
+                data.append(mech_clg_row())
+        return pd.DataFrame(data)
+
+    def test_fault_on_mixed_types(self):
+        fault_df_on_mixed_types = self.fault_df_on_mixed_types().set_index(
+            generate_timestamp()
+        )
+        with pytest.raises(
+            TypeError,
+            match=HelperUtils().float_max_check_err(TEST_SUPPLY_VFD_SPEED_COL),
+        ):
+            fc4.apply(fault_df_on_mixed_types)