Quick reference
One-page cheat sheet for the open-fdd rules engine. Deeper detail: Verification, Configuration, Engine API.
What it is
open-fdd evaluates YAML fault rules on pandas DataFrames. Install with pip install open-fdd. The base wheel has no bundled database or Docker stack; optional pip install "open-fdd[desktop]" adds the local FastAPI gateway and desktop storage (see Desktop app).
Common commands
| Goal | Command |
|---|---|
| Install (dev checkout) | pip install -e ".[dev]" |
| Run tests | pytest |
| Import check | python -c "import open_fdd; print('ok')" |
Minimal Python snippet
from pathlib import Path
from open_fdd.engine.runner import RuleRunner
runner = RuleRunner(rules_path=Path("path/to/rules_dir"))
out = runner.run(df, timestamp_col="timestamp", column_map={"Supply_Air_Temperature_Sensor": "sat"})