Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/NREL/hescore-hpxml

HPXML to Home Energy Score Translator
https://github.com/NREL/hescore-hpxml

Last synced: 3 months ago
JSON representation

HPXML to Home Energy Score Translator

Awesome Lists containing this project

README

        

**This repo has been archived. Development of these features has moved into another repo.**

HPXML to Home Energy Score Translator
=====================================

[![CircleCI](https://circleci.com/gh/NREL/hescore-hpxml.svg?style=svg)](https://circleci.com/gh/NREL/hescore-hpxml)

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](http://hescore-hpxml.readthedocs.org/en/latest/).

Installation
------------

Use a
[virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/).
(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