Usage Instructions
##################

The HPXML input translation is accessed through the `Home Energy Score API`_.
The HPXML translator is made available through the API method
`submit_hpxml_inputs`_, which accepts an HPXML file as a `Base64`_ encoded
payload, so you will need to convert it. An example of how to do this in Python
is:

.. code:: python

    import base64

    with open('path/to/hpxmlfile.xml','r') as f:
        hpxml_as_base64 = base64.standard_b64encode(f.read())

Similar libraries and functionality exist in many languages.

.. _Home Energy Score API: http://hes-documentation.labworks.org/home
.. _submit_hpxml_inputs: https://hes-documentation.labworks.org/home/api-definitions/api-methods/submit_hpxml_inputs
.. _Base64: http://en.wikipedia.org/wiki/Base64