open-fdd 0.1.0__py3-none-any.whl → 0.1.3__py3-none-any.whl

open_fdd-0.1.3.dist-info/METADATA

@@ -0,0 +1,87 @@
+Metadata-Version: 2.1
+Name: open_fdd
+Version: 0.1.3
+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)
+![PyPI](https://img.shields.io/pypi/v/open-fdd?color=blue&label=pypi%20version)
+
+
+![Alt text](https://raw.githubusercontent.com/bbartling/open-fdd/master/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
+This project is now available on PyPI, making it easy to set up with the Python package manager, pip. You can install the package using the following command:
+
+```bash
+pip install open-fdd
+```
+
+For running Jupyter notebooks, I recommend using Visual Studio Code with the Jupyter notebook extension installed, which offers a seamless experience directly within the editor. Be sure to explore the `examples` directory for Jupyter notebook tutorials. If you have your own FDD experiences to share, feel free to contribute by creating a notebook (`.ipynb`). You’re welcome to reach out to me directly, and I can push your example to GitHub on your behalf, which might be a simpler process than submitting a pull request (PR), especially if you're just sharing an example rather than developing `open-fdd`.
+
+## Project goals
+These are some basic project goals to make this into an interactive FDD application.
+ - [x] finish `air_handling_unit` faults and reports based on ASHRAE and NIST
+ - [x] publish to PyPI as Python library
+ - [ ] make a few IPython notebook tutorials AHU FDD examples with `BRICK` meta data integration.
+ - [ ] make a guide for fault `parameters` like error thresholds, etc.
+ - [ ] make `central_plant` faults, IPython reports, and examples.
+ - [ ] make `energy_efficiency` faults, IPython reports, and examples to `optimize` in reducing energy consumption.
+ - [ ] make `metering`, faults, IPython reports, and examples to possibly model utility metering data.
+ - [ ] create SQL example to read data from time series db and write back to SQL to then read faults in Grafana.
+ - [ ] other?
+
+Certainly! Here's a revised version of your contribution guidelines:
+
+## Contribute
+
+If you have suggestions for improving developer best practices or solutions, please feel free to reach out to me directly using my contact information or Git issue/discussion. I primarily work on Windows with multiple versions of Python installed, with Python 3.12.x as my default version. You can download the latest version of Python here:
+* https://www.python.org/downloads/
+
+1. **Adding New Faults and Reports:**  
+   Developers will need to `> py -3.12 -m pip install black pytest`. When adding new faults and reports, I usually run `> py -3.12 -m pip install .` in the cloned project directory. I continuously uninstall with `> py -3.12 -m pip uninstall open-fdd` and reinstall locally until I'm satisfied with the changes.
+
+2. **Testing Fault Logic:**  
+   All fault logic is rigorously tested using `pytest`. You can run the tests with `> py -m pytest`.
+
+3. **Formatting with Black:**  
+   To ensure code consistency, I use Black for formatting. Run `> py -m black .` to format the code and check it with `> py -m black --check .`
+
+4. **Pushing to GitHub:**  
+   After making changes, and the steps above are successful push them to GitHub in a pull request. The GitHub Actions workflow will automatically run `pytest` and `black` to ensure the build is successful.
+
+
+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 → open_fdd-0.1.3.dist-info}/RECORD

@@ -1,25 +1,48 @@
 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/fault_condition.py,sha256=laq9s2KnLwez5obRaO0j_6Fpiph6usY7pZ_bOEloPRU,2185
+open_fdd/air_handling_unit/faults/fault_condition_eight.py,sha256=OlPXWDhaZ6T-pL0VQhfqTEHm5Q5fSLig1Uj8AIHHuZg,3210
+open_fdd/air_handling_unit/faults/fault_condition_eleven.py,sha256=HW83_Mx3gwPImJBfKHWoSl9nK1wc7LzvpBpmMvS_B6U,3280
+open_fdd/air_handling_unit/faults/fault_condition_fifteen.py,sha256=N6OiVE8aEKS5RNEuz1C7mBvmZ_YEkClPM99pM3AMGfg,4365
+open_fdd/air_handling_unit/faults/fault_condition_five.py,sha256=F7sGFIU48hSravtqoYDf6pMHM5IDAoSoYJKChGkQnMo,3150
+open_fdd/air_handling_unit/faults/fault_condition_four.py,sha256=ZyilsVp_fkZGioXb03TnyN_wenzA_z2qJJ-5v_COO-I,5374
+open_fdd/air_handling_unit/faults/fault_condition_fourteen.py,sha256=LQT7RExG2jsgLVJy9JkHdwq_Sj6tHJ7R5UJL4B2Bf2w,4005
+open_fdd/air_handling_unit/faults/fault_condition_nine.py,sha256=mCNAOVFC0KybY8JTwYxBirYff9hkzqx2X8_fsD6NuPw,3375
+open_fdd/air_handling_unit/faults/fault_condition_one.py,sha256=fxVOgqYhJrrAwKtE0AOo0RgcLiIR5FFpMWRbpb_p7ns,3003
+open_fdd/air_handling_unit/faults/fault_condition_seven.py,sha256=xnlLf9teERfTTiUiISynBWhke3eIuEM-2gROOYoi53c,2847
+open_fdd/air_handling_unit/faults/fault_condition_six.py,sha256=3wD9UGx_-vXaqwZZVs2uyBhenECjb3CqL5ProrUgfoc,5513
+open_fdd/air_handling_unit/faults/fault_condition_ten.py,sha256=1l76_hS1FtnTIWsU01D0s5eWzeRRM7fgVyPmTUyUnq8,3153
+open_fdd/air_handling_unit/faults/fault_condition_thirteen.py,sha256=IWbCqChHa5hjnKQ_1dyS7lrpiAg3Y5ICuoe7OyjEX6E,3333
+open_fdd/air_handling_unit/faults/fault_condition_three.py,sha256=TTGe1vScZof0DZJ1jZYla6V8xeHdvDc_uuldS2pODCI,3024
+open_fdd/air_handling_unit/faults/fault_condition_twelve.py,sha256=gaRg75Mq3RIJSBY8XpLdLd_Nzi7cKZ3o4dnW7w1NYsM,3645
+open_fdd/air_handling_unit/faults/fault_condition_two.py,sha256=JdlZVXI4Fkb-YCaj44BrGATYHZ-jtysWGU3JOZA7ePs,3019
+open_fdd/air_handling_unit/faults/helper_utils.py,sha256=9FBPNfOsd_BqP95u4hWelnKeUu_IvSUFhYBfPHtXIZE,13861
 open_fdd/air_handling_unit/faults/shared_utils.py,sha256=Kp8ZUBhtrh-jU2Q_bbXTpnbVVUAyacp41tDMknY50i4,2252
+open_fdd/air_handling_unit/images/ahu1_fc1_2024-06_1.jpg,sha256=3dHZyEm_nS4p7-acZprIpZyuU65_IJKk2sixJBf7Ans,444019
+open_fdd/air_handling_unit/images/ahu1_fc1_2024-06_2.jpg,sha256=kjWCDhRkpxiigl9VJnnMBlETA_FWHZtAn9oqKuQl1M4,392583
+open_fdd/air_handling_unit/images/example1.jpg,sha256=3dHZyEm_nS4p7-acZprIpZyuU65_IJKk2sixJBf7Ans,444019
+open_fdd/air_handling_unit/images/example2.jpg,sha256=kjWCDhRkpxiigl9VJnnMBlETA_FWHZtAn9oqKuQl1M4,392583
+open_fdd/air_handling_unit/images/fc10_definition.png,sha256=wE4tg3BjUDnEfeM1XOYTHAcnl4yUJnkoUrVOipr4Ivo,16603
+open_fdd/air_handling_unit/images/fc11_definition.png,sha256=Vp_mZxgPGsB0KsEeazwaI3NcgwvLDBBWzutUh8c2Kcg,14534
+open_fdd/air_handling_unit/images/fc12_definition.png,sha256=CZUukCTaQ2DlDRMk-EdZyqXr_Wne-EKUYuYn_ly82Hc,14254
+open_fdd/air_handling_unit/images/fc13_definition.png,sha256=qcYnTHtnUwfAaLYFVebcbYtjVSgxSQKqZTi_VwHymgo,16733
+open_fdd/air_handling_unit/images/fc1_definition.png,sha256=htGaVcaem2CI47bSq_Y6mBdmwbpUHeaQW2oTm4EREbc,8164
+open_fdd/air_handling_unit/images/fc1_report_screenshot_all.png,sha256=U3IhLL2nJ3k-UF-smPd1FPAGnznBxsrbBkj8B3ZtwyM,184473
+open_fdd/air_handling_unit/images/fc2_definition.png,sha256=qnFzSrXsj_mwhTq4Zi-NT7kwCTz91HKPGHsh77ov5Fs,9124
+open_fdd/air_handling_unit/images/fc3_definition.png,sha256=AE0cecNhMiHHsMBQAPWF-cMnLAWK1A27SASeoNoe76w,9118
+open_fdd/air_handling_unit/images/fc4_definition.png,sha256=66NztKUPH0R3nhNgVnxzN3UgMLhE-6mUKxhnwtkRN90,4245
+open_fdd/air_handling_unit/images/fc5_definition.png,sha256=xQMxDnStccm8f0KIFL-BpG3yQv4fnl4M9t_9VMVOpWg,14634
+open_fdd/air_handling_unit/images/fc6_definition.png,sha256=MPV8QcnSnRRNq465dee5Q0Uw5e2ZV_WoIFBVAvYLCVc,20777
+open_fdd/air_handling_unit/images/fc7_definition.png,sha256=O6bsh0kG4sHeWCDSZuBHjDZ3xDFesSY42yifqhWXMMo,15849
+open_fdd/air_handling_unit/images/fc8_definition.png,sha256=Cce-_mmZA0QbsbWETwOCr45CJiJLR1vHPQNmB9dQZ6g,19702
+open_fdd/air_handling_unit/images/fc9_definition.png,sha256=9r7QPViCQ0LItI4NdJsD7VfZjdA4RUZuh08BzxVUnfU,14913
+open_fdd/air_handling_unit/images/latex_generator.py,sha256=9kotpUZjQrECXiB8ewcvYBLMEVvy9-r1-HnbpPb-Xr0,5976
+open_fdd/air_handling_unit/images/params.docx,sha256=_mh1G-avi-lsssaW_qH33vGVaYwS_XL_IOQweYpQvAo,157634
+open_fdd/air_handling_unit/images/params.pdf,sha256=2rmxh2yxuB7x3Q2Jyq0MnFoTJAQqxwIoxGvzzJirWkU,175678
+open_fdd/air_handling_unit/images/plot_for_repo.png,sha256=u4OIzZUyGk6G4o1AusEERUU6aen4vVX-CGPl14P3qkA,651969
 open_fdd/air_handling_unit/reports/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+open_fdd/air_handling_unit/reports/base_report.py,sha256=oZX6_qXUjuPEHKpF89DhgpPbAkhHeoo3jpDL30u4njs,1778
 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
@@ -32,12 +55,12 @@ open_fdd/air_handling_unit/reports/report_fc3.py,sha256=xyGjwYxJU2kveVJHLzAM3T_M
 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_fc7.py,sha256=5j9IAEgmjMqSbpQcStCJZB46TmRPtVSDKnGUutSeVxs,5327
 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_fc1.py,sha256=bBi3PLAqlHmLngox23Co-Q9uBK515g2rUVYLGrJ2nSY,5457
 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
@@ -46,14 +69,14 @@ open_fdd/tests/ahu/test_ahu_fc14.py,sha256=SlnQF37K73tgfUtp1bQl0nH46YV5aByzonUNX
 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_fc4.py,sha256=a8B3MuFfdxJkWbcz0PtXXk9gnT1dsmBg3N0uG7Rz2KQ,5009
 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.3.dist-info/LICENSE,sha256=eghao_GGx_0gB2Sll3x2vV29knONEzUQKrkaXpX1F7w,1087
+open_fdd-0.1.3.dist-info/METADATA,sha256=Pb4MNzK2oSGfARayKjTmvInLOxpPWKdhzONJYcyeFEo,6449
+open_fdd-0.1.3.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+open_fdd-0.1.3.dist-info/top_level.txt,sha256=Q7sB6UB2d8Ch1v_xIsTiNegmgcCXPkwkrxK3ug6VEOs,9
+open_fdd-0.1.3.dist-info/RECORD,,

open_fdd-0.1.0.dist-info/METADATA

@@ -1,65 +0,0 @@
-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.