Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HPXML v4.0 #392

Merged
merged 17 commits into from
Apr 18, 2024
Merged

HPXML v4.0 #392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
9ef78b6
Merge branch 'plug_load_location_enums' of https://github.com/hpxmlwg…
shorowit Sep 8, 2023
a753c0f
Merge branch 'cee_case' of https://github.com/hpxmlwg/hpxml into v4_0
shorowit Sep 8, 2023
180380f
Merge branch 'shared_systems' of https://github.com/hpxmlwg/hpxml int…
shorowit Sep 8, 2023
8bce7e5
Merge branch 'fixed_space_heater' of https://github.com/hpxmlwg/hpxml…
shorowit Sep 8, 2023
1f092c7
Merge branch 'hottubs' of https://github.com/hpxmlwg/hpxml into v4_0
shorowit Sep 8, 2023
4c6ab2e
Merge branch 'fraction_operable' of https://github.com/hpxmlwg/hpxml …
shorowit Sep 8, 2023
6e1d111
Bump to 4.0
shorowit Sep 8, 2023
feb1d88
Latest HPXMLMerged.xsd
Sep 8, 2023
30ff825
Update HPXMLs
shorowit Sep 8, 2023
9dff88f
Merge branch 'v4_0' of https://github.com/hpxmlwg/hpxml into v4_0
shorowit Sep 8, 2023
6dd1294
Merge branch 'radiant_barrier_locations' of https://github.com/hpxmlw…
prsh5175 Sep 20, 2023
3c27e4f
Merge remote-tracking branch 'origin/master' into v4_0
nmerket Sep 26, 2023
75d1e12
updating namespace
nmerket Sep 26, 2023
6e22703
updating the guide docs
nmerket Sep 26, 2023
4a58b6e
Merge remote-tracking branch 'origin/master' into v4_0
nmerket Oct 17, 2023
54708d8
Merge remote-tracking branch 'origin/master' into v4_0
nmerket Jan 19, 2024
4a6cd94
Merge remote-tracking branch 'origin/master' into v4_0
nmerket Apr 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/audit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<HPXML xmlns="http://hpxmlonline.com/2019/10" schemaVersion="3.1">
<HPXML xmlns="http://hpxmlonline.com/2023/09" schemaVersion="4.0">
<XMLTransactionHeaderInformation>
<XMLType/>
<XMLGeneratedBy>Super-duper audit software v1.0</XMLGeneratedBy>
Expand Down
2 changes: 1 addition & 1 deletion examples/bpi2101.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<HPXML xmlns="http://hpxmlonline.com/2019/10" schemaVersion="3.1">
<HPXML xmlns="http://hpxmlonline.com/2023/09" schemaVersion="4.0">
<XMLTransactionHeaderInformation>
<XMLType>BPI-2101</XMLType>
<XMLGeneratedBy>Noel</XMLGeneratedBy>
Expand Down
2 changes: 1 addition & 1 deletion examples/invalid.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<HPXML xmlns="http://hpxmlonline.com/2019/10" schemaVersion="3.1">
<HPXML xmlns="http://hpxmlonline.com/2023/09" schemaVersion="4.0">
<XMLTransactionHeaderInformation>
<XMLType/>
<XMLGeneratedBy>Super-duper audit software v1.0</XMLGeneratedBy>
Expand Down
2 changes: 1 addition & 1 deletion examples/upgrade.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<HPXML xmlns="http://hpxmlonline.com/2019/10" schemaVersion="3.1">
<HPXML xmlns="http://hpxmlonline.com/2023/09" schemaVersion="4.0">
<XMLTransactionHeaderInformation>
<XMLType/>
<XMLGeneratedBy>Joe</XMLGeneratedBy>
Expand Down
4 changes: 2 additions & 2 deletions guide/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@
# built documents.
#
# The short X.Y version.
version = '3.1' # should match hpxml version
version = '4.0' # should match hpxml version
# The full version, including alpha/beta/rc tags.
release = '3.1'
release = '4.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
3 changes: 2 additions & 1 deletion guide/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
HPXML Implementation Guide
##########################

.. todolist::
.. warning::
We have made efforts to update this incrementally as new versions are released, but some of the information in this guide may be out of date with the latest HPXML standard.

.. only:: html

Expand Down
2 changes: 1 addition & 1 deletion guide/source/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The HPXML Working Group can be a valuable resource for program administrators, i
Versioning
==========

The HPXML schema follows the `Semantic Versioning 2.0 specification <http://semver.org/>`_. The version numbers follow a pattern of Major, Minor, and Patch (e.g., 3.1.0). The major version number is incremented when the schemas are changed in a manner that is incompatible with previous versions. Examples of changes that require a major version change include renaming elements, removing elements, moving elements, and removing enumerations.
The HPXML schema follows the `Semantic Versioning 2.0 specification <http://semver.org/>`_. The version numbers follow a pattern of Major, Minor, and Patch (e.g., 4.0.0). The major version number is incremented when the schemas are changed in a manner that is incompatible with previous versions. Examples of changes that require a major version change include renaming elements, removing elements, moving elements, and removing enumerations.

The minor version number is incremented when the schemas are changed in a manner that is backwards compatible with previous versions that share the same major version. In other words, a document created in a previous version of the schema will also validate against the new schema. Examples of changes that require a minor version change include adding elements, adding enumerations, and changing the annotation in the schema for an element.

Expand Down
14 changes: 5 additions & 9 deletions guide/source/program_administrator/identify_data_needs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,19 +54,15 @@ Adopting these best practices will assist in establishing a streamlined data sel
HPXML Data Selection Tool
*************************

To assist program administrators in reviewing the standard datasets that are being implemented by other programs, a data selection tool is available to help identify the required data points. The tool also helps programs select and communicate the requirements for the program to contractors, trade allies, and other stakeholders. The HPXML Data Selection Tool is a "living document" so if a program identifies data points that are not in the datasets, the HPXML working group can assist in adding them to the tool to meet the program’s needs.
.. warning::

* Download: :download:`HPXML Data Selection Tool <hpxml_data_selection_tool.xlsx>`

The attached instructional video provides a walkthrough of the HPXML data selection tool. By using the tool, programs can quickly select the data required for HPXML program implementation. Programs can then forward the tool to the implementation team, trade allies and software providers, giving them clear guidance on the requirements for HPXML Implementation with your program.
The data selection tool spreadsheet no longer represents the latest HPXML version. Some of information may still be relevant, so it is here for reference for those interested.

.. raw:: html
To assist program administrators in reviewing the standard datasets that are being implemented by other programs, a data selection tool is available to help identify the required data points. The tool also helps programs select and communicate the requirements for the program to contractors, trade allies, and other stakeholders. The HPXML Data Selection Tool is a "living document" so if a program identifies data points that are not in the datasets, the HPXML working group can assist in adding them to the tool to meet the program's needs.

<iframe width="640" height="360" src="https://www.youtube.com/embed/vmfU1ytzMfc" frameborder="0" allowfullscreen></iframe>

.. raw:: latex
* Download: :download:`HPXML Data Selection Tool <hpxml_data_selection_tool.xlsx>`

\par\href{https://youtu.be/vmfU1ytzMfc}{YouTube: HPXML Data Selection Tool Tutorial}\par
By using the tool, programs can quickly select the data required for HPXML program implementation. Programs can then forward the tool to the implementation team, trade allies and software providers, giving them clear guidance on the requirements for HPXML Implementation with your program.

Additional details about the data structure and standard datasets are provided in the sections below.

Expand Down
2 changes: 1 addition & 1 deletion guide/source/software_developer/idref.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<HPXML xmlns="http://hpxmlonline.com/2019/10" schemaVersion="3.1">
<HPXML xmlns="http://hpxmlonline.com/2023/09" schemaVersion="4.0">
<XMLTransactionHeaderInformation>
<XMLType></XMLType>
<XMLGeneratedBy></XMLGeneratedBy>
Expand Down
2 changes: 1 addition & 1 deletion guide/source/software_developer/sameas.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<HPXML xmlns="http://hpxmlonline.com/2019/10" schemaVersion="3.1">
<HPXML xmlns="http://hpxmlonline.com/2023/09" schemaVersion="4.0">
<XMLTransactionHeaderInformation>
<XMLType></XMLType>
<XMLGeneratedBy></XMLGeneratedBy>
Expand Down
2 changes: 1 addition & 1 deletion guide/source/software_developer/usecases/example1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<HPXML xmlns="http://hpxmlonline.com/2019/10" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hpxmlonline.com/2014/6 ../schemas/HPXML.xsd" schemaVersion="3.1">
<HPXML xmlns="http://hpxmlonline.com/2023/09" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hpxmlonline.com/2014/6 ../schemas/HPXML.xsd" schemaVersion="4.0">
<XMLTransactionHeaderInformation>
<XMLType/>
<XMLGeneratedBy/>
Expand Down
8 changes: 4 additions & 4 deletions guide/source/software_developer/versioning.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,24 @@ Versioning

The HPXML schemas follow the `Semantic Versioning v2.0 <http://semver.org/>`_
specification. The version numbers follow a pattern of :ref:`major-version`.
:ref:`minor-version`. :ref:`patch-version` (i.e. 3.1.0).
:ref:`minor-version`. :ref:`patch-version` (i.e. 4.0.0).

The first element of ``HPXML.xsd`` will indicate the version of the schema via
the ``version`` attribute. Note that when referencing a version, the patch
number is assumed to be zero if it is omitted.

.. code-block:: xml

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2019/10"
targetNamespace="http://hpxmlonline.com/2019/10" elementFormDefault="qualified" version="3.1">
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2023/09"
targetNamespace="http://hpxmlonline.com/2023/09" elementFormDefault="qualified" version="4.0">

Additionally, starting with version 2.0, the version of the schema used is
required in the ``schemaVersion`` attribute on the root element of every
document.

.. code-block:: xml

<HPXML xmlns="http://hpxmlonline.com/2019/10" schemaVersion="3.1">
<HPXML xmlns="http://hpxmlonline.com/2023/09" schemaVersion="4.0">

.. _major-version:

Expand Down
6 changes: 3 additions & 3 deletions guide/source/tools_and_resources.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ A number of tool and resources exist to help software developers, programs, and
HPXML Website
*************

The Home Performance Coalition hosts a website that has information, tools, and resources on HPXML and its business cases. The website is: https://www.hpxmlonline.com.
The Building Performance Association hosts a website that has information, tools, and resources on HPXML and its business cases. The website is: https://www.hpxmlonline.com.

HPXML Implementation Guide
**************************

The `HPXML Implementation Guide <http://hpxml-guide.rtfd.org>`_ provides detailed information to programs and software developers on how to implement HPXML.
The `HPXML Implementation Guide <http://hpxml-guide.rtfd.org>`_ (this document) provides detailed information to programs and software developers on how to implement HPXML.

HPXML Data Selection Tool
*************************
Expand All @@ -28,7 +28,7 @@ There is also a data dictionary for HPXML included in the Toolbox that documents
HEScore Translator
******************

The Home Energy Score Translator generates HEScore inputs from HPXML files. The translator is incorporated into the HEScore API. By using this translator, software developers can leverage their investment in HPXML to provide HESCORE functionality with minimum development cost.
The Home Energy Score Translator generates HEScore inputs from HPXML files. The translator is `incorporated into the HEScore API <https://hes-documentation.labworks.org/home/api-definitions/api-methods/submit_hpxml_inputs>`_. By using this translator, software developers can leverage their investment in HPXML to provide HEScore functionality with minimum development cost.

Home Upgrade Program Accelerator
********************************
Expand Down
5 changes: 2 additions & 3 deletions merged_schema/HPXMLMerged.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2019/10" targetNamespace="http://hpxmlonline.com/2019/10" elementFormDefault="qualified" version="3.1">
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2023/09" targetNamespace="http://hpxmlonline.com/2023/09" elementFormDefault="qualified" version="4.0">
<xs:element name="HPXML">
<xs:complexType>
<xs:sequence>
Expand Down Expand Up @@ -6345,8 +6345,7 @@
</xs:complexType>
<xs:simpleType name="schemaVersionType">
<xs:restriction base="xs:string">
<xs:enumeration value="3.0"/>
<xs:enumeration value="3.1"/>
<xs:enumeration value="4.0"/>
</xs:restriction>
</xs:simpleType>
<!--Address Information Below-->
Expand Down
2 changes: 1 addition & 1 deletion schemas/HPXML.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns="http://hpxmlonline.com/2019/10" targetNamespace="http://hpxmlonline.com/2019/10" elementFormDefault="qualified" version="3.1">
xmlns="http://hpxmlonline.com/2023/09" targetNamespace="http://hpxmlonline.com/2023/09" elementFormDefault="qualified" version="4.0">
<xs:include schemaLocation="HPXMLBaseElements.xsd"/>
<xs:element name="HPXML">
<xs:complexType>
Expand Down
2 changes: 1 addition & 1 deletion schemas/HPXMLBaseElements.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2019/10" targetNamespace="http://hpxmlonline.com/2019/10" elementFormDefault="qualified" version="3.1">
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2023/09" targetNamespace="http://hpxmlonline.com/2023/09" elementFormDefault="qualified" version="4.0">
<xs:include schemaLocation="HPXMLDataTypes.xsd"/>
<xs:element name="XMLTransactionHeaderInformation">
<xs:annotation>
Expand Down
5 changes: 2 additions & 3 deletions schemas/HPXMLDataTypes.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2019/10" targetNamespace="http://hpxmlonline.com/2019/10" elementFormDefault="qualified" version="3.1">
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://hpxmlonline.com/2023/09" targetNamespace="http://hpxmlonline.com/2023/09" elementFormDefault="qualified" version="4.0">
<xs:simpleType name="DataSource">
<xs:restriction base="xs:string">
<xs:enumeration value="user"/>
Expand Down Expand Up @@ -69,8 +69,7 @@
</xs:complexType>
<xs:simpleType name="schemaVersionType">
<xs:restriction base="xs:string">
<xs:enumeration value="3.0"/>
<xs:enumeration value="3.1"/>
<xs:enumeration value="4.0"/>
</xs:restriction>
</xs:simpleType>
<!--Address Information Below-->
Expand Down
Loading