open-fdd 0.1.0__py3-none-any.whl

open_fdd/tests/ahu/test_ahu_fc9.py

@@ -0,0 +1,136 @@
+import pandas as pd
+import pytest
+from open_fdd.air_handling_unit.faults.fault_condition_nine import FaultConditionNine
+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_fc9.py -rP -s
+
+OAT too high in economizer mode without mechanical clg
+"""
+
+# Constants
+TEST_DELTA_SUPPLY_FAN = 2.0
+TEST_OAT_DEGF_ERR_THRES = 5.0
+TEST_SUPPLY_DEGF_ERR_THRES = 2.0
+TEST_AHU_MIN_OA_DPR = 0.2
+TEST_SAT_SP_COL = "supply_air_sp_temp"
+TEST_OAT_COL = "out_air_temp"
+TEST_COOLING_COIL_SIG_COL = "cooling_sig_col"
+TEST_MIX_AIR_DAMPER_COL = "economizer_sig_col"
+ROLLING_WINDOW_SIZE = 5
+
+# Initialize FaultConditionNine with a dictionary
+fault_condition_params = {
+    "DELTA_T_SUPPLY_FAN": TEST_DELTA_SUPPLY_FAN,
+    "OUTDOOR_DEGF_ERR_THRES": TEST_OAT_DEGF_ERR_THRES,
+    "SUPPLY_DEGF_ERR_THRES": TEST_SUPPLY_DEGF_ERR_THRES,
+    "AHU_MIN_OA_DPR": TEST_AHU_MIN_OA_DPR,
+    "SAT_SETPOINT_COL": TEST_SAT_SP_COL,
+    "OAT_COL": TEST_OAT_COL,
+    "COOLING_SIG_COL": TEST_COOLING_COIL_SIG_COL,
+    "ECONOMIZER_SIG_COL": TEST_MIX_AIR_DAMPER_COL,
+    "TROUBLESHOOT_MODE": False,
+    "ROLLING_WINDOW_SIZE": ROLLING_WINDOW_SIZE,
+}
+
+fc9 = FaultConditionNine(fault_condition_params)
+
+
+class TestFaultConditionNine:
+
+    def no_fault_df_no_econ(self) -> pd.DataFrame:
+        data = {
+            TEST_SAT_SP_COL: [55, 55, 55, 55, 55, 55],
+            TEST_OAT_COL: [70.2, 70.9, 70.5, 70.3, 70.4, 70.5],
+            TEST_COOLING_COIL_SIG_COL: [0.80, 0.80, 0.80, 0.80, 0.80, 0.80],
+            TEST_MIX_AIR_DAMPER_COL: [0.80, 0.80, 0.80, 0.80, 0.80, 0.80],
+        }
+        return pd.DataFrame(data)
+
+    def fault_df_in_econ(self) -> pd.DataFrame:
+        data = {
+            TEST_SAT_SP_COL: [55, 55, 55, 55, 55, 55],
+            TEST_OAT_COL: [80.3, 80.2, 80.3, 80.1, 80.2, 80.1],
+            TEST_COOLING_COIL_SIG_COL: [0.0, 0.0, 0.0, 0.0, 0.0, 0.0],
+            TEST_MIX_AIR_DAMPER_COL: [0.80, 0.80, 0.80, 0.80, 0.80, 0.80],
+        }
+        return pd.DataFrame(data)
+
+    def test_no_fault_no_econ(self):
+        results = fc9.apply(self.no_fault_df_no_econ())
+        actual = results["fc9_flag"].sum()
+        expected = 0
+        message = (
+            f"FC9 no_fault_df_no_econ actual is {actual} and expected is {expected}"
+        )
+        assert actual == expected, message
+
+    def test_fault_in_econ(self):
+        results = fc9.apply(self.fault_df_in_econ())
+        actual = results["fc9_flag"].sum()
+        expected = 2
+        message = f"FC9 fault_df_in_econ actual is {actual} and expected is {expected}"
+        assert actual == expected, message
+
+
+class TestFaultOnInt:
+
+    def fault_df_on_output_int(self) -> pd.DataFrame:
+        data = {
+            TEST_SAT_SP_COL: [55, 55, 55, 55, 55, 55],
+            TEST_OAT_COL: [75, 75, 75, 75, 75, 75],
+            TEST_COOLING_COIL_SIG_COL: [11, 11, 11, 11, 11, 11],  # Incorrect type
+            TEST_MIX_AIR_DAMPER_COL: [0.80, 0.80, 0.80, 0.80, 0.80, 0.80],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault_on_int(self):
+        with pytest.raises(
+            TypeError,
+            match=HelperUtils().float_int_check_err(TEST_COOLING_COIL_SIG_COL),
+        ):
+            fc9.apply(self.fault_df_on_output_int())
+
+
+class TestFaultOnFloatGreaterThanOne:
+
+    def fault_df_on_output_greater_than_one(self) -> pd.DataFrame:
+        data = {
+            TEST_SAT_SP_COL: [55, 55, 55, 55, 55, 55],
+            TEST_OAT_COL: [75, 75, 75, 75, 75, 75],
+            TEST_COOLING_COIL_SIG_COL: [1.1, 1.2, 1.1, 1.3, 1.1, 1.2],  # Values > 1.0
+            TEST_MIX_AIR_DAMPER_COL: [0.80, 0.80, 0.80, 0.80, 0.80, 0.80],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault_on_float_greater_than_one(self):
+        with pytest.raises(
+            TypeError,
+            match=HelperUtils().float_max_check_err(TEST_COOLING_COIL_SIG_COL),
+        ):
+            fc9.apply(self.fault_df_on_output_greater_than_one())
+
+
+class TestFaultOnMixedTypes:
+
+    def fault_df_on_mixed_types(self) -> pd.DataFrame:
+        data = {
+            TEST_SAT_SP_COL: [55, 55, 55, 55, 55, 55],
+            TEST_OAT_COL: [75, 75, 75, 75, 75, 75],
+            TEST_COOLING_COIL_SIG_COL: [1.1, 0.55, 1.2, 1.3, 0.55, 1.1],  # Mixed types
+            TEST_MIX_AIR_DAMPER_COL: [0.80, 0.80, 0.80, 0.80, 0.80, 0.80],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault_on_mixed_types(self):
+        with pytest.raises(
+            TypeError,
+            match=HelperUtils().float_max_check_err(TEST_COOLING_COIL_SIG_COL),
+        ):
+            fc9.apply(self.fault_df_on_mixed_types())
+
+
+if __name__ == "__main__":
+    pytest.main()

open_fdd-0.1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 bbartling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

open_fdd-0.1.0.dist-info/METADATA

@@ -0,0 +1,65 @@
+Metadata-Version: 2.1
+Name: open_fdd
+Version: 0.1.0
+Summary: A package for fault detection and diagnosis in HVAC systems
+Home-page: https://github.com/bbartling/open-fdd
+Author: Ben Bartling
+Author-email: ben.bartling@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Requires-Dist: pytest
+
+# open-fdd
+
+![CI](https://github.com/bbartling/open-fdd/actions/workflows/ci.yml/badge.svg?branch=master)
+![MIT License](https://img.shields.io/badge/license-MIT-green.svg)
+![Black](https://img.shields.io/badge/code%20style-black-000000.svg)
+
+
+![Alt text](open_fdd/air_handling_unit/images/plot_for_repo.png)
+
+This is a Python-based Fault Detection and Diagnostics (FDD) tool for running fault equations inspired by ASHRAE and NIST standards for HVAC systems across historical datasets using the Pandas computing library. The tool evaluates various fault conditions and outputs fault flags as boolean columns within typical Pandas DataFrames. These fault flags indicate the presence (True) or absence (False) of specific issues identified by the fault equations. This approach integrates seamlessly into standard data science and computer science workflows, allowing for efficient analysis, visualization, and further processing of fault conditions within familiar data structures like DataFrames.
+
+
+## Getting Setup
+* Some features may be broken or not work as expected while the project is undergoing a significant makeover to become installable from PyPI. The aim is to streamline the reporting processes and make them much easier to use. I appreciate your patience during this transition.
+
+```bash
+git clone https://github.com/bbartling/open-fdd
+cd open-fdd
+```
+For now until this project is on PyPI as a Python library install `open-fdd` as a local python library.
+
+```bash
+pip install .
+```
+I am on Windows, using a version of Python 3.12, and run this project on SharePoint drives to make reports. Future examples could be Linux OS on a cloud machine for a more AFDD approach but in Windows OS world.
+
+```bash
+py -m pip install .
+```
+
+See the examples directory for Jupyter notebook tutorials as well as the `README` inside the `air_handling_unit` directory for parameter definitions. Coming soon more faults and reports for `vav_system` and `central_plants` and examples getting data from SQL databases.
+
+## Contribute
+This project is a community-driven initiative, focusing on the development of free and open-source tools. I believe that Fault Detection and Diagnostics (FDD) should be free and accessible to anyone who wants to try it out, embodying the spirit of open-source philosophy. Additionally, this project aims to serve as an educational resource, empowering individuals to learn about and implement FDD in their own systems. As someone wisely said, `"Knowledge should be shared, not hoarded,"` and this project strives to put that wisdom into practice.
+
+Got any ideas or questions? Submit a Git issue or start a Discussion...
+
+## License
+
+【MIT License】
+
+Copyright 2024 Ben Bartling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

open_fdd-0.1.0.dist-info/RECORD

@@ -0,0 +1,59 @@
+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=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+open_fdd/air_handling_unit/faults/fault_condition.py,sha256=UHMnwTaMJkxsUP2h9NXyVeDvIR2c7d96xkiigwf0CmU,1674
+open_fdd/air_handling_unit/faults/fault_condition_eight.py,sha256=G1hhP6YOZSOK5su_LmZsumbaM4VGHwFXrkGbT-Tgx2Q,2326
+open_fdd/air_handling_unit/faults/fault_condition_eleven.py,sha256=gs_sA4CxE8wM8gn7qxd7ToCtOcvJDSH5PAqdkRghw6c,2404
+open_fdd/air_handling_unit/faults/fault_condition_fifteen.py,sha256=y_S-NbaQQTyqnQkUYF7MNS2NON2jgVnnzv0Qo7dHGLE,3287
+open_fdd/air_handling_unit/faults/fault_condition_five.py,sha256=_G2WqzElrftj09P3w_qcSnAPQprtjfB1axaLusRK6g8,2605
+open_fdd/air_handling_unit/faults/fault_condition_four.py,sha256=sHwCA0_aP49_ILL8tzjrHJdumIRalxplAmgh16nah9Q,3519
+open_fdd/air_handling_unit/faults/fault_condition_fourteen.py,sha256=NHYp43RROOTErhoDfxW01Aw_txfZOBd9PsgZzcdlwQw,2954
+open_fdd/air_handling_unit/faults/fault_condition_nine.py,sha256=QQwuNCAIJM8_1KYIaCsU3sZSxozb6cWPQEsij50drJE,2475
+open_fdd/air_handling_unit/faults/fault_condition_one.py,sha256=Ae5CXagUwlQCOUebLb4dfoY-4mqGv_xGOCpRAXRTnrY,2113
+open_fdd/air_handling_unit/faults/fault_condition_seven.py,sha256=s2yLhnn5Es_ECqG3BIlZgx1Vgt9ro0Pq9sqjKl7yFwU,2004
+open_fdd/air_handling_unit/faults/fault_condition_six.py,sha256=HuQrdZNjXXPDU_8EtWVBPF4JcRGWG6nrqAE2RKRxTiY,4757
+open_fdd/air_handling_unit/faults/fault_condition_ten.py,sha256=SOPUbMwGHYHcNxTc-0OPlL-rRAuINd9fB01IVF8JLjQ,2243
+open_fdd/air_handling_unit/faults/fault_condition_thirteen.py,sha256=5OnzbTILlqX_Rs7Fcla-FfxSfwh7z8H2cFE8BW8LB-U,2419
+open_fdd/air_handling_unit/faults/fault_condition_three.py,sha256=YWG1QJqimzxogY7K97RIeKWwctPDEDPnuYaEk7BCmcI,2094
+open_fdd/air_handling_unit/faults/fault_condition_twelve.py,sha256=EJOYgLPEKRF3UOHz5veZs6Do2_1YTNr0d3nL2k1k_qE,2747
+open_fdd/air_handling_unit/faults/fault_condition_two.py,sha256=Tth5OnXgeEC_wgct9F3tIBmgZmxDxOIuJoOLblaPcVA,2140
+open_fdd/air_handling_unit/faults/helper_utils.py,sha256=huHmhxtoE2Js8GOYHZ6yRupTbj4y13B2V7HLjtqe7CI,7253
+open_fdd/air_handling_unit/faults/shared_utils.py,sha256=Kp8ZUBhtrh-jU2Q_bbXTpnbVVUAyacp41tDMknY50i4,2252
+open_fdd/air_handling_unit/reports/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+open_fdd/air_handling_unit/reports/report_fc1.py,sha256=ZlfTP4Pzv0l0hBHRWmTFMXKWPnuMNW38mHPPD8QW460,4565
+open_fdd/air_handling_unit/reports/report_fc10.py,sha256=Dgh0L4A-D-VYqTfVcMwhxdw67R-31c24ydtrpJ-gLyU,5179
+open_fdd/air_handling_unit/reports/report_fc11.py,sha256=fLb004y59i_2LegfGlpgEpEzQadqsCWrJPNLZ6obgqg,5197
+open_fdd/air_handling_unit/reports/report_fc12.py,sha256=MVjoHul32K0hJCP4WL9bLd6g55HMcKLdxzvPN94AlDA,5090
+open_fdd/air_handling_unit/reports/report_fc13.py,sha256=YjU6PBJl2ae_2WD2n-GoRGmwj6BtjQFClcCibHgcJmA,5026
+open_fdd/air_handling_unit/reports/report_fc14.py,sha256=j_o3X6BFYhW7IBwGZATQ7afgiXlKmUMGbGY7UuSwfD4,4832
+open_fdd/air_handling_unit/reports/report_fc15.py,sha256=Rg4NiheUsCmSxv42s7OFKRD7dweGZxtN83I5iDDzNoo,4831
+open_fdd/air_handling_unit/reports/report_fc2.py,sha256=ao_2ZeY10BLJ0GEDMMGAuD-8FbHBCGnIvQg9rF6om_U,4840
+open_fdd/air_handling_unit/reports/report_fc3.py,sha256=xyGjwYxJU2kveVJHLzAM3T_MLFlUZNQGBUyJ-YTjAsk,4843
+open_fdd/air_handling_unit/reports/report_fc4.py,sha256=0PpPwPnzeUZZybad04IslroBoCcIseDGq5it389wx9s,6052
+open_fdd/air_handling_unit/reports/report_fc5.py,sha256=welqsYh9TzIfpbdl3i9pvpaDWTsz_rnFbem6lXvz5K0,5699
+open_fdd/air_handling_unit/reports/report_fc6.py,sha256=R-2OONOZS1ZFLkUBv0syrZ7XjrR0TSwI1Wu70opTVeM,6042
+open_fdd/air_handling_unit/reports/report_fc7.py,sha256=_hlAvJvbDtLOOPlcCcPaCH8Hu2U5zL1l__xrbL80C20,5256
+open_fdd/air_handling_unit/reports/report_fc8.py,sha256=3jZPq2piethtqly1faSc8hk0aFCbQe2Y0RMNv3DFzpk,5057
+open_fdd/air_handling_unit/reports/report_fc9.py,sha256=hJbYMYnwptVSEI2NVdnV3Ads-h_9Hl4oFD1HDDLZWHQ,4909
+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=IJTLAF87xHSyCgU0Ow-gzP8rP8z7TQb46nQHdirW-vs,4899
+open_fdd/tests/ahu/test_ahu_fc10.py,sha256=eJ3msPdgkXwYRJOb6mGDaIZBDJfXhyVFAyr27DVwagY,4597
+open_fdd/tests/ahu/test_ahu_fc11.py,sha256=uMLAQ2o-m8czAh7q6xzKlrmGd9m6SGjIfvd4hswOD9E,4746
+open_fdd/tests/ahu/test_ahu_fc12.py,sha256=KedYWmVSwb8b-0TZYdC16ysELGHOIsI_xd2va-SqBgg,5871
+open_fdd/tests/ahu/test_ahu_fc13.py,sha256=qz_dol4W6M3cIvunkHyFDfqEkB8TA9r9UnoycS2x37I,5750
+open_fdd/tests/ahu/test_ahu_fc14.py,sha256=SlnQF37K73tgfUtp1bQl0nH46YV5aByzonUNXJ50CGE,8077
+open_fdd/tests/ahu/test_ahu_fc15.py,sha256=jQGgZPbh83q3_oJJVYhobC7KdD-2InbA1zdbsQBlhuc,7685
+open_fdd/tests/ahu/test_ahu_fc2.py,sha256=3njwLWjzIT6B6RCMgEGqdPvP3kykYwzQTZ9IOgx_BSE,4756
+open_fdd/tests/ahu/test_ahu_fc3.py,sha256=iFHLdTzyMvDw7lFwl5J4I7omXXwrDh7kIyoXTI1YxmM,4680
+open_fdd/tests/ahu/test_ahu_fc4.py,sha256=gWquIQsBiF65RGUBLe741oj1Yqs-JDM4K0kmkPP7mOE,6334
+open_fdd/tests/ahu/test_ahu_fc5.py,sha256=mEbhX5IlDkMwXPv3jPMlE_v3QJH47qsZIL99_KzV7_U,6559
+open_fdd/tests/ahu/test_ahu_fc6.py,sha256=M7eHdQexcSDN0CGjnR3bcwk_wbjDxqhJwqg_VjsoGB0,10369
+open_fdd/tests/ahu/test_ahu_fc7.py,sha256=ughSBHwrergnFsI5ayVaBoWRUMEetFcYQ59CNBNIS1k,2491
+open_fdd/tests/ahu/test_ahu_fc8.py,sha256=KKnDyclhzxppC4bk2Kj9cguqg53sZ7I7CSqqWexpWdE,4685
+open_fdd/tests/ahu/test_ahu_fc9.py,sha256=YbO1jZSZD6eAXjQkidjp3TEVCcaL7ADhUsTyKy_jmL0,4817
+open_fdd-0.1.0.dist-info/LICENSE,sha256=eghao_GGx_0gB2Sll3x2vV29knONEzUQKrkaXpX1F7w,1087
+open_fdd-0.1.0.dist-info/METADATA,sha256=u6QNbWqgZkQ1T1QvgBWZApKkHbg1r2_Exr2noKQ0DO0,4326
+open_fdd-0.1.0.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+open_fdd-0.1.0.dist-info/top_level.txt,sha256=Q7sB6UB2d8Ch1v_xIsTiNegmgcCXPkwkrxK3ug6VEOs,9
+open_fdd-0.1.0.dist-info/RECORD,,

open_fdd-0.1.0.dist-info/WHEEL

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

open_fdd-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+open_fdd