Skip to content

Commit

Permalink
reports for ahu inside init now and all examples will follow running …
Browse files Browse the repository at this point in the history
…one fault at a time. blank ipynb also put in examples dir for someone starting out. moving to chiller plant next to create fault rules from scratch. bumping rev on pypi to 1.5
  • Loading branch information
bbartling committed Aug 28, 2024
1 parent c2b0a16 commit aaee4fd
Show file tree
Hide file tree
Showing 21 changed files with 2,444 additions and 5,797 deletions.
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,28 @@ 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! As ChatGPT would eagerly say!
The following are key objectives to enhance this project into a fully interactive Fault Detection and Diagnostics (FDD) application.

### Completed
- [x] Develop and finalize `air_handling_unit` fault conditions and reports, aligning with ASHRAE and NIST standards.
- [x] Publish the project as a Python library on PyPI.

## Contribute
### In Progress
- [ ] Create IPython notebook tutorials showcasing AHU FDD examples, incorporating BRICK metadata integration.
- [ ] Develop a comprehensive guide on a github.io website (or other?) for defining fault parameters, including error thresholds and other critical settings.

### Upcoming
- [ ] Extend the project to include `central_plant` fault conditions, IPython reports, and example applications.
- [ ] Design `energy_efficiency` fault detection modules, including IPython reports and examples focused on optimizing energy consumption.
- [ ] Develop `metering` fault conditions, along with IPython reports and examples, potentially modeling utility metering data.
- [ ] Implement SQL integration examples for reading data from a time series database, writing back to SQL, and visualizing faults in Grafana.

### Future Considerations
Explore additional features and enhancements as the project evolves.
- [ ] Explore additional features and enhancements as the project evolves.


## 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/

Expand Down
3,665 changes: 0 additions & 3,665 deletions examples/csv_data_source/ahu_example.ipynb

This file was deleted.

771 changes: 557 additions & 214 deletions examples/csv_data_source/ahu_individual_faults.ipynb

Large diffs are not rendered by default.

Loading

0 comments on commit aaee4fd

Please sign in to comment.