Metadata-Version: 2.4
Name: open-fdd
Version: 3.0.1
Summary: Open-FDD: Arrow-native rule-based HVAC fault detection on a columnar execution engine.
Author-email: Ben Bartling <ben.bartling@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/bbartling/open-fdd
Project-URL: Documentation, https://bbartling.github.io/open-fdd/
Project-URL: Repository, https://github.com/bbartling/open-fdd
Keywords: hvac,fdd,fault-detection,building-automation,pyarrow,arrow,bacnet
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyarrow>=17.0.0
Requires-Dist: pyyaml
Requires-Dist: pydantic<3,>=2.4
Provides-Extra: ml
Requires-Dist: numpy>=1.26.0; extra == "ml"
Requires-Dist: scikit-learn>=1.4.0; extra == "ml"
Provides-Extra: test
Requires-Dist: pytest>=7.0; extra == "test"
Requires-Dist: pytest-timeout>=2.3.0; extra == "test"
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-timeout>=2.3.0; extra == "dev"
Requires-Dist: pyyaml; extra == "dev"
Requires-Dist: pydantic<3,>=2.4; extra == "dev"
Requires-Dist: black[jupyter]>=25.11.0; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Provides-Extra: docs
Requires-Dist: pyyaml; extra == "docs"
Requires-Dist: weasyprint>=62.0; extra == "docs"
Dynamic: license-file

# Open-FDD

<p align="center">
  <a href="https://discord.gg/Ta48yQF8fC"><img src="https://img.shields.io/badge/Discord-Join%20Server-5865F2.svg?logo=discord&logoColor=white" alt="Discord"></a>
  <a href="https://github.com/bbartling/open-fdd/actions/workflows/ci.yml"><img src="https://github.com/bbartling/open-fdd/actions/workflows/ci.yml/badge.svg?branch=master" alt="CI"></a>
  <img src="https://img.shields.io/badge/license-MIT-green.svg" alt="MIT">
  <img src="https://img.shields.io/badge/status-Beta-blue" alt="Beta">
  <img src="https://img.shields.io/badge/Python-%3E%3D3.10-blue?logo=python&logoColor=white" alt="Python 3.10+">
</p>

<p align="center">
  <img src="https://raw.githubusercontent.com/bbartling/open-fdd/master/image.png" alt="Open-FDD logo" width="440">
</p>

<p align="center">
  <strong>Arrow-native</strong> HVAC fault detection — PyArrow columnar rules in Rule Lab, optional graph ML sidecar (sklearn / PyG).
</p>

<p align="center">
  <a href="https://pypi.org/project/open-fdd/"><strong>PyPI open-fdd</strong></a>
</p>

---

## Develop locally

```bash
git clone https://github.com/bbartling/open-fdd.git && cd open-fdd

./scripts/build_and_test.sh
```

**Docker** — build images locally or pull published tags from GHCR:

```bash
./scripts/docker_build.sh

# or pull from GitHub Container Registry (tags on ghcr.io/bbartling/openfdd-bridge)
export OPENFDD_IMAGE_TAG=2026.06.07-edge
docker pull ghcr.io/bbartling/openfdd-bridge:${OPENFDD_IMAGE_TAG}
docker pull ghcr.io/bbartling/openfdd-commission:${OPENFDD_IMAGE_TAG}
docker pull ghcr.io/bbartling/openfdd-mcp-rag:${OPENFDD_IMAGE_TAG}
./scripts/openfdd_stack.sh up
```

Documentation: [bbartling.github.io/open-fdd](https://bbartling.github.io/open-fdd/) — Docker, edge deploy, Rule Lab, and contributor layout (`AGENTS.md`).

---

## License

MIT — see [LICENSE](LICENSE).
