open-fdd 0.1.7__tar.gz → 0.1.9__tar.gz

open_fdd-0.1.9/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,110 @@
+# 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/open_fdd/air_handling_unit/faults/__init__.py

@@ -0,0 +1,30 @@
+"""Base module for all fault conditions in the air handling unit (AHU) module."""
+
+from open_fdd.air_handling_unit.faults.fault_condition_eight import FaultConditionEight
+from open_fdd.air_handling_unit.faults.fault_condition_eleven import (
+    FaultConditionEleven,
+)
+from open_fdd.air_handling_unit.faults.fault_condition_fifteen import (
+    FaultConditionFifteen,
+)
+from open_fdd.air_handling_unit.faults.fault_condition_five import FaultConditionFive
+from open_fdd.air_handling_unit.faults.fault_condition_four import FaultConditionFour
+from open_fdd.air_handling_unit.faults.fault_condition_fourteen import (
+    FaultConditionFourteen,
+)
+from open_fdd.air_handling_unit.faults.fault_condition_nine import FaultConditionNine
+from open_fdd.air_handling_unit.faults.fault_condition_one import FaultConditionOne
+from open_fdd.air_handling_unit.faults.fault_condition_seven import FaultConditionSeven
+from open_fdd.air_handling_unit.faults.fault_condition_six import FaultConditionSix
+from open_fdd.air_handling_unit.faults.fault_condition_sixteen import (
+    FaultConditionSixteen,
+)
+from open_fdd.air_handling_unit.faults.fault_condition_ten import FaultConditionTen
+from open_fdd.air_handling_unit.faults.fault_condition_thirteen import (
+    FaultConditionThirteen,
+)
+from open_fdd.air_handling_unit.faults.fault_condition_three import FaultConditionThree
+from open_fdd.air_handling_unit.faults.fault_condition_twelve import (
+    FaultConditionTwelve,
+)
+from open_fdd.air_handling_unit.faults.fault_condition_two import FaultConditionTwo

open_fdd-0.1.9/open_fdd/air_handling_unit/faults/fault_condition_eight.py

@@ -0,0 +1,135 @@
+import numpy as np
+import pandas as pd
+
+from open_fdd.core.base_fault import BaseFaultCondition
+from open_fdd.core.components import FaultInputColumn, InstanceAttribute
+from open_fdd.core.exceptions import InvalidParameterError, MissingColumnError
+from open_fdd.core.mixins import FaultConditionMixin
+
+INPUT_COLS = [
+    FaultInputColumn(
+        name="mat_col",
+        constant_form="MAT_COL",
+        description="Mixed air temperature",
+        unit="°F",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="sat_col",
+        constant_form="SAT_COL",
+        description="Supply air temperature",
+        unit="°F",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="economizer_sig_col",
+        constant_form="ECONOMIZER_SIG_COL",
+        description="Economizer signal",
+        unit="%",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="cooling_sig_col",
+        constant_form="COOLING_SIG_COL",
+        description="Cooling signal",
+        unit="%",
+        required=True,
+        type=float,
+    ),
+]
+
+FAULT_PARAMS = [
+    InstanceAttribute(
+        name="delta_t_supply_fan",
+        constant_form="DELTA_T_SUPPLY_FAN",
+        description="Temperature rise across supply fan",
+        unit="°F",
+        type=float,
+    ),
+    InstanceAttribute(
+        name="mix_degf_err_thres",
+        constant_form="MIX_DEGF_ERR_THRES",
+        description="Mixed air temperature error threshold",
+        unit="°F",
+        type=float,
+    ),
+    InstanceAttribute(
+        name="supply_degf_err_thres",
+        constant_form="SUPPLY_DEGF_ERR_THRES",
+        description="Supply air temperature error threshold",
+        unit="°F",
+        type=float,
+    ),
+    InstanceAttribute(
+        name="ahu_min_oa_dpr",
+        constant_form="AHU_MIN_OA_DPR",
+        description="Minimum outdoor air damper position",
+        unit="fraction",
+        type=float,
+    ),
+]
+
+
+class FaultConditionEight(BaseFaultCondition, FaultConditionMixin):
+    """Class provides the definitions for Fault Condition 8.
+    Supply air temperature and mix air temperature should
+    be approx equal in economizer mode.
+
+    py -3.12 -m pytest open_fdd/tests/ahu/test_ahu_fc8.py -rP -s
+    """
+
+    input_columns = INPUT_COLS
+    fault_params = FAULT_PARAMS
+    equation_string = (
+        "fc8_flag = 1 if |SAT - MAT - ΔT_fan| > √(εSAT² + εMAT²) "
+        "in economizer mode for N consecutive values else 0 \n"
+    )
+    description_string = (
+        "Fault Condition 8: Supply air temperature and mixed air temperature should "
+        "be approximately equal in economizer mode \n"
+    )
+    error_string = "One or more required columns are missing or None \n"
+
+    @FaultConditionMixin._handle_errors
+    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
+        """Apply the fault condition to the DataFrame."""
+        # Apply common checks
+        self._apply_common_checks(df)
+
+        # Get column values using accessor methods
+        mat_col = self.get_input_column("mat_col")
+        sat_col = self.get_input_column("sat_col")
+        economizer_sig_col = self.get_input_column("economizer_sig_col")
+        cooling_sig_col = self.get_input_column("cooling_sig_col")
+
+        # Get parameter values using accessor methods
+        delta_t_supply_fan = self.get_param("delta_t_supply_fan")
+        mix_degf_err_thres = self.get_param("mix_degf_err_thres")
+        supply_degf_err_thres = self.get_param("supply_degf_err_thres")
+        ahu_min_oa_dpr = self.get_param("ahu_min_oa_dpr")
+
+        # Check analog outputs [data with units of %] are floats only
+        columns_to_check = [
+            economizer_sig_col,
+            cooling_sig_col,
+        ]
+        self._apply_analog_checks(df, columns_to_check, check_greater_than_one=True)
+
+        # Perform checks
+        sat_fan_mat = abs(df[sat_col] - delta_t_supply_fan - df[mat_col])
+        sat_mat_sqrted = np.sqrt(supply_degf_err_thres**2 + mix_degf_err_thres**2)
+
+        combined_check = (
+            (sat_fan_mat > sat_mat_sqrted)
+            # Verify AHU is running in OS 3 cooling mode with minimum OA
+            & (df[economizer_sig_col] > ahu_min_oa_dpr)
+            & (df[cooling_sig_col] < 0.1)
+        )
+
+        # Set fault flag
+        self._set_fault_flag(df, combined_check, "fc8_flag")
+
+        return df

open_fdd-0.1.9/open_fdd/air_handling_unit/faults/fault_condition_eleven.py

@@ -0,0 +1,108 @@
+import numpy as np
+import pandas as pd
+
+from open_fdd.core.base_fault import BaseFaultCondition
+from open_fdd.core.components import FaultInputColumn, InstanceAttribute
+from open_fdd.core.exceptions import InvalidParameterError
+from open_fdd.core.mixins import FaultConditionMixin
+
+INPUT_COLS = [
+    FaultInputColumn(
+        name="oat_col",
+        constant_form="OAT_COL",
+        description="Outside air temperature",
+        unit="°F",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="mat_col",
+        constant_form="MAT_COL",
+        description="Mixed air temperature",
+        unit="°F",
+        required=True,
+        type=float,
+    ),
+    FaultInputColumn(
+        name="economizer_sig_col",
+        constant_form="ECONOMIZER_SIG_COL",
+        description="Economizer signal",
+        unit="%",
+        required=True,
+        type=float,
+    ),
+]
+
+FAULT_PARAMS = [
+    InstanceAttribute(
+        name="outdoor_degf_err_thres",
+        constant_form="OUTDOOR_DEGF_ERR_THRES",
+        description="Outdoor air temperature error threshold",
+        unit="°F",
+        type=float,
+        range=(0.0, 10.0),
+    ),
+    InstanceAttribute(
+        name="mix_degf_err_thres",
+        constant_form="MIX_DEGF_ERR_THRES",
+        description="Mixed air temperature error threshold",
+        unit="°F",
+        type=float,
+        range=(0.0, 10.0),
+    ),
+]
+
+
+class FaultConditionEleven(BaseFaultCondition, FaultConditionMixin):
+    """Class provides the definitions for Fault Condition 11.
+    Outdoor air temperature and mix air temperature should
+    be approx equal in economizer mode.
+
+    py -3.12 -m pytest open_fdd/tests/ahu/test_ahu_fc11.py -rP -s
+    """
+
+    input_columns = INPUT_COLS
+    fault_params = FAULT_PARAMS
+    equation_string = (
+        "fc11_flag = 1 if |OAT - MAT| > √(εOAT² + εMAT²) in "
+        "economizer mode for N consecutive values else 0 \n"
+    )
+    description_string = (
+        "Fault Condition 11: Outdoor air temperature and mixed air temperature "
+        "should be approximately equal in economizer mode \n"
+    )
+    error_string = "One or more required columns are missing or None \n"
+
+    @FaultConditionMixin._handle_errors
+    def apply(self, df: pd.DataFrame) -> pd.DataFrame:
+        """Apply the fault condition to the DataFrame."""
+        # Apply common checks
+        self._apply_common_checks(df)
+
+        # Get column values using accessor methods
+        mat_col = self.get_input_column("mat_col")
+        oat_col = self.get_input_column("oat_col")
+        economizer_sig_col = self.get_input_column("economizer_sig_col")
+
+        # Get parameter values using accessor methods
+        mix_degf_err_thres = self.get_param("mix_degf_err_thres")
+        outdoor_degf_err_thres = self.get_param("outdoor_degf_err_thres")
+
+        # Check analog outputs [data with units of %] are floats only
+        columns_to_check = [economizer_sig_col]
+        self._apply_analog_checks(df, columns_to_check, check_greater_than_one=True)
+
+        # Perform calculations
+        abs_mat_minus_oat = abs(df[mat_col] - df[oat_col])
+        mat_oat_sqrted = np.sqrt(mix_degf_err_thres**2 + outdoor_degf_err_thres**2)
+
+        combined_check = (
+            (abs_mat_minus_oat > mat_oat_sqrted)
+            # Verify AHU is running in economizer mode
+            & (df[economizer_sig_col] > 0.9)
+        )
+
+        # Set fault flag
+        self._set_fault_flag(df, combined_check, "fc11_flag")
+
+        return df