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

open_fdd/tests/ahu/test_ahu_fc7.py

@@ -1,5 +1,6 @@
 import pandas as pd
 import pytest
+
 from open_fdd.air_handling_unit.faults import FaultConditionSeven
 from open_fdd.air_handling_unit.faults.helper_utils import HelperUtils
 

open_fdd/tests/ahu/test_ahu_fc8.py

@@ -1,5 +1,6 @@
 import pandas as pd
 import pytest
+
 from open_fdd.air_handling_unit.faults import FaultConditionEight
 from open_fdd.air_handling_unit.faults.helper_utils import HelperUtils
 

open_fdd/tests/ahu/test_ahu_fc9.py

@@ -1,5 +1,6 @@
 import pandas as pd
 import pytest
+
 from open_fdd.air_handling_unit.faults import FaultConditionNine
 from open_fdd.air_handling_unit.faults.helper_utils import HelperUtils
 

open_fdd/tests/chiller/test_chiller_fc1.py

@@ -0,0 +1,122 @@
+import pandas as pd
+import pytest
+
+from open_fdd.chiller_plant.faults import FaultConditionOne
+from open_fdd.core.exceptions import MissingColumnError
+
+# Constants for test cases
+TEST_PUMP_ERR_THRESHOLD = 0.05
+TEST_PUMP_SPEED_MAX = 0.9
+TEST_DIFF_PRESSURE_ERR_THRESHOLD = 0.1
+TEST_DIFF_PRESSURE_COL = "diff_pressure"
+TEST_DIFF_PRESSURE_SETPOINT_COL = "diff_pressure_setpoint"
+TEST_PUMP_SPEED_COL = "pump_speed"
+
+ROLLING_WINDOW_SIZE = 5
+
+# Initialize FaultConditionPump with a dictionary
+fault_condition_params = {
+    "PUMP_SPEED_PERCENT_ERR_THRES": TEST_PUMP_ERR_THRESHOLD,
+    "PUMP_SPEED_PERCENT_MAX": TEST_PUMP_SPEED_MAX,
+    "DIFF_PRESSURE_PSI_ERR_THRES": TEST_DIFF_PRESSURE_ERR_THRESHOLD,
+    "DIFF_PRESSURE_COL": TEST_DIFF_PRESSURE_COL,
+    "PUMP_SPEED_COL": TEST_PUMP_SPEED_COL,
+    "DIFF_PRESSURE_SETPOINT_COL": TEST_DIFF_PRESSURE_SETPOINT_COL,
+    "TROUBLESHOOT_MODE": False,
+    "ROLLING_WINDOW_SIZE": ROLLING_WINDOW_SIZE,
+}
+
+fc_pump = FaultConditionOne(fault_condition_params)
+
+
+class TestMissingColumn:
+    def missing_col_df(self) -> pd.DataFrame:
+        data = {
+            TEST_DIFF_PRESSURE_COL: [8.0, 8.1, 8.2, 8.1, 8.0, 8.0],
+            # Missing TEST_PUMP_SPEED_COL
+            TEST_DIFF_PRESSURE_SETPOINT_COL: [10.0, 10.0, 10.0, 10.0, 10.0, 10.0],
+        }
+        return pd.DataFrame(data)
+
+    def test_missing_column(self):
+        with pytest.raises(MissingColumnError):
+            fc_pump.apply(self.missing_col_df())
+
+
+class TestNoFault:
+    def no_fault_df(self) -> pd.DataFrame:
+        data = {
+            TEST_DIFF_PRESSURE_COL: [9.8, 9.9, 9.8, 9.8, 9.9, 9.8],
+            TEST_DIFF_PRESSURE_SETPOINT_COL: [10.0, 10.0, 10.0, 10.0, 10.0, 10.0],
+            TEST_PUMP_SPEED_COL: [0.7, 0.7, 0.7, 0.7, 0.7, 0.7],
+        }
+        return pd.DataFrame(data)
+
+    def test_no_fault(self):
+        results = fc_pump.apply(self.no_fault_df())
+        actual = results["fc_pump_flag"].sum()
+        expected = 0
+        message = f"FC Pump no_fault_df actual is {actual} and expected is {expected}"
+        assert actual == expected, message
+
+
+class TestFault:
+    def fault_df(self) -> pd.DataFrame:
+        data = {
+            TEST_DIFF_PRESSURE_COL: [
+                8.0,
+                8.1,
+                8.0,
+                7.9,
+                8.0,
+                8.0,
+                9.9,
+                9.9,
+                8.0,
+                8.1,
+                8.0,
+                7.9,
+                8.0,
+                8.1,
+            ],
+            TEST_DIFF_PRESSURE_SETPOINT_COL: [
+                10.0,
+                10.0,
+                10.0,
+                10.0,
+                10.0,
+                10.0,
+                10.0,
+                10.0,
+                10.0,
+                10.0,
+                10.0,
+                10.0,
+                10.0,
+                10.0,
+            ],
+            TEST_PUMP_SPEED_COL: [
+                0.9,
+                0.9,
+                0.9,
+                0.9,
+                0.9,
+                0.9,
+                0.5,
+                0.55,
+                0.9,
+                0.9,
+                0.9,
+                0.9,
+                0.9,
+                0.9,
+            ],
+        }
+        return pd.DataFrame(data)
+
+    def test_fault(self):
+        results = fc_pump.apply(self.fault_df())
+        actual = results["fc_pump_flag"].sum()
+        expected = 4  # Adjusted based on the rolling window and fault conditions
+        message = f"FC Pump fault_df actual is {actual} and expected is {expected}"
+        assert actual == expected, message

open_fdd/tests/chiller/test_chiller_fc2.py

@@ -0,0 +1,95 @@
+import pandas as pd
+import pytest
+
+from open_fdd.chiller_plant.faults import FaultConditionTwo
+from open_fdd.core.exceptions import MissingColumnError
+
+# Constants for test cases
+TEST_FLOW_ERR_THRESHOLD = 10.0  # Error threshold for flow in GPM
+TEST_PUMP_SPEED_MAX = 0.9  # Maximum pump speed percentage
+TEST_PUMP_SPEED_ERR_THRESHOLD = 0.05  # Error threshold for pump speed percentage
+TEST_FLOW_COL = "flow_gpm"
+TEST_PUMP_SPEED_COL = "pump_speed"
+
+ROLLING_WINDOW_SIZE = 5
+
+# Initialize FaultConditionTwo with a dictionary
+fault_condition_params = {
+    "FLOW_ERROR_THRESHOLD": TEST_FLOW_ERR_THRESHOLD,
+    "PUMP_SPEED_PERCENT_MAX": TEST_PUMP_SPEED_MAX,
+    "PUMP_SPEED_PERCENT_ERR_THRES": TEST_PUMP_SPEED_ERR_THRESHOLD,
+    "FLOW_COL": TEST_FLOW_COL,
+    "PUMP_SPEED_COL": TEST_PUMP_SPEED_COL,
+    "ROLLING_WINDOW_SIZE": ROLLING_WINDOW_SIZE,
+}
+
+fc_flow = FaultConditionTwo(fault_condition_params)
+
+
+class TestMissingColumn:
+    def missing_col_df(self) -> pd.DataFrame:
+        data = {
+            TEST_FLOW_COL: [5.0, 8.0, 9.0, 15.0, 7.0],
+            # Missing pump speed column
+        }
+        return pd.DataFrame(data)
+
+    def test_missing_column(self):
+        with pytest.raises(MissingColumnError):
+            fc_flow.apply(self.missing_col_df())
+
+
+class TestNoFault:
+    def no_fault_df(self) -> pd.DataFrame:
+        data = {
+            TEST_FLOW_COL: [11.0, 11.0, 12.0, 12.0, 12.5],  # Flow above threshold
+            TEST_PUMP_SPEED_COL: [0.5, 0.45, 0.55, 0.45, 0.55],  # Above threshold
+        }
+        return pd.DataFrame(data)
+
+    def test_no_fault(self):
+        results = fc_flow.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}"
+        assert actual == expected, message
+
+
+class TestFault:
+    def fault_df(self) -> pd.DataFrame:
+        data = {
+            TEST_FLOW_COL: [
+                6.0,
+                6.1,
+                6.2,
+                6.3,
+                6.4,
+                12.0,
+                6.0,
+                6.1,
+                6.2,
+                6.3,
+                6.4,
+            ],  # 6th row interrupts the fault condition
+            TEST_PUMP_SPEED_COL: [
+                0.97,
+                0.98,
+                0.98,
+                0.97,
+                0.99,
+                0.95,
+                0.97,
+                0.98,
+                0.98,
+                0.97,
+                0.99,
+            ],  # All above threshold
+        }
+        return pd.DataFrame(data)
+
+    def test_fault(self):
+        results = fc_flow.apply(self.fault_df())
+        actual = results["fc2_flag"].sum()  # Fault flags counted
+        expected = 2  # 5 faults, interruption, then 5 more faults = 2 total flags
+        message = f"FC2 fault_df actual is {actual} and expected is {expected}"
+        assert actual == expected, message

open_fdd-0.1.9.dist-info/METADATA

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: open_fdd
+Version: 0.1.9
+Summary: A package for fault detection and diagnosis in HVAC systems
+Home-page: https://bbartling.github.io/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
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# 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)
+![PyPI](https://img.shields.io/pypi/v/open-fdd?color=blue&label=pypi%20version)
+
+![Fault Detection Visualization](https://raw.githubusercontent.com/bbartling/open-fdd/master/open_fdd/air_handling_unit/images/plot_for_repo.png)
+
+## 🔥 What is open-fdd?
+**open-fdd** is an **open-source Fault Detection and Diagnostics (FDD) tool** designed for analysts and engineers using local toolsets like Jupyter notebooks. It is not necessarily an IoT tool for **Grafana**, which an MSI (Master Systems Integrator) might use, though it could be adapted for that purpose. Instead, it is tailored for **individual engineers analyzing historical HVAC system data** using the **Pandas computing library**. While it could potentially be integrated with a database, doing so may require additional effort. It leverages **ASHRAE** and **NIST**-inspired fault equations. Built on Python and **Pandas**, this library enables efficient detection of operational issues in HVAC systems with:
+
+This version improves clarity and flow while keeping it professional and readable. 🚀 Let me know if you want any more refinements!
+
+✅ **Pre-built fault equations** for detecting HVAC anomalies
+✅ **Seamless Pandas integration** for time-series analysis
+✅ **Extensible architecture** for custom fault conditions
+✅ **Open-source & community-driven** development
+
+
+📖 **See Online Documentation:**  
+[📚 Open-FDD Docs](https://bbartling.github.io/open-fdd/)
+
+---
+
+## 🚀 Getting Started
+### Installation
+Install `open-fdd` from PyPI with:
+```bash
+pip install open-fdd
+```
+
+### Quick Example
+```python
+import pandas as pd
+from open_fdd.air_handling_unit.fault_condition_one import FaultConditionOne
+
+# Sample data
+data = {
+    "timestamp": pd.date_range(start="2023-01-01", periods=10, freq="15T"),
+    "supply_air_temp": [54, 55, 56, 57, 58, 59, 60, 61, 62, 63],
+    "return_air_temp": [70, 70, 70, 70, 70, 70, 70, 70, 70, 70],
+}
+df = pd.DataFrame(data)
+
+# Run fault detection
+fault_checker = FaultConditionOne(df)
+df_faults = fault_checker.process()
+print(df_faults)
+```
+
+---
+
+## 📌 Project Goals
+`open-fdd` aims to provide a full-featured **Fault Detection & Diagnostics (FDD) platform** with:
+
+### ✅ Completed Features
+- [x] Air handling unit (AHU) fault conditions & reports (aligned with ASHRAE/NIST)
+- [x] PyPI distribution for easy installation
+
+### 🔄 In Progress
+- [ ] Jupyter notebook tutorials showcasing AHU FDD examples + BRICK metadata integration
+- [ ] Expansion to **central plant** fault conditions (chillers, boilers, pumps)
+- [ ] Jupyter notebook tutorials showcasing AHU FDD examples + BRICK metadata integration
+
+### ⏳ Upcoming
+- [ ] **Energy Efficiency** fault detection & reporting
+- [ ] **Metering** fault analytics & data modeling
+- [ ] **SQL Integration** for storing results & visualizing in Grafana
+- [ ] Dedicated documentation site (`github.io` or ReadTheDocs)
+
+---
+
+## 🤝 How to Contribute
+We welcome contributions from the community! To get started:
+
+1. **Clone the repository:**
+```bash
+git clone https://github.com/bbartling/open-fdd.git && cd open-fdd
+```
+2. **Install dependencies:**
+```bash
+py -3.12 -m pip install -r requirements.txt
+```
+3. **Run tests:**
+```bash
+py -3.12 -m pytest
+```
+4. **Format with Black:**
+```bash
+py -3.12 -m black .
+```
+5. **Submit a Pull Request (PR)**
+
+---
+
+## 📜 License
+`open-fdd` is released under the **MIT License**, ensuring it remains free and accessible for all.
+
+```
+
+【MIT License】
+
+Copyright 2025 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.9.dist-info/RECORD

@@ -0,0 +1,52 @@
+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=y4XUyFDNZthjhN37AWcKA8gowmi2Fm6zThI-IxYKFEU,1577
+open_fdd/air_handling_unit/faults/fault_condition_eight.py,sha256=XNqWA0q-ogY9QwMHzLpDYxOobeDD13Ij7-s5vDh5PSU,4525
+open_fdd/air_handling_unit/faults/fault_condition_eleven.py,sha256=cKhm6lKpRouWpof_ibVC9zywW9Tpq7ncJEeZcHEsb5U,3607
+open_fdd/air_handling_unit/faults/fault_condition_fifteen.py,sha256=UtqZYUy57VEW6trUVER4r9sEyxnbIq8Ttufj0aUKWIY,6952
+open_fdd/air_handling_unit/faults/fault_condition_five.py,sha256=sQFBpvvvNSQasCKJ9epqGSXk16btjjzRJitwEC8Os_Y,4245
+open_fdd/air_handling_unit/faults/fault_condition_four.py,sha256=IRJH17I1_QkOEYwUmSsI5HtYp7_YXiaDxbcGud-5WJo,4547
+open_fdd/air_handling_unit/faults/fault_condition_fourteen.py,sha256=FaSNp2dBHPD6T6um2RrqFj8Di7oK3surzFPyjzfQ6f8,6320
+open_fdd/air_handling_unit/faults/fault_condition_nine.py,sha256=n0uB9JySxF6ga7QbiUnKiYbR2j7bFDLykM6LVgUTL_s,4708
+open_fdd/air_handling_unit/faults/fault_condition_one.py,sha256=5SAu1MXzX3cVW9zyFH8wgRxXMnXBo_y9exuKfYkIuz8,3981
+open_fdd/air_handling_unit/faults/fault_condition_seven.py,sha256=6gWEZhal0bWz0VppOzUOpl55_25qVEEkj75lWT9ImBM,3518
+open_fdd/air_handling_unit/faults/fault_condition_six.py,sha256=-nIFl4BtV_AMfx4FI25cnxo5dukE6YXvlowVs7oxJcQ,7971
+open_fdd/air_handling_unit/faults/fault_condition_sixteen.py,sha256=DutgmWyz3AMlF39G7ivIpL3tFV75QkvRs2FndW5n464,7231
+open_fdd/air_handling_unit/faults/fault_condition_ten.py,sha256=TP9-bsiGUGyeNYYS1MQE3Lw7gDCssG2Um2-osKZNcAE,3999
+open_fdd/air_handling_unit/faults/fault_condition_thirteen.py,sha256=CNteakiAxaDMFQynys9MK2pEokIlUJQhMI4StwBA4Gs,4841
+open_fdd/air_handling_unit/faults/fault_condition_three.py,sha256=BiSQSlMqr8AI9IL06jdQsKyyjxDgTm7WmpPc1KtEDRw,3719
+open_fdd/air_handling_unit/faults/fault_condition_twelve.py,sha256=snE1toPvqH9TDbT0Y54m8Dnji19a7s8erzFYTw5S40I,5684
+open_fdd/air_handling_unit/faults/fault_condition_two.py,sha256=nPtrhex23TMI88AbGtzbUOq-wrY-qm9u1O4X8sGOXLo,3715
+open_fdd/air_handling_unit/faults/helper_utils.py,sha256=4w_t9BvfbvNn-fip0zH3r3350W9oQIvDq_LdtY7W9uI,12732
+open_fdd/air_handling_unit/reports/__init__.py,sha256=Stg1NcWYbNoV8Osk9-vUAiAfw5dJFUEWm2RuBTXeIWY,40745
+open_fdd/air_handling_unit/reports/fault_report.py,sha256=lQ1RvhH_b--mT9VzWK6HESEsOmhlPF0sfVn6W7Ue_-8,1444
+open_fdd/chiller_plant/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+open_fdd/chiller_plant/faults/__init__.py,sha256=b-nH3L0ijb2SY7TqRT_DCVEGn3TmF-WvaxemHjbAGsg,232
+open_fdd/chiller_plant/faults/fault_condition_one.py,sha256=jwSmO4lKpXw7wnN6rEbdcICfv82ujqjErKneqMmGWCw,3784
+open_fdd/chiller_plant/faults/fault_condition_two.py,sha256=IrsxFyPubOXJwPFFUQMEITcurAl7pLKakmP8lRBrRhM,3288
+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=_zNavzKHam7kqxKT3tn0IxK0ofzP2RjPDWtgr_eU3-w,5414
+open_fdd/tests/ahu/test_ahu_fc10.py,sha256=f1V2I5Ul9xyhhmQstdiFEO1AlIDsa_Y4HENRMNanyHM,4579
+open_fdd/tests/ahu/test_ahu_fc11.py,sha256=TIhvGVUJGGjQSW7PRdffRyL2sL9bJhLkDMCFt3UVHEc,4143
+open_fdd/tests/ahu/test_ahu_fc12.py,sha256=Wn1rxqSxy6aNBTfUaHi9Q7mr3gLLEirLKw6XVREbwOc,7197
+open_fdd/tests/ahu/test_ahu_fc13.py,sha256=U-BG6trhK-xmqoU9DzvCCiUd1jqgKAffaO-oq7xVTUw,6055
+open_fdd/tests/ahu/test_ahu_fc14.py,sha256=GpH2ftTlh9YHktFuRaMmWRNjktGd8h2fVogbJjdumSg,8400
+open_fdd/tests/ahu/test_ahu_fc15.py,sha256=eL3nYiBD3gp3SXsiKAsAUGOT9GVnNm_gJ0pFdz6Faws,8149
+open_fdd/tests/ahu/test_ahu_fc16.py,sha256=z873OSK0TyKbq2XkhKw4uAdBZ5d4BaFd5qD0iVppMTY,9451
+open_fdd/tests/ahu/test_ahu_fc2.py,sha256=hpenWlBmfQSaGCh06iUbg4otmbG0w4COZ4FtVuohgP0,4738
+open_fdd/tests/ahu/test_ahu_fc3.py,sha256=rdW7Omd6mDaUfDauxfXiWa5k0suTtDp8hcruQulsHPk,4660
+open_fdd/tests/ahu/test_ahu_fc4.py,sha256=7CBkJMStdnIGWoeHnR1uSiRZ2bOEn2QuYwK_xxcM75I,6308
+open_fdd/tests/ahu/test_ahu_fc5.py,sha256=mQLDP_1QqnkFx5Dy08iU9h_zMhsF5JEFJX0-JL1MDQc,6540
+open_fdd/tests/ahu/test_ahu_fc6.py,sha256=JtcLEKWUD9nnYNbVtpf-qzayIdL9e4QVwRmtIsY8GBQ,10353
+open_fdd/tests/ahu/test_ahu_fc7.py,sha256=iGyBtHhOuL-1ldNTzXbXESL39YHPF_DW3XZ65IEk1q4,2471
+open_fdd/tests/ahu/test_ahu_fc8.py,sha256=f_DI_7gne81uVzZO0URG5J1sOE1Np2AidYKhdWmRvSE,4665
+open_fdd/tests/ahu/test_ahu_fc9.py,sha256=8ELH0XUcsQqqNjW94C0r4Q6EYldYgNqjWl8QyLhev74,4798
+open_fdd/tests/chiller/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+open_fdd/tests/chiller/test_chiller_fc1.py,sha256=MTggFcfLUCvMQ_vc_sVAWv-VRqscg1mAcWDHmyBM_QM,3705
+open_fdd/tests/chiller/test_chiller_fc2.py,sha256=rWVRrFSZ_wHh-KsDdNeNgs5MTdB-di_UayfhgZ6HcYc,3019
+open_fdd-0.1.9.dist-info/licenses/LICENSE,sha256=eghao_GGx_0gB2Sll3x2vV29knONEzUQKrkaXpX1F7w,1087
+open_fdd-0.1.9.dist-info/METADATA,sha256=di_1orLR5AEe1T5HDyqpQ7FHYOs_iS62Ne-07aKounU,5636
+open_fdd-0.1.9.dist-info/WHEEL,sha256=lTU6B6eIfYoiQJTZNc-fyaR6BpL6ehTzU3xGYxn2n8k,91
+open_fdd-0.1.9.dist-info/top_level.txt,sha256=Q7sB6UB2d8Ch1v_xIsTiNegmgcCXPkwkrxK3ug6VEOs,9
+open_fdd-0.1.9.dist-info/RECORD,,

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

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

open_fdd/air_handling_unit/faults/fault_condition.py

@@ -1,69 +0,0 @@
-import pandas as pd
-import pandas.api.types as pdtypes
-from open_fdd.air_handling_unit.faults.helper_utils import HelperUtils
-import sys
-
-"""see __init__.py for fault classes"""
-
-
-class MissingColumnError(Exception):
-    """Custom exception raised when a required column is missing or None."""
-
-    def __init__(self, message):
-        self.message = message
-        super().__init__(self.message)
-
-
-class InvalidParameterError(Exception):
-    """Custom exception raised when a parameter is not valid (e.g., not a float)."""
-
-    def __init__(self, message):
-        self.message = message
-        super().__init__(self.message)
-
-
-class FaultCondition:
-    """Parent class for Fault Conditions. Methods are inherited to all children."""
-
-    def __init__(self):
-        self.required_columns = []
-
-    def set_attributes(self, dict_):
-        """Passes dictionary into initialization of class instance"""
-        for attribute in self.__dict__.keys():
-            upper = attribute.upper()
-            if upper in dict_:
-                value = dict_[upper]
-                self.__setattr__(attribute, value)
-
-    def check_required_columns(self, df: pd.DataFrame):
-        """Checks if required columns are present in the DataFrame."""
-        missing_columns = [
-            col for col in self.required_columns if col is None or col not in df.columns
-        ]
-
-        if missing_columns:
-            raise MissingColumnError(f"Missing required columns: {missing_columns}")
-
-    def troubleshoot_cols(self, df):
-        """Print troubleshoot columns mapping."""
-        print("Troubleshoot mode enabled - not removing helper columns")
-        for col in df.columns:
-            print(
-                "df column: ",
-                col,
-                "- max: ",
-                df[col].max(),
-                "- col type: ",
-                df[col].dtypes,
-            )
-            sys.stdout.flush()
-
-    def check_analog_pct(self, df, columns):
-        """Check analog outputs [data with units of %] are floats only."""
-        helper = HelperUtils()
-        for col in columns:
-            if not pdtypes.is_float_dtype(df[col]):
-                df = helper.convert_to_float(df, col)
-            if df[col].max() > 1.0:
-                raise TypeError(helper.float_max_check_err(col))

open_fdd/air_handling_unit/faults/shared_utils.py

@@ -1,90 +0,0 @@
-import pandas as pd
-import pandas.api.types as pdtypes
-import sys
-
-
-class SharedUtils:
-    @staticmethod
-    def float_int_check_err(col):
-        err_str = " column failed with a check that the data is a float"
-        return str(col) + err_str
-
-    @staticmethod
-    def float_max_check_err(col):
-        err_str = (
-            " column failed with a check that the data is a float between 0.0 and 1.0"
-        )
-        return str(col) + err_str
-
-    @staticmethod
-    def isfloat(num):
-        try:
-            float(num)
-            return True
-        except:
-            return False
-
-    @staticmethod
-    def isLessThanOnePointOne(num):
-        try:
-            if num <= 1.0:
-                return True
-        except:
-            return False
-
-    @staticmethod
-    def convert_to_float(df, col):
-        if not pdtypes.is_float_dtype(df[col]):
-            try:
-                df[col] = df[col].astype(float)
-            except ValueError:
-                raise TypeError(SharedUtils.float_int_check_err(col))
-        return df
-
-    @staticmethod
-    def apply_rolling_average_if_needed(df, freq="1min", rolling_window="5min"):
-        """Apply rolling average if time difference between consecutive
-        timestamps is not greater than the specified frequency.
-        """
-
-        print(
-            "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:]
-
-        # Calculate median time difference to avoid being affected by outliers
-        median_diff = time_diff.median()
-
-        print(
-            f"Warning: Median time difference between consecutive timestamps is {median_diff}."
-        )
-        sys.stdout.flush()
-
-        if median_diff > pd.Timedelta(freq):
-            print(f"Warning: Skipping any rolling averaging...")
-            sys.stdout.flush()
-
-        else:
-            df = df.rolling(rolling_window).mean()
-            print(
-                f"Warning: A {rolling_window} rolling average has been applied to the data."
-            )
-            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