open-fdd 2.3.0

Open-FDD rules engine — YAML + pandas fault detection (PyPI library). Full AFDD Docker stack is a separate repo.

Open-FDD

This repository contains the Open-FDD rules engine only, published to PyPI via GitHub Actions as open-fdd.

For the full on-prem automated fault detection and diagnostics (AFDD) stack—which uses the open-fdd engine from PyPI internally as a full Linux web application—see open-fdd-afdd-stack.

---

Install Package from PyPi

pip install open-fdd

Examples: examples/README.md — quick runs for Brick / Haystack / DBO / 223P ontologies.

---

Documentation

Engine (Standalone / PyPI)

• 🛠️ Open-FDD Engine Docs RuleRunner, YAML rules, examples, and engine-only workflows

• 📕 Engine PDF Docs Offline / Kindle-friendly version of the engine documentation

---

Full AFDD Stack (Docker + Web App)

• 📗 AFDD Stack GitHub Full platform — Dockerized Python web app using the Open-FDD engine

• 💻 AFDD Stack Docs Setup, API, UI, BACnet integration, and full system architecture

---

Dependencies

See pyproject.toml. Runtime: pandas, NumPy, PyYAML. Tests (contributors / CI): install with pip install -e ".[test]" to get pytest (not installed by plain pip install open-fdd). Brick TTL → column_map (rdflib / SPARQL) lives in open-fdd-afdd-stack, not in this wheel. For matplotlib (notebooks / fault_viz) or python-docx (Word reports), install those packages separately if you use those modules.

---

Contributing

git clone https://github.com/bbartling/open-fdd.git
cd open-fdd
python3 -m venv env && source env/bin/activate
pip install -U pip && pip install -e ".[test]"
python -m pytest

See also: TESTING.md, docs/contributing.md, and the channel on the open-fdd Discord for #dev-chat.

---

License

MIT