Skip to content

bbartling/open-fdd

Repository files navigation

Open-FDD

Discord CI MIT License Development Status Python PyPI

open-fdd logo

This repository is the open-fdd rules engine: YAML-defined fault detection on pandas DataFrames (open_fdd.engine). The published PyPI wheel contains only the open_fdd package.


Install from PyPI

pip install open-fdd

Online Documentation

This application is part of a broader ecosystem that together forms the Open FDD AFDD Stack, enabling a fully orchestrated, edge-deployable analytics and optimization platform for building automation systems.

  • 🔗 DIY BACnet Server Lightweight BACnet server with JSON-RPC and MQTT support for IoT integrations. Documentation · GitHub

  • 📖 Open FDD AFDD Stack Full AFDD framework with Docker bootstrap, API services, drivers, and React web UI. Documentation · GitHub

  • 📘 Open FDD Fault Detection Engine Core rules engine with RuleRunner, YAML-based fault logic, and pandas workflows. Documentation · GitHub · PyPI

  • ⚙️ easy-aso Framework Lightweight framework for Automated Supervisory Optimization (ASO) algorithms at the IoT edge. Documentation · GitHub · PyPI


Develop and test

git clone https://github.com/bbartling/open-fdd.git
cd open-fdd
python3 -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -U pip
pip install -e ".[dev]"
pytest

Dependencies

  • Python 3.12+
  • pandas
  • numpy
  • pyyaml
  • pydantic>=2.4,<3
  • pip + virtual environment tooling (python3 -m venv)

License

MIT

About

Fault Detection Diagnostics (FDD) for HVAC datasets

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages