diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index fbea1e74..56e365e0 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -3,12 +3,12 @@ name: Test Schemas on: [pull_request] jobs: - build: + test-xsd: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Set up Python - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: 3.9 - name: Install dependencies @@ -18,3 +18,41 @@ jobs: - name: Test with pytest run: | pytest tests + + flatten-xsd: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.head_ref }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install lxml + - name: Install software + shell: bash + run: | + export DEBIAN_FRONTEND=noninteractive + sudo apt update + sudo -E apt-get install -y libxml2-utils + - name: Flatten XSD + run: | + cd schemas + python ../scripts/xsdflatten.py HPXML.xsd ../merged_schema/HPXMLMerged.xsd + - name: Commit XSD + run: | + branch_name="${{ github.head_ref }}" + git pull origin $branch_name + git add merged_schema/HPXMLMerged.xsd + git status + if [[ $(git diff --cached --exit-code) ]]; then + git config --global user.email "github-action@users.noreply.github.com" + git config --global user.name "GitHub Action" + git commit -m "Latest HPXMLMerged.xsd" + echo "Pushing to branch: $branch_name" + git push -u origin $branch_name + fi + - name: Validate XSD + run: | + export XSDPATH=merged_schema/HPXMLMerged.xsd + xmllint --schema $XSDPATH examples/audit.xml --noout \ No newline at end of file diff --git a/examples/invalid.xml b/examples/invalid.xml new file mode 100644 index 00000000..ad70b17d --- /dev/null +++ b/examples/invalid.xml @@ -0,0 +1,680 @@ + + + + Super-duper audit software v1.0 + 2014-10-07T20:25:12 + create + + + Super-duper audit software + 1.0 + + + + + + + ACME Home Performance Company + + + + + John + Doe + + + john.doe@hpxmlonline.com + + + + + + + + + + + + Jane + Customer + + + 555-555-5555 + + + + + + + + +
+ 123 Main St + + Beverly Hills + CA + 90210 +
+
+ + audit + + + + + 4 + + + 1961 + single-family detached + 2400 + 1 + 19200 + + + true + true + + + + + + + + + 50 + + CFM + 1300 + + + + + + + + + true + + + + + + + + + + + + true + true + + + + + + + + + shingles + + + + 0 + + + + + + + + + + + 13 + + + + + + + + + + + 19 + + + + + + + + + 0 + + + + + + + + true + 2.17 + + + + + + + + + basement - conditioned + + + + + natural gas + + AFUE + 0.80 + + 0.7 + + + + central air conditioner + electricity + 24000 + 0.7 + + SEER + 10 + + + + + air-to-air + 0.3 + 0.3 + + SEER + 15 + + + HSPF + 8 + + + + + + programmable thermostat + + + + + + + + CFM25 + 123 + + + + + sheet metal + 4 + living space + + + + 2400 + + true + + + + + + + atmospheric + + + + + + natural gas + storage water heater + living space + + + + + + + + top loader + + + + side-by-side + true + + + + + + 20 + + + + 60 + 3 + + + + + + + + + + + + + + + + + false + + + + + + + + + + + + +
+ + + + +
+ 123 Main St + + Beverly Hills + CA + 90210 +
+
+ + proposed workscope + + + + + 4 + + + 1961 + single-family detached + 2400 + 1 + 19200 + + + true + true + + + + + + + + + 50 + + CFM + 1300 + + + + + + + + + true + + + + + + + + + + + + true + true + + + + + + + + + shingles + + + + 0 + + + + + + + + + + + 13 + + + + + + + + + + + 49 + + + + + + + + + 0 + + + + + + + + true + 2.17 + + + + + + + + + basement - conditioned + + + + + natural gas + + AFUE + 0.92 + + 0.7 + + + + central air conditioner + electricity + 24000 + 0.7 + + SEER + 10 + + + + + air-to-air + 0.3 + 0.3 + + SEER + 15 + + + HSPF + 8 + + + + + + programmable thermostat + + + + + + + + CFM25 + 123 + + + + + sheet metal + 4 + living space + + + + 2400 + + true + + + + + + + atmospheric + + + + + + natural gas + storage water heater + living space + + + + + + + + top loader + + + + side-by-side + true + + + + + + 20 + + + + 60 + 3 + + + + + + + + + + + + + + + + + false + + + + + + + 1 + + 50 + + pass + 2 + + + + 456 + 123 + passed + + + 456 + 123 + passed + + + 456.7 + 123.4 + passed + 2 + + + natural gas + false + false + + + + + + 456 + 123 + passed + + + 456 + 123 + passed + + + 456.7 + 123.4 + passed + 2 + + + natural gas + false + false + + + + + + +
+ + + + + + + proposed workscope + + + estimated + + electricity + kWh + 3000 + 55 + 0.1 + + + natural gas + therms + 100 + 123 + 0.3 + + 0.25 + + + + + + + + 1200 + + + + + + + + + + + + 3000 + + + + + + + + + + + + + + + natural gas + + + + electricity + + + +
diff --git a/merged_schema/HPXMLMerged.xsd b/merged_schema/HPXMLMerged.xsd new file mode 100644 index 00000000..85ccd9e9 --- /dev/null +++ b/merged_schema/HPXMLMerged.xsd @@ -0,0 +1,10625 @@ + + + + + + + + + + + + + + + + + + + + These are a series of elements that indicate the type of XML and basic descriptive data about the XML. + + + + + + + + + + + + + + + Address information contains the basic descriptive elements of a location. + + + + + + + + + + + + + + + + + + [deg] North-south position of a point on the Earth's surface. Use negative values for southern hemisphere. + + + + + [deg] East-west position of a point on the Earth's surface. Use negative values for the western hemisphere. + + + + + Also known as Open Location Code. See https://maps.google.com/pluscodes/ + + + + + Unique Building ID. See https://ubid.pnnl.gov. + + + + + + + + + System identifiers contain type codes and an identifier for both a sending and a receiving system. These fields are needed to be able to transmit data between two + systems, and have it identified in the two systems. Also, there is an id attribute to define a local id to be used internally. + + + + + + + + + + id local to the current document + + + + + Use to reference the id of the same object on the base building where the object has not been replaced. + + + + + + + + + + + Use the id attribute if the element being referenced is available locally in the current xml transaction. Use the Sending/Receiving System Identifiers to identify + elements in other xml transactions. + + + + + + + + + + Id reference in the current document. Optional. If the element isn't available in the current document, don't use this. + + + + + + + These are the system identifiers for a specific contractor at a business + + + + + + + + + + + + + + + + + + + + + Quality assurance: The observation techniques and activities used externally by an organization to evaluate the effectiveness of their quality management + system and to provide feedback that may result in quality improvements (BPI, 2006). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Utility company or fuel provider + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Describe + + + + + Indicates insulation not present. + + + + + Indicates insulation present but material type unknown. + + + + + + + + + + + + + This should indicate the effective R-value of the complete assembly including any air films or other treatments. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [in] + + + + + + + + + + + + + + + + + + + + + [ft] Vertical distance from top of foundation wall to top of insulation. + + + + + [ft] Vertical distance from top of foundation wall to bottom of insulation. + + + + + + + + + + + + + + [ft] Depth from top of slab to bottom of vertical slab perimeter insulation + + + + + + + + + + + + + + [ft] Width from slab edge inward of horizontal under-slab insulation + + + + + + + + + + + + + + + + + + [in] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + loads/week of actual usage by the occupants + + + + + [lbs dry clothes/kWh] The energy performance metric for ENERGY STAR certified residential clothes dryers prior to September 13, 2013. The new metric is + Combined Energy Factor. + + + + + [lbs dry clothes/kWh] The energy performance metric for ENERGY STAR certified residential clothes dryers as of September 13, 2013, it includes the active + drying cycle energy as well as energy consumed during Stand-by and Off modes. + + + + + + + + + + + + + + + + + + + + + + + The energy performance metric for ENERGY STAR certified residential clothes washers prior to March 7, 2015. The new metric is Integrated Modified Energy + Factor. + + + + + The energy performance metric for ENERGY STAR certified residential clothes washers as of March 7, 2015. + + + + + The water performance metric for ENERGY STAR certified residential clothes washers prior to March 7, 2015. The new metric is Integrated Water + Factor. + + + + + The water performance metric for ENERGY STAR certified residential clothes washers as of March 7, 2015. + + + + + loads/week of actual usage by the occupants; use LabelUsage instead for the loads/week on the EnergyGuide label + + + + + kWh/yr + + + + + $/kWh + + + + + $/therm + + + + + $ + + + + + loads/week per the Energy Guide label; use Usage instead for loads/week of actual usage by the occupants + + + + + ft^3 + + + + + + + + + + + + + + + + + + + + + + + + + + + loads/week of actual usage by the occupants; use LabelUsage instead for the loads/week on the EnergyGuide label + + + + + $/kWh + + + + + $/therm + + + + + $ + + + + + loads/week per the Energy Guide label; use Usage instead for loads/week of actual usage by the occupants + + + + + + + + + + + + + + + + + [cu.ft.] + + + + + + + + + + + + + + + + + True if it is the primary refrigerator + + + + + [cu.ft.] + + + + + [cu.ft.] Volume of refrigerator for keeping food at less than freezing. + + + + + [cu.ft.] Freezer Volume + + + + + + + + + + + + + + Portable room dehumidifiers are typically used to dehumidify a single room or space and can be easily moved to where they are needed. Whole-home dehumidifiers are typically installed to use your home’s air ducts to dehumidify one or more rooms and are often permanent. Some dehumifiers can operate in both configurations by means of a ducting kit. + + + + + + Rated water removal rate. This represents the expected performance in a basement for portable dehumidifiers and expected performance in the average home for whole-home dehumifiiers. [pints/day] + + + + + For whole-home dehumidifiers, this is a measure of the rectangular volume that the product case occupies, exclusive of any duct attachment collars or other external components. [ft^3] + + + + + The rated efficiency of the dehumidifier in liters of water removed per kilowatt-hour of energy consumed. [L/kWh] + + + + + The rated efficiency of the dehumidifier in liters of water removed per kilowatt-hour of energy consumed. The IEF is a new metric used for dehumidifiers as of 2019 that incorporates energy consumed when the fan is running while the refrigeration system is off and standby power consumption, in addition to the energy consumed by the refrigeration system. [L/kWh] + + + + + Enter the setpoint as a fractional number between 0 and 1, i.e. 60% RH = 0.6. + + + + + + + + + + + + [CFM] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [sq.ft.] + + + + + [cu.ft.] + + + + + [ft] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Use a different Attic element for each type of attic. + + + + + + + The space over which this attic is + + + + + + + Specifies whether the attic is within the infiltration volume impacted by an air leakage test. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Use a different Foundation element for each type of foundation. + + + + + + + + + + + Specifies whether the foundation is within the infiltration volume impacted by an air leakage test. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Use a different Garage element for each type of garage. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Use the Roof element for all pitched/horizontal surfaces underneath ambient conditions. + + + + + + + + + [sq.ft.] Surface area of the roof itself + + + + + + [deg] + + + + + + + + + + + + Pitch of roof ?/12 + + + + + + + + + + + + + + + + + + + + + + + + + + + + [sq.ft.] + + + + + + [deg] + + + + + [ft] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [in] Thickness of the entire wall assembly, including any siding, sheathing, continuous insulation, and interior finish. + + + + + [sq.ft.] Gross wall area + + + + + + [deg] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [ft] Total length of foundation wall + + + + + [ft] Total height in feet of foundation wall + + + + + [sq.ft.] + + + + + + [deg] + + + + + [in] Thickness of the foundation wall structural element (e.g., concrete), excluding any interior framing and continuous insulation. + + + + + [ft] Depth below grade of foundation wall + + + + + If this foundation wall is adjacent to another foundation, use this reference to indicate which one. + + + + + + + + + + + + + + + + + + + + Use the Floor element for all floors/ceilings. For example, living space ceilings/attic floors, floors above foundations, floors under bonus + rooms, cantilevered floors, etc. + + + + + + + + + + From the perspective of the living/conditioned space. + + + + + + + + + [sq.ft.] + + + + + + + + + + + + + + + + + + + Use the Slab element for all horizontal surfaces adjacent to the ground. + + + + + + + + + [sq.ft.] Area of the slab + + + + + [in] Thickness of the foundation slab structural element (e.g., concrete), excluding any floor coverings and continuous insulation. + + + + + [ft] Length of slab perimeter. + + + + + [ft] Perimeter of the slab exposed to ambient conditions + + + + + [ft] Perimeter of slab measured in feet that is on-grade (2 ft. below grade or less) and exposed to ambient conditions. + + + + + [ft] Depth from the top of the slab surface to grade + + + + + + + + + + + + + + + + + + + + The Window element can be used to describe a single window or a group of windows with the same characteristics. For a group of windows, use the sum of + the window areas in the Area subelement. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The Skylight element can be used to describe a single skylight or a group of skylights with the same characteristics. For a group of skylights, use + the sum of the skylight areas in the Area subelement. + + + + + + + + Pitch of skylight ?/12 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [sq.ft.] Total door surface area for this group of doors + + + + + [deg] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Use these to reference which heating, cooling, or heat pump are the primary systems. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + describe + + + + + + + + + [sq.ft.] Conditioned floor area that this distribution system serves. + + + + + For software that does not calculate an annual distribution system efficiency (DSE) for heating, the DSE may be approximated by equation 3.4.i in ANSI/BPI-2400-S-2012: Standard Practice for Standardized Qualification of Whole-House Energy Savings, Predictions by Calibration to Energy Use History. Enter values as a fractional number between 0 and 1, i.e. 80% = 0.8 + + + + + For software that does not calculate an annual distribution system efficiency (DSE) for cooling, the DSE may be approximated by equation 3.4.i in ANSI/BPI-2400-S-2012: Standard Practice for Standardized Qualification of Whole-House Energy Savings, Predictions by Calibration to Energy Use History. Enter values as a fractional number between 0 and 1, i.e. 80% = 0.8 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Number of similar ventilation fans (e.g., bath fans). + + + + + + Relevant when FanType="central fan integrated supply". + + + + + + Has controls to block the flow of outside air when the CFIS system is not ventilating. For example, an electronically-controlled mechanical damper, or an in-line fan that substantially blocks the flow when not running. + + + + + Describes if/how the CFIS system provides additional ventilation beyond when the HVAC system is running to meet a given ventilation target. + + + + + When AdditionalRuntimeOperatingMode="supplemental fan", specifies the VentilationFan that serves as that supplemental fan. + + + + + + + + + [CFM] as rated by manufacturer + + + + + [CFM] as calculated using duct size, prescriptive approach + + + + + [CFM] as tested by assessor/auditor/inspector + + + + + 24 = continuous, less than 24 = intermittent + + + + + [CFM] + + + + + + + + + + + + [sones] from manufacturer's info + + + + + [sones] as tested in field + + + + + The net total energy (sensible plus latent, also called enthalpy) recovered by the supply airstream adjusted by electric + consumption, case heat loss or heat gain, air leakage and airflow mass imbalance between the two airstreams, as a percent of the potential + total energy that could be recovered plus the exhaust fan energy. Values for some products can be found at the Home Ventilating Institute + (hvi.org). + + + + + The net sensible energy recovered by the supply airstream as adjusted by electric consumption, case heat loss or heat gain, + air leakage, airflow mass imbalance between the two airstreams and the energy used for defrost (when running the Very Low Temperature Test), + as a percent of the potential sensible energy that could be recovered plus the exhaust fan energy. Values for some products can be found at + the Home Ventilating Institute (hvi.org). + + + + + The net total energy (sensible plus latent, also called enthalpy) recovered by the supply airstream adjusted by case heat loss + or heat gain, air leakage and airflow mass imbalance between the two airstreams, as a percent of the potential total energy that could be + recovered. This value is used to predict and compare Cooling Season Performance for the HRV/ERV unit. This value should be used for energy + modeling when wattage for air movement is separately accounted for in the energy model. Values for some products can be found at the Home + Ventilating Institute (hvi.org). + + + + + The net sensible energy recovered by the supply airstream as adjusted by case heat loss or heat gain, air leakage, airflow + mass imbalance between the two airstreams and the energy used for defrost (when running the Very Low Temperature Test), as a percent of the + potential sensible energy that could be recovered. This value should be used for energy modeling when wattage for air movement is separately + accounted for in the energy model. Values for some products can be found at the Home Ventilating Institute (hvi.org). + + + + + [W] + + + + + + For central fan integrated supply mechanical ventilation, specifies the HVAC distribution system it is attached + to. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A multiplier on the performance of the system. A value of 1 implies no performance adjustment. + + + + + + [gal] Nominal capacity + + + + + [gal] Measured capacity + + + + + + [Btuh] + + + + + The amount of energy delivered as heated water in a day divided by the total daily energy consumption of a residential water heater, as + determined following standardized DOE testing procedure. + + + + + DOE’s new metric for communicating the energy efficiency of a residential water heater, which replaces the Energy Factor (EF) metric. More + efficient water heaters have a higher Uniform Energy Factor (UEF). UEF is determined by the Department of Energy’s test method outlined in 10 CFR Part + 430, Subpart B, Appendix E. + + + + + The dimensionless coefficient of performance, used to measure the efficiency of a commercial heat pump water heater. + + + + + [gal per hour] An estimate of the maximum volume of hot water in gallons that a storage water heater can supply within an hour that begins + with the water heater fully heated. + + + + + A water heater's usage bin is derived from its First Hour Rating (FHR) as part of the Uniform Energy Factor (UEF) testing procedures. + + + + + [gal per minute] The amount of gallons per minute of hot water that can be supplied by an instantaneous water heater while maintaining a + nominal temperature rise of 77°F during steady state operation. + + + + + The ratio of energy delivered to heat cold water compared to the energy consumed by the water heater, as determined following standardized + DOE testing procedure. + + + + + + + + + + + + + + [in] + + + + + + + + + + Refers to the insulation in the tank wall itself. This information is sometimes available on the water heater's name plate or + the units specification sheet, or can be estimated by removing the water heater's access plate. + + + + + + + + [in] + + + + + + + + + + + + + + The standby heat loss rate for, e.g., indirect or commercial water heaters. Published in the AHRI Consumer’s Directory of Certified Efficiency Ratings. + + + + + + [deg F] + + + + + + Indicates whether this water heater uses a desuperheater. The attached heat pump or air conditioner can be referenced in the + RelatedHVACSystem element. + + + + + + + + + + + Reference a HeatingSystem, HeatPump, or CoolingSystem. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The water heating system that this distribution system serves. + + + + + + + + + + + Measured length of hot water piping from the hot water heater to the farthest hot water fixture, measured + longitudinally from plans, assuming the hot water piping does not run diagonally, plus 10 feet of piping for each floor level, + plus 5 feet of piping for unconditioned basements. [ft] + + + + + + + + + + + + + + Hot water recirculation loop piping length including both supply and return sides of the loop, measured + longitudinally from plans, assuming the hot water piping does not run diagonally. [ft] + + + + + Length of the branch hot water piping from the recirculation loop to the farthest hot water fixture from the + recirculation loop, measured longitudinally from plans, assuming the branch hot water piping does not run diagonally, plus 20 + feet of piping for each floor level greater than one plus 10 feet of piping for unconditioned basements. [ft] + + + + + [W] + + + + + + + + + + + + + + + + + + + + Efficiency percent expressed as a fraction from 0-1. + + + + + + + + + + + + + + + + + + + + + + + + Number of similar water fixtures. + + + + + [gallons per minute] flow rate of water + + + + + Is the fixture considered low-flow? + + + + + Does this faucet have an aerator? + + + + + [minutes] Number of minutes per day a water fixture operates. + + + + + Does the shower have a device that restricts the flow of water automatically once it has reached temperature? + + + + + Independent organization has verified that product or appliance meets or exceeds the standard in question. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [sq.ft.] + + + + + + + + + [deg] + + + + + [Btu/h-ft^2-F] Often referred to as Fr-tau-alpha (FRta), this describes the optical efficiency portion of the overall collector efficiency. + In the OG-100 SRCC Certified Solar Thermal Collector Directory, this is the y-intercept of the efficiency curve. + + + + + Often referred to as Fr-Ul (FRUl), this describes the collector thermal losses portion of the overall collector efficiency. In the OG-100 + SRCC Certified Solar Thermal Collector Directory, this is the slope of the efficiency curve. + + + + + [gal] + + + + + + The Solar Fraction is the portion of the total conventional hot water heating load (delivered energy and tank standby losses). The higher + the solar fraction, the greater the solar contribution to water heating, which reduces the energy required by the backup water heater. This value can be + found in the OG-300 SRCC Certified Solar Water Heating System Directory. + + + + + The Solar Energy Factor is defined as the energy delivered by the system divided by the electrical or gas energy put into the system. The + higher the number, the more energy efficient. This value can be found in the OG-300 SRCC Certified Solar Water Heating System + Directory. + + + + + + + + + + + + + + + + + + + + + + + + + + + [deg] + + + + + [deg] + + + + + [DC Watts] Peak power as supplied by the manufacturer + + + + + [sq.ft.] + + + + + + System losses can be due to soiling, shading, snow, mismatch, wiring, electrical connections, light-induced degradation, nameplate rating + inaccuracies, age, and availability. + + + + + + + [kWh] Projected Annual Output for a typical meteorological year as determined by PVWatts or similar. + + + + + [$] The LCOE is the total cost of installing and operating a project expressed in dollars per kilowatt-hour of electricity generated by + the system over its life. Can be calculated with System Advisor Model, a similar software, or through a simplified calculation at + http://www.nrel.gov/analysis/tech_lcoe.html. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Number of similar batteries. + + + + + + Has the ability to feed electricity back on to the grid. + + + + + + + The total energy available when the battery is discharged starting from 100% state of charge until it reaches the cut-off voltage. + + + + + The stored energy that can actually be used. In most cases usable capacity is less than the nominal capacity. + + + + + [W] The amount of power the battery typically generates under non-peak conditions. + + + + + [W] The peak power that the battery can generate for a short period of time. + + + + + [V] The nominal voltage is the battery voltage when the state of charge is 0.5 (midway between being fully charged, and fully discharged) + with a 0.2C discharge current. + + + + + Not all the power that is used to charge the battery is available during discharge. Round trip efficiency is the ratio of the energy put + in to the energy retrieved from storage. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [V] Voltage of the AC power source + + + + + [A] Max current to electric vehicle + + + + + [W] Maximum charging rate + + + + + [W] Power used by charger when vehicle is not charging + + + + + + + + + + + + + + + + + + + + + + + + [kWh] the calculated total energy that would be produced during a one-year period with an average wind speed of 5 m/s (11.2 + mph) + + + + + [dBA] the sound pressure level not exceeded by the wind turbine 95% of the time at a distance of 60 meters from the rotor with an average + wind speed of 5 m/s (11.2 mph). + + + + + [kW] the wind turbine’s power output at 11 m/s (24.6 mph). Manufacturers may still describe or name their wind turbine models using a + nominal power (e.g. 5 kW S-343). + + + + + [kW] the highest point on the certified power curve. + + + + + [ft] + + + + + [ft] + + + + + [$] The LCOE is the total cost of installing and operating a project expressed in dollars per kilowatt-hour of electricity generated by + the system over its life. Can be calculated with System Advisor Model, a similar software, or through a simplified calculation at + http://www.nrel.gov/analysis/tech_lcoe.html. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Light units of the same type. For example you could have all the 60W incandescents. + + + + + + + + The LightingFixture that this is attached to + + + + + + + + The fraction of lighting units in the specified Location, where all the fractions for the Location sum to 1. If a Location is not specified, fractions + apply to the entire building. + + + + + + Lumens is a measure of light output (brightness) as opposed to watts, which measures energy consumption. The EPA and DOE encourages people to + determine the amount of light they need (or brightness) first before purchasing a light bulb. Once brightness is determined, you can look for the bulb with the + lowest watts. + + + + + [W] per unit + + + + + + [h] + + + + + [h] + + + + + [sq.ft.] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [CFM] + + + + + [CFM/watt] The efficiency rating of a ceiling fan as determined by the test procedure defined by the Environmental Protection Agency's + ENERGY STAR Testing Facility Guidance Manual: Building a Testing Facility and Performing the Solid State Test Method for ENERGY STAR Qualified Ceiling + Fans, Version 1.1, December 9, 2002. This is generally printed on the box in which the ceiling fan is shipped. + + + + + + + + + + Number of similar ceiling fans. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates if the pool is above or below ground. + + + + + [gal] Volume of pool. + + + + + Months per year pool is in operation. + + + + + [in] + + + + + [in] + + + + + Type of filter used, if any. + + + + + + + + Pool pump: a mechanical assembly consisting of a “wet-end,” which houses the impeller and a motor. The pump increases the “head” and + “flow” of the water (ENERGY STAR, 2013). + + + + + + + + + Manufacturer of pool pump. + + + + + Serial number of pool pump. + + + + + Model number of pool pump. + + + + + Independent organization has verified that product or appliance meets or exceeds the standard in question (ENERGY STAR, CEE, + or other) + + + + + [gal/Wh] The measure of overall pool filter pump efficiency in units of gallons per watt-hour, as determined using the + applicable test method in Section 4.1.2. Energy factor is analogous to other energy factors such as miles per gallon. Energy factor (EF) is + calculated as: EF (gal/Wh) = flow rate (gpm) * 60 ÷ power (watts) (ANSI/APSP/ICC-15 2011). + + + + + The speed setting at which the Energy Factor was measured (ENERGY STAR, 2013). + + + + + The motor power output designed by the manufacturer for a rated RPM, voltage and frequency. May be less than total horsepower + where the service factor is greater than 1.0, or equal to total horsepower where the service factor = 1.0 (ANSI/APSP/ICC-15 + 2011). + + + + + The total horsepower, or product of the rated horsepower and the service factor of a motor used on a pool pump (also known as + SFHP) based on the maximum continuous duty motor power output rating allowable for the nameplate ambient rating and motor insulation class + (e.g., total horsepower = rated horsepower * service factor) (ANSI/APSP/ICC-15 2011). + + + + + A multiplier applied to the rated horsepower of a pump motor to indicate the percent above nameplate horsepower at which the + motor can operate continuously without exceeding its allowable insulation class temperature limit, provided that other design parameters, + such rated voltage, frequency and ambient temperature, are within limits. A 1.5 hp pump with a 1.65 service factor produces 2.475 hp (total + horsepower) at the maximum service factor point (ANSI/APSP/ICC-15 2011). + + + + + + + + [W] + + + + + [Rev/min] The number of revolutions of the motor shaft in a given unit of time, expressed as revolutions per + minute (RPM) (ENERGY STAR, 2013). + + + + + [gal/min] The volume of water flowing through the filtration system in a given time, usually measured in gallons + per minute (gpm) (ANSI/APSP/ICC-15 2011). + + + + + [hours] Number of hours per day a pool pump operates at a particular speed setting. + + + + + + + + + + + + + + + + + + + + + + + + Type of pool cleaner used, if any. + + + + + Hours per day pool cleaner is used. + + + + + + + + + + + + + + + Type of heater used to heat pool, if any. + + + + + Hours per day pool heater is used. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Pulled from industry standards by users (e.g. BPI Gold Sheet) or via software program + + + + + Baseline pressure is read under the following conditions: no items running, all fans off, all exterior doors closed, and all interior + doors are opened. + + + + + The poor case CAZ depressurization test is configured by determining the largest combustion appliance zone depressurization attainable at + the time of testing due to the combined effects of door position, exhaust appliance operation, and air handler fan operation. A base pressure must be + measured with all fans off and doors open. The poor case CAZ depressurization measurement is the pressure difference between the largest + depressurization attained at the time of testing and the base pressure. + + + + + With respect to the baseline pressure (e.g. no fans running, all exterior doors closed, and all interior doors opened) + + + + + + parts per million (ppm) + + + + + + + + + The ID of the system tested + + + + + + + + [deg F] + + + + + [Pa] + + + + + + + + + + + + + + [seconds] + + + + + + + + + + + + + + [ppm] + + + + + + + + Monitored throughout assessment, not just appliance testing + + + + + BPI Gold Sheet is one example that shows action levels based upon decision logic + + + + + + + + + + + [deg F] after 10 minutes run time + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + For a home built before 1978, did the contracted scope of work disturb greater than 6 sq.ft. of interior painted surfaces? + + + + + For a home built before 1978, did the contracted scope of work disturb greater than 20 sf of exterior painted surfaces? + + + + + Did the contracted scope of work include window replacement? + + + + + Certification Number of the EPA Lead-Safe Certified firm that performed the work. + + + + + + + + + + + + + + + + + + + + + in pCi/L + + + + + + + + + + + Was the homeowner provided with educational material? + + + + + + If moisture management of a crawlspace (e.g., installation of polyethylene sheeting) or radon mitigation measures were a part of the scope of + work,were measures installed to be compliant with one of the following: - Specifications of EPA’s Indoor airPLUS program - Techniques detailed in EPA's + Radon-Resistant New Construction - ASTM E2121, Standard Practice for Installing Radon Mitigation Systems in Existing Low-Rise Residential Buildings (section + 7.3) + + + + + Was the result less than 4 pCi/L + + + + + + + + + + + + + Are there unvented combustion heating or hearth appliances present in the living area? + + + + + If yes, does the appliance conform with ANSI Z21.11.2? + + + + + If yes, is the appliance used as a primary source of heating? + + + + + Does home have attached garage? + + + + + If yes, is there a continuous air barrier between garage and living space? + + + + + If yes, is there an exhaust fan in garage? + + + + + + + + + + + + + Indications of pest entry or damage? + + + + + Evidence of pesticide, insecticide use? + + + + + Do measures comply with industry standards to prevent pest entry? NOTE: This is for ALL measures that may create entry points for vermin. For example, + air sealing measures identified to reduce infiltration should have proper sealants - even if those measures were not recommended/installed for pest control + purposes. + + + + + + + + + + + + + Was asbestos suspected? + + + + + Was substance tested for asbestos? + + + + + Was asbestos found? + + + + + + + + + + + + + + + + Was spray foam polyurethane foam and / or other potential sources of indoor pollutants installed or applied as part of the scope of + work? + + + + + + + + + + + + + + + + + This element is formerly known as "spillage, draft, and CO readings under natural conditions" as explained in BPI's Gold Sheet "Combustion Safety Test Procedure + for Vented Appliances." + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [Pa] + + + + + + + + + + + + + + If yes, was this installed as part of scope of work? + + + + + + + + + + + + + If no, was this recommended in scope of work? + + + + + + + + + + + + + + + + + + + + + + + + + ASHRAE 62.2-2010 has an infiltration credit. ASHRAE 62-89 and 62.2-2013 do not have infiltration credits. + + + + + + + This is just the # of the calculated infiltration credit. + + + + + + This is the net amount of continuous ventilation needed AFTER infiltration credit is applied (if any) + + + + + + + + + + + + + + + + This is amount without taking into consideration any infiltration credit + + + + + This is amount without taking into consideration any infiltration credit + + + + + Should be 20 cfm, if the local AHJ permits windows to be used for local exhaust + + + + + This is the net amount of continuous ventilation needed AFTER window credit is applied (if any) + + + + + This is the net amount of continuous ventilation needed AFTER window credit is applied (if any) + + + + + The airflow deficit for each bathroom or kitchen is the required airflow less the airflow rating of the exhaust equipment. If there is no exhaust device or if the + existing device cannot be measured nor read it, the exhaust device airflow is assumed to be zero. + + + + + + + + + + + + + Does a proper air barrier separate the house from the garage? + + + + + Are ducts and air handlers located in the garage properly air sealed? + + + + + Is the clothes dryer properly vented? + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + should be represented as a fraction (ie 0.5 instead of 50%) + + + + + + + + + + + + + Energy use will be negative for energy producing end uses such as PV and SolarThermal. + + + + + + + + + + + + + + + + + + + + + + + + + + + A multiplier on the performance of the system. A value of 1 implies no performance adjustment. + + + + + + + + + + + + + + Air sealing and insulation implemented prior to replacement and used in calculations for sizing new / replacement system? + + + + + + + + + + + + + + + + + + + + + + + + + + + + [Btuh] Input Heating Capacity + + + + + [Btuh] Output Heating Capacity + + + + + + + [sq.ft.] + + + + + The average annual auxiliary electrical energy consumption for, e.g., a gas furnace or boiler, in kilowatt-hours per year. Published in the AHRI + Consumer’s Directory of Certified Efficiency Ratings. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [grams per hour] from EPA label http://www.epa.gov/compliance/monitoring/programs/caa/woodheaters.html + + + + + + + + + + + + + + + + [grams per hour] from EPA label http://www.epa.gov/compliance/monitoring/programs/caa/woodheaters.html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [Btuh] Output heating capacity; typically the nameplate capacity at 47F. + + + + + [Btuh] Output heating capacity at 17F from AHRI database. + + + + + [Btuh] Output cooling capacity + + + + + + [deg F] Temperature below which the compressor is disabled, often to prevent damage or occupant comfort issues. The default is the manufacturer's minimum operating temperature, but the value may be set higher. For a duel-fuel heat pump, use the BackupHeatingSwitchoverTemperature element. + + + + + + + Whether the heat pump backup is integrated into the unit (describe in BackupSystemFuel, BackupAnnualHeatingEfficiency, BackupHeatingCapacity), or a + separate heating system (add reference in BackupSystem). + + + + + References the HeatingSystem that provides the backup for a separate backup. + + + + + + + [Btuh] Input heating capacity + + + + + [Btuh] Output heating capacity + + + + + [deg F] Temperature at which the backup heating is activated and the compressor is disabled in, e.g., a dual-fuel heat pump. + + + + + [deg F] Temperature above which the backup heating is disabled, often to prevent backup heating usage during recovery from a thermostat heating setback. For a duel-fuel heat pump, use the BackupHeatingSwitchoverTemperature element. + + + + + + + [sq.ft.] + + + + + + + + + + + + + + + + + + [Btuh] Output cooling capacity + + + + + + + [sq.ft.] + + + + + + + + + + + + + + + + + + + + + For AFUE and Percent enter values as a fractional number between 0 and 1, i.e. 80% = 0.8 + + + + + + + + + + + + Ah is computed by multiplying the discharge current (Amps) by the discharge time (hours). kWh is computed by multiplying the power output (kW) by the discharge time (hours). + + + + + + + + + + For %/hr enter values as a fraction, i.e. 1.20%/hr = 0.0120 and 0.68%/hr = 0.0068. + + + + + + + + + + + + + [in] + + + + + [ft] + + + + + + + [degF] + + + + + [degF] + + + + + + + + System Pump and Zone Valve Corrections made + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [in] + + + + + + + If a DuctType of supply or return is specified above, this is the fraction of the supply or return duct area. If DuctType is omitted above, this is + the fraction of the total duct area. + + + + + [sq.ft.] + + + + + + + + + + + + + + + + + + + + + + + + HPXML records may contain data about an individual, either a person, or a business. This element contains the root elements for individual identifier values between a + sending and a receiving system. + + + + + + + + + + + + System identifiers contain type codes and an identifier for both a sending and a receiving system. These fields are needed to be able to transmit data between two + systems, and have it identified in the two systems. + + + + + + + + + + + + + + + + + Overall characterization of building for descriptive, rather than modeling purposes + + + + + + + + + + If the building is attached to other units in the horizontal plane. + + + + + If the building is attached to other units on the vertical plane. + + + + + + + + + + + [ft] + + + + + [ft] + + + + + [ft] + + + + + + + + + + + Fuels available on site via utility lines/pipes or delivery. + + + + + + + + + + + + + + + + + + + + The year the current occupants moved into the building + + + + + + + + 18 or older + + + + + less than 18 years old + + + + + + + Percentage as a fraction (50% = 0.5) + + + + + AMI = Area Median Income; FPL = Federal Poverty Level + + + + + + + + + + + + + + + + + + Passive solar design—also known as climatic design—involves using a building's windows, walls, and floors to collect, store, and + distribute solar energy in the form of heat in the winter and reject solar heat in the summer. (source: + http://www.eere.energy.gov/basics/buildings/passive_solar_design.html) + + + + + [ft] height of building + + + + + Number of dwelling units represented by the HPXML Building element. Used as a multiplier. + + + + + Total number of dwelling units in the physical building. + + + + + Total number of floors including a basement, whether conditioned or unconditioned + + + + + Number of floors that are heated/cooled including a basement + + + + + Number of floors above grade that are heated/cooled + + + + + [ft] Average distance from the floor to the ceiling + + + + + [ft] distance between floors + + + + + + + + Number of bathrooms with a tub or shower + + + + + [sq.ft.] + + + + + + [sq.ft.] Gross floor area (based on ASHRAE definition) is the sum of the floor areas of the spaces within the building, including + basements, mezzanine and intermediate‐floored tiers, and penthouses with headroom height of 7.5 ft (2.2 meters) or greater. Measurements must be taken + from the exterior faces of exterior walls OR from the centerline of walls separating buildings, OR from the centerline of walls separating spaces. + Excludes non‐enclosed (or non‐enclosable) roofed‐over areas such as exterior covered walkways, porches, terraces or steps, roof overhangs, and similar + features. Excludes air shafts, pipe trenches, and chimneys. Excludes floor area dedicated to the parking and circulation of motor + vehicles. + + + + + [sq.ft.] The floor area of an occupiable space defined by the inside surfaces of its walls but excluding shafts, column enclosures, and + other permanently enclosed, inaccessible, and unoccupiable areas. Obstructions in the space such as furnishings, display or storage racks, and other + obstructions, whether temporary or permanent, may not be deducted from the space are considered to be part of the net occupiable + area. + + + + + [sq.ft.] All finished space that is within the (insulated) conditioned space boundary (that is, within the insulated envelope), regardless + of HVAC configuration. + + + + + [sq.ft.] Floor area of home that is finished and assumed to be occupied. + + + + + + [sq.ft.] The total area of all enclosed spaces measured to the internal face of the external walls. Included are areas of sloping surfaces + such as staircases, galleries, raked auditoria, and tiered terraces where the area taken is from the area on the plan. Excluded are areas that are not + enclosed such as open floors, covered ways and balconies. + + + + + [sq.ft.] The total area of all enclosed spaces measured to the internal face of the external walls. Included are areas of sloping surfaces + such as staircases, galleries, raked auditoria, and tiered terraces where the area taken is from the area on the plan. Excluded are areas that are not + enclosed such as open floors, covered ways and balconies. + + + + + [sq.ft.] An enclosed space within a building that does not meet the requirements of a conditioned space. Spaces that have no control over + thermal conditions but intentionally or unintentionally receive thermal energy from adjacent spaces are considered unconditioned spaces (such as an + attached garage on a house or a vestibule with no thermal comfort criteria). Spaces that are ventilated only to maintain air quality are considered + unconditioned spaces (such as a parking garage with no thermal comfort criteria). + + + + + [cu.ft.] A volume of a building surrounded by solid surfaces such as walls, roofs, floors, fenestration, and doors where the total opening + area to the outside can be reduced to less than 1% of the Gross Interior Floor Area of the space. Spaces that are temporarily enclosed such as patios + enclosed with tenting are not considered Enclosed Spaces for annual building analysis. These spaces should be treated as exterior to the + building. + + + + + [cu.ft.] Volume inside the building envelope of the conditioned spaces. This metric can be calculated as the volume of the building if + every space is conditioned or on a floor-by-floor basis. For spaces with vertical walls and horizontal ceilings and floors, this is calculated as the + Gross Conditioned Floor Area times the height from the top surface of the finished floor to the top surface of the finished floor separating levels of + the building or to the inside surface of the roof for the top floor. The volume of spaces that have nonvertical walls or nonhorizontal ceilings of + floors should be calculated separately to properly account for the non-rectangular geometry. This metric does include the volume of floor or ceiling + return air plenums. + + + + + Primary foundation type of building + + + + + Primary attic type of building + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Weather location used in model simulation and/or utility bill regression analysis + + + + + + + + + + A listing of Green Building Verifications from the RESO Data Dictionary + + + + + + + + + + The name of the verification or certification awarded to a new or pre-existing residential or commercial structure. For example: LEED, + Energy Star, ICC-700. In cases where more than one certification have been awarded, leverage multiple iterations of the green verification fields via + the repeating element method. + + + + + If "other" is selected for GreenBuildingVerification/Type, fill in type here. + + + + + The name of the body or group providing the verification/certification/rating named in the GreenBuildingVerificationType field. There is + almost always a direct correlation between bodies and programs. + + + + + A final score indicating the performance of energy efficiency design and measures in the home as tested by a third-party rater. Points + achieved to earn a certification in the GreenVerificationRating field do not apply to this field. HERS Index is most common with new homes and runs with + a lower number being more efficient. A net-zero home uses zero energy and has a HERS score of 0. A home that produces more energy than it uses has a + negative score. Home Energy Score is a tool more common for existing homes and runs with a higher number being more efficient. It takes square footage + into account and caps with 10 as the highest number of points. + + + + + Many verifications or certifications have a rating system that provides an indication of the structure's level of energy efficiency. When + expressed in a numeric value, please use the GreenVerificationMetric field. Verifications and Certifications can also be a name, such as Gold or Silver, + which is the purpose of this field. + + + + + The source of the green data. May address photovoltaic characteristics, or a verified score, certification, label, etc. This may be a pick + list of options showing the source. i.e. Program Sponsor, Program Verifier, Public Record, Assessor, etc. + + + + + Many verification programs include a multi-step process that may begin with plans and specs, involve testing and/or submission of building + specifications along the way and include a final verification step. When ratings are involved it is not uncommon for the final rating to be either + higher or lower than the target preliminary rating. Sometimes the final approval is not available until after sale and occupancy. Status indicates what + the target was at the time of listing and may be updated when verification is complete. To limit liability concerns this field reflects information that + was available at the time of listing or updated later and should be confirmed by the buyer. + + + + + Provides a link to the specific property’s high-performance rating or scoring details directly from and hosted by the sponsoring body of + the program. Typically provides thorough details, for example, which points where achieved and how, or in the case of a score what specifically was + tested and the results. + + + + + The version of the certification or verification that was awarded. Some rating programs have a year, a version, or possibly + both. + + + + + The year the certification or verification was awarded. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Start date of project + + + + + Estimated completion date of project + + + + + Actual completion date of project + + + + + Amount of time spent by contractor on this stage of the project + + + + + Cost of any fees associated with the audit or other project activities + + + + + Cost of all work proposed or performed + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + These are the system identifiers for a specific measure on a job + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A load profile is created using measurements of a customer's electricity use at regular intervals, typically one hour or less, and + provides an accurate representation of a customer's usage pattern over time. + + + + + + + + + + + + + + + + + + + + + + + Quality assurance: The observation techniques and activities used externally by an organization to evaluate the effectiveness of their quality management system + and to provide feedback that may result in quality improvements (BPI, 2006). + + + + + + + + + + + + + or removed component + + + + + + + + + + + + + + + + + + + + + + + + + Indicates whether it is measured energy savings or estimated energy savings. + + + + + + + [kW] Demand savings from energy efficiency programs + + + + + should be represented as a fraction (ie 0.5 instead of 50%) + + + + + + + + + + + + + + + should be represented as a fraction (ie 0.5 instead of 50%) + + + + + + + + + + + + + + + + + + + For Percent enter values as a fractional number, i.e. 30% = 0.3 + + + + + + + + + + + The Leakage Area is defined in TECBLAST as the size of a sharp edged orifice which would leak at the same flow rate as the measured leakage, if the orifice were + subjected to the Test Pressure. Leakage Area [sq in] = Duct System Leakage Rate [CFM] / (1.06 * (Test Pressure [Pa]) ^ 0.5) + + + + + + + + + + + + + + Consumption records with enough granularity to be able to use smart meter data. + + + + + + Negative number for renewable generation. Positive number for consumption. + + + + + Date/time stamp in the ISO 8601 format when the usage measured began. + + + + + Date/time stamp of the meter reading. + + + + + + + + + + + + + Baseload power is the energy consumed for the day-to-day operation of a home that is not used as a response to outside weather (i.e. excludes heating and cooling) + (Krigger and Dorsi, 2009). + + + + + The following fields are to support BPI-2400 + + + + + + + + + + + + + This identifies which data quality requirements (if any) were met by the bills for the relevant energy source and therefore which calibration metrics (if any) are + used to determine whether the calibrated model is accepted. + + + + + Detailed Calibration Weather Regression CV-RMSE. Eqn. 3.2.2.G.i of BPI-2400. Percentage expressed as a fraction (ie 10% = 0.1) + + + + + Weather Normalized Annual Heating Usage + + + + + Weather Normalized Annual Cooling Usage + + + + + Weather Normalized Annual Baseload Usage + + + + + Eqn. 3.2.3.A.i of BPI-2400. Percentage expressed as a fraction (ie 10% = 0.1) + + + + + Eqn. 3.2.3.A.ii of BPI-2400. In either kWh for electricity or MBtu (million Btu) for all other fuels. + + + + + Percentage expressed as a fraction (ie 10% = 0.1) + + + + + In either kWh for electricity or MBtu (million Btu) for all other fuels. + + + + + Percentage expressed as a fraction (ie 10% = 0.1) + + + + + In either kWh for electricity or MBtu (million Btu) for all other fuels. + + + + + Used to determine model calibration acceptance when bills fail Detailed criteria, but meet simple criteria. Percentage expressed as a fraction (ie 10% = + 0.1) + + + + + Used to determine model calibration acceptance when bills fail Detailed criteria, but meet simple criteria. Percentage expressed as a fraction (ie 10% = + 0.1) + + + + + Used to determine model calibration acceptance when bills fail Detailed criteria, but meet simple criteria. Percentage expressed as a fraction (ie 10% = + 0.1) + + + + + Used to determine model calibration acceptance when bills fail Detailed criteria, but meet simple criteria. Percentage expressed as a fraction (ie 10% = + 0.1) + + + + + + + + + + + + + + Energy Type + + + + + + direct metering = tenants directly metered; master meter without sub-metering = tenants not sub metered; master meter with sub-metering = tenant + sub-metered by building owner + + + + + + + + + + + + + + + + + + + + + + + + + + [$/energy unit] The cost of providing an additional unit of output + + + + + [kBtu/ft^2] Energy use intensity (EUI) is a unit of measurement that describes a building's energy use. EUI represents the energy consumed by a + building relative to its size. + + + + + Period during which electrical power is expected to be provided at a significantly higher than average supply level. + + + + + + + + + + + + + + + + Water use intensity is defined as annual water use divided by total gross square footage of facility space reported in gallons per square foot (DOE, + 2013). This element may also be reported as gallons, per day, per person. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Baseload power is the energy consumed for the day-to-day operation of a home that is not used as a response to outside weather (i.e. excludes heating and cooling) + (Krigger and Dorsi, 2009). + + + + + + + + + + + + Type of stud, joist, etc. (2x4, 2x6, etc) + + + + + [in] Spacing on center + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [sq.ft.] Total window surface area for this group of windows + + + + + Number of windows in the group + + + + + [deg] + + + + + + + + + + + + + + + + + + + + Shading coefficients are defined as a multiplier on transmittance: 1 is transparent, 0 is opaque. + + + + + + + + + + + + + + + The shading coefficient to apply during the summer months. Shading coefficients are defined as a multiplier on transmittance: 1 is transparent, 0 is + opaque. + + + + + The shading coefficient to apply during the winter months. Shading coefficients are defined as a multiplier on transmittance: 1 is transparent, 0 is + opaque. + + + + + + + + + + Used to describe drapes, blinds, etc. If moveable insulation also provides shading, the shading should be documented here. + + + + + + + + The shading coefficient to apply during the summer months. Shading coefficients are defined as a multiplier on transmittance: 1 is transparent, 0 is + opaque. + + + + + The shading coefficient to apply during the winter months. Shading coefficients are defined as a multiplier on transmittance: 1 is transparent, 0 is + opaque. + + + + + + + + + + + + + + + + + + + + + + + + + Rigid opaque foam panels (permanently installed or not) or cellular shades that provide insulation. + + + + + + + + + + + + + + + + [ft] Depth of overhang + + + + + [ft] Vertical distance from overhang to top of window + + + + + [ft] Vertical distance from overhang to bottom of window + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [deg F] + + + + + + + + [Pa] with respect to outside + + + + + [Pa] + + + + + + + + + + + + + + + + [sq.in.] The Effective Leakage Area is defined as the area of a special nozzle-shaped hole (similar to the inlet of a blower door fan) that would leak the same + amount of air as the building does at a pressure of 4 Pascals. + + + + + [sq. ft.] The volume of the building that is applicable to the air infiltration measurement test. The volume can be defined as the conditioned building volume + plus the volume of crawlspaces, attics, and/or basements that are connected to the building's conditioned space via open doors or hatches. + + + + + [ft] Vertical distance between lowest and highest above-grade points within the pressure boundary, per ASHRAE 62.2. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + for single unit retrofits in multifamily properties + + + + + + + + + + + + + + + + + + + For use on sections of the house that are cantilevered or over ambient (outdoor) conditions for some other reason. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Sheathing insulation should be specified in the Insulation element as well. + + + + + Please specify stud spacing and framing factor in the appropriate places as well. + + + + + See https://thecraftsmanblog.com/framing-timber-balloon-platform for a description of different framing types. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [deg F] + + + + + [deg F] + + + + + [hours] + + + + + [deg F] + + + + + [deg F] + + + + + [hours] + + + + + + + + Fraction of rooms controlled by thermostatic radiator valves + + + + + Percent of rooms controlled by electronic zone valves with thermostats + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The year and month the duct system was sealed. + + + + + + + + + + + + + + + Year and month of the last tune and repair for this HVAC equipment. + + + + + + + + + + + Width x Length x Thickness + + + + + + [in] + + + + + [in] + + + + + [in] + + + + + + + + + Minimum efficiency reporting value, commonly known as MERV rating, is a measurement scale designed in 1987 by the American Society of Heating, + Refrigerating and Air-Conditioning Engineers (ASHRAE) to rate the effectiveness of air filters. + + + + + The Year and Month the filter was last replaced. + + + + + + + + + + + + + + + + + + + + [ft] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Emissions and Generation Resource Integrated Database (eGRID) region. + + + + + Emissions and Generation Resource Integrated Database (eGRID) subregion. + + + + + Cambium Generation and Emission Assessment (GEA) region. + + + + + For locations that observe Daylight Savings, use Standard time. + + + + + + For example, US/Eastern for U.S. Eastern Time. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. + + + + + For example, ET for US Eastern Time. + + + + + Positive or negative offset from Coordinated Universal Time (UTC) using Standard Time. For example, -5 for Eastern Time. + + + + + + + + + + + + + + + + + Building Description + + + + + + + + Indicates which weather station is used for the modeling. It's a reference that points to + Building/BuildingDetails/ClimateAndRiskZones/WeatherStation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + If different from building street address. + + + + + + + + + + A list of comments in priority order. + + + + + + + + + + + + + + + + + + + + + + + + + + + Utility company information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [ft] + + + + + + Fraction of total pipe insulated + + + + + + + + + + + [Pa] positive for supply side measurements, negative for return side. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + [in] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + AMI = Area Median Income; FPL = Federal Poverty Level + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Enumerations from http://www.fsec.ucf.edu/en/publications/pdf/FSEC-DN-7-84.pdf + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gives compass direction a surface (window, wall) is facing. Measured in degrees clockwise from North. + + + + + + + + + + + + + + + + MBtu refers to million Btu. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A fraction that has to be between 0 and 1 inclusive + + + + + + + + + + + + + + + + A fraction that can be greater than one (ie 110%) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + By leaving this field empty, the weather station is assumed used for all functions such as utility bill regression analysis and energy model simulations. If different + weather stations are used for the different functions, use this field to specify the usage of each weather station. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The North American Fenestration Standard/Specification for windows, doors and, skylights provides a method for rating the structural performance, water resistance and air leakage of fenestration products. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/merged_schema/README.md b/merged_schema/README.md new file mode 100644 index 00000000..094ac8e6 --- /dev/null +++ b/merged_schema/README.md @@ -0,0 +1 @@ +This schema is automatically generated from the schemas/\*.xsd files. diff --git a/scripts/xsdflatten.py b/scripts/xsdflatten.py new file mode 100644 index 00000000..1adea206 --- /dev/null +++ b/scripts/xsdflatten.py @@ -0,0 +1,68 @@ +#!/usr/bin/env python +import sys +import re +import copy +from lxml import etree + + +def get_includes_from_file(filename): + root = get_xml_tree_from_file(filename) + ns = {"xs": root.nsmap["xs"]} + includes = root.xpath('//xs:include/@schemaLocation', namespaces=ns) + + # sanity check + for inc in includes: + if not inc.endswith('.xsd'): + raise 'Problem including %s in file %s' % (inc, filename) + + return includes + + +def get_includes_recurse(filename, include_set): + includes = get_includes_from_file(filename) + include_set.update(includes) + for inc in includes: + get_includes_recurse(inc, include_set) + + +def get_xml_tree_from_file(filename): + tree = etree.parse(filename) + return tree.getroot() + + +def remove_includes(root): + # Find and remove the includes + includes = root.findall('xs:include', root.nsmap) + for inc in includes: + root.remove(inc) + return root + + +def flatten_file(filename, outfilename): + include_set = set() + get_includes_recurse(filename, include_set) + + # Get the main document + root = get_xml_tree_from_file(filename) + root = remove_includes(root) + + # Merge in the elements of the includes + for inc_file in sorted(include_set): + inc_root = get_xml_tree_from_file(inc_file) + inc_root = remove_includes(inc_root) + # root.append(etree.Comment('Imported from %s' % inc_file)) + for child in inc_root: + root.append(copy.deepcopy(child)) + + # Write to file + with open(outfilename, 'wb') as f: + f.write(etree.tostring(root, pretty_print=True)) + print(f'Wrote output file: {outfilename}.') + + +def main(filename, outfilename): + flatten_file(filename, outfilename) + + +if __name__ == "__main__": + main(sys.argv[1], sys.argv[2]) diff --git a/tests/test_schema.py b/tests/test_schema.py index 8a907da3..2a19486c 100644 --- a/tests/test_schema.py +++ b/tests/test_schema.py @@ -18,4 +18,7 @@ def test_example_file(filename): xmlschema_doc = etree.parse(str(here / '..' / 'schemas' / 'HPXML.xsd')) xmlschema = etree.XMLSchema(xmlschema_doc) doc = etree.parse(str(filename)) - assert xmlschema.validate(doc) + if str(filename).endswith('invalid.xml'): + assert not xmlschema.validate(doc) + else: + assert xmlschema.validate(doc)