Skip to content

NREL/hescore-hpxml

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HPXML to Home Energy Score Translator

CircleCI

This translator script takes an HPXML file or directory of files as an input and generates HEScore inputs from it. The HEScore inputs are exported as json.

Details of the translation assumptions as well instructions for use can be found in the documentation.

Installation

Use a virtualenv. (Good idea, but not strictly required.)

Install using pip:

pip install hescore-hpxml

To get the latest and greatest, clone this repository, cd into the directory and install as follows:

pip install -e .

How to use

Use the command line script:

hpxml2hescore examples/house1.xml

To get some guidance on how to use the script:

hpxml2hescore -h