Open-FDD

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

Examples: examples/README.md.

Documentation: bbartling.github.io/open-fdd

---

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

Runtime: pandas, NumPy, PyYAML, pydantic (see pyproject.toml). For matplotlib (notebooks) or python-docx (Word reports), install those separately if you use those examples.

---

Contributing

See TESTING.md, docs/contributing.md, and the open-fdd Discord #dev-chat.

---

License

MIT