Getting Started

Use this page to install open-fdd, run the test suite from a checkout, and find examples.

Install from PyPI 

pip install open-fdd

Python 3.10+ is required (see requires-python in pyproject.toml).

Develop from a git checkout 

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]"
# optional: gateway, MCP, desktop UI tests — pip install -e ".[dev,desktop]"
python -c "import open_fdd; print('open_fdd import OK')"
pytest

Examples

See examples/README.md in the repository for CSV-driven demos, ontology examples, and notebooks. Many examples assume pandas only; optional plotting or Word output need extra packages.