Getting Started
PHX (Passive House Exchange) is a Python library that converts building energy model data between Honeybee-PH (HBJSON) and Passive House formats — WUFI-Passive XML, PHPP Excel, and PPP.
PHX models are in-memory only — they are never serialized directly. They serve as an intermediate representation created from a source format and exported to a target format.
This library is not affiliated with or created by PHI, Phius, or the WUFI development team.
Prerequisites
PHX is designed to work as part of the Honeybee-PH workflow. You will need:
- Python 3.10+
- Honeybee-PH — the upstream data model that produces HBJSON files
- A target application: WUFI-Passive, PHPP, or both
For the full Grasshopper-based workflow, you will also need:
- Ladybug Tools v1.9 or higher
- Rhino 3D + Grasshopper
- honeybee-grasshopper-ph (Grasshopper components)
Installation
Install from PyPI:
pip install PHX
Typical Workflow
graph LR
A[Rhino / Grasshopper] -->|honeybee-grasshopper-ph| B[Honeybee-PH Model]
B -->|HBJSON| C[PHX]
C --> D[WUFI-Passive XML]
C --> E[PHPP Excel]
C --> F[PPP]
- Model your building geometry in Rhino and assign Passive House attributes using the Grasshopper components.
- Export the Honeybee-PH model as an HBJSON file.
- Convert the HBJSON to your target format using PHX — either via the included command-line scripts or programmatically.
- Open the resulting file in WUFI-Passive, PHPP, or your target application.