Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
85 commits
Select commit Hold shift + click to select a range
81fdb81
Change pier and beam to belly and wing
kloconnell Sep 28, 2023
ce0707a
Change pier and beam to belly and wing
kloconnell Sep 28, 2023
f7ee366
Change pier and beam to belly and wing
kloconnell Sep 28, 2023
448f004
Align attic types
kloconnell Sep 28, 2023
e288293
Align attic types
kloconnell Sep 28, 2023
64f76cd
Align attic types
kloconnell Sep 28, 2023
8ea11c2
Remove attic type comment
kloconnell Sep 28, 2023
1e054df
Add support for HERS heat pump sizing methodology
kloconnell Oct 19, 2023
ed47349
remove occupancyControl no longer supported in OS
kloconnell Oct 19, 2023
5d40e8a
Merge pull request #35 from RadiantLabs/main
kloconnell Oct 20, 2023
b6f7811
Change living space to conditioned space
kloconnell Oct 20, 2023
b3da4ae
Change living space to conditioned space, add support for SEER2,HSPF2
kloconnell Oct 20, 2023
7e04af3
Add support for SEER2, HSPF2, manufactured home belly
kloconnell Oct 20, 2023
b80b339
change living space to conditioned space, add support for manufacture…
kloconnell Oct 20, 2023
861b153
Changed living space to conditioned space
kloconnell Oct 20, 2023
8d890ad
Changed living space to conditioned space
kloconnell Oct 20, 2023
6adfd1e
Changed living space to conditioned space
kloconnell Oct 20, 2023
a6c0d50
Change living space to conditioned space
kloconnell Oct 20, 2023
c8f5264
Changed living space to conditioned space
kloconnell Oct 20, 2023
4d3fba6
Change living space to conditioned space
kloconnell Oct 20, 2023
bbdf151
Fix typo
kloconnell Oct 20, 2023
d8d4723
Fix typo
kloconnell Oct 23, 2023
4b2a152
Adding measure applicability assumptions
kloconnell Jan 22, 2024
1d48b8b
Add propertyUse to baseBuilding
kloconnell Mar 6, 2024
0a0493a
Add propertyUse to buildingSummary table
kloconnell Mar 6, 2024
d21f70e
Add propertyUse to extensive_inputs.json
kloconnell Mar 6, 2024
4d788d6
Add propertyUse to automated_measures_new_heat_pump.json
kloconnell Mar 6, 2024
c8f9b4d
Add propertyUse to extensive_inputs.json
kloconnell Mar 6, 2024
a878367
Add propertyUse to simple_bare_bones.json
kloconnell Mar 6, 2024
592d8e6
Add propertyUse to simple_with_monthly.json
kloconnell Mar 6, 2024
a24705b
Add propertyUse to simple_with_monthly_and_hourly
kloconnell Mar 6, 2024
8387942
Fix quotes
kloconnell Mar 11, 2024
2262ad2
Create EnergyEndUses.json5
kloconnell Mar 26, 2024
eb0e7ee
Add energyEndUses to GlobalControls
kloconnell Mar 26, 2024
467de9a
Add energyEndUses to ResponseModel
kloconnell Mar 26, 2024
478590e
Update EnergyEndUses.json5
kloconnell Mar 26, 2024
b25d9fd
Create EnergyEndUsesPerFuelTimeSeries.json5
kloconnell Mar 26, 2024
d803b24
Add energyEndUses to response_structure
kloconnell Mar 26, 2024
9570f59
Apply existing indentation from project
joshuamzm Mar 26, 2024
d146518
Merge branch 'main' into changes-for-hpxml-gen-v6
kloconnell Apr 15, 2024
7cfc09e
Breaking change: waterHeatingSystems efficiency and efficiencyUnits
kloconnell Apr 15, 2024
99ea661
Breaking change: duct leakageUnits to fraction
kloconnell Apr 15, 2024
6d8b9f0
Breaking change: update water heating efficiency and percent to fraction
kloconnell Apr 15, 2024
057cc62
Breaking change: ductLeakageUnits from percent to fraction
kloconnell Apr 15, 2024
b8a0cce
Breaking change: update ductLeakageUnits, waterHeating efficiency, an…
kloconnell Apr 15, 2024
60f9976
Move api.rst to deprecated folder
kloconnell Apr 16, 2024
11e1147
Move automated_measures.rst to deprecated folder
kloconnell Apr 16, 2024
4fd7ac9
Move modeling_results_resolution.rst to deprecated folder
kloconnell Apr 16, 2024
44ea636
Move extensive_inputs_and_outputs.rst to deprecated folder
kloconnell Apr 16, 2024
d0fda73
Update extensive_inputs example
kloconnell Apr 16, 2024
cd71f5c
Update automated_measures_new_heat_pump.json example
kloconnell Apr 16, 2024
bbe240f
Update extensive_inputs.json example
kloconnell Apr 16, 2024
6b3c7a2
Update simple_bare_bones.json example
kloconnell Apr 16, 2024
1b78503
Update simple_with_monthly.json example
kloconnell Apr 16, 2024
a7089c0
Add files via upload
kloconnell Apr 16, 2024
3371589
Fix cooling system efficiency rating options
kloconnell Apr 23, 2024
b49c38f
Add unit conversions list
kloconnell Apr 23, 2024
ac27d01
Update propertyUse warning language
kloconnell May 14, 2024
6455355
Fix HVAC heat pump table
joshuamzm May 20, 2024
822c556
Fix waterHeating efficiencyUnits default
kloconnell May 20, 2024
8a74c12
Fix waterHeating efficiencyUnits default
kloconnell May 20, 2024
1260a7b
Merge branch 'main' into changes-for-hpxml-gen-v6
kloconnell May 20, 2024
1072d06
Add PSC and BSA definitions
kloconnell May 20, 2024
46a0057
Adding title references to introduction.rst
kloconnell May 20, 2024
0f1cd92
Adding title references to usage.rst
kloconnell May 20, 2024
9dce3f1
Fix double colons
kloconnell May 20, 2024
358e568
Fix double colons
kloconnell May 20, 2024
ff1b695
Merge branch 'changes-for-hpxml-gen-v6' into add-property-use
joshuamzm May 22, 2024
cca04c0
Update request_structure.rst with propertyUse details
joshuamzm May 22, 2024
80f0bfc
Merge pull request #49 from RadiantLabs/add-property-use
joshuamzm May 22, 2024
74f45b2
Merge branch 'changes-for-hpxml-gen-v6' into add-energy-end-use-to-re…
joshuamzm May 22, 2024
47b349b
Merge pull request #52 from RadiantLabs/add-energy-end-use-to-response
joshuamzm May 22, 2024
f848194
Update ducts structure
kloconnell May 23, 2024
93e2e3b
Merge branch 'changes-for-hpxml-gen-v6' of https://github.com/Radiant…
kloconnell May 23, 2024
4e08174
Fix PSC BSA references
kloconnell May 23, 2024
061d65c
Testing different referencing formats
kloconnell May 23, 2024
194a071
More reference testing
kloconnell May 23, 2024
3565330
More reference testing
kloconnell May 23, 2024
3b35aeb
More reference changes
kloconnell May 23, 2024
3aad86d
More reference changes
kloconnell May 23, 2024
a394857
Adjust ducts table definition
kloconnell May 23, 2024
672c9d0
Fix list of unit conversions
joshuamzm Jun 11, 2024
5b57adc
Test :math: role
joshuamzm Jun 11, 2024
6d933bd
Fix exponent
joshuamzm Jun 11, 2024
92d65fb
Apply math role only to the number with exponent
joshuamzm Jun 11, 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
54 changes: 30 additions & 24 deletions docs/source/api.rst → docs/source/deprecated/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,12 @@ Property Type Units Constraints Required Default
``storiesCount`` integer count >0 no PSC, BSA
``windowToWallFraction`` float fraction >0 no 0.14
``yearBuilt`` integer year >1600 no PSC If missing from PSC, model will fail
``propertyUse`` string see [#]_ no PSC Advanced option. See [#]_
======================== ======= ======== =========== ======== ================== ==============================================

.. [#] ``bedroomsCount``/2 + 0.5
.. [#] ``propertyUse`` options are “single-family detached”, “single-family attached”, or “manufactured home”
.. [#] ``propertyUse`` is an advanced field. Overriding the existing property use may produce in abnormal model results. If you set this, we recommend setting square footage as well.

.. _cost:

Expand Down Expand Up @@ -217,18 +220,19 @@ Property Type Units Constraints Required Defa
Attics
~~~~~~

The attic is entered in ``...building.enclosure.attics``. Currently, this array must contain exactly 1 attic object. If there is no attic present in house, set ``area`` to 0.
See note about `objects and arrays`_ for more information.
The attic is entered in ``...building.enclosure.attics``. Currently, this array must contain exactly 1 attic object. See note about `objects and arrays`_ for more information.

================================= ======= ================ ============== ======== ================== ==============================================
Property Type Units Constraints Required Default Notes
================================= ======= ================ ============== ======== ================== ==============================================
``id`` id Must be unique yes Attic1
``area`` float ft2 >0 no PSC
``isVented`` boolean no yes
``floorAssemblyEffectiveRValue`` float F-ft2-hr/Btu >0 no BSA
``id`` id Must be unique yes Attic1
``type`` string see [#]_ no BSA
``area`` float ft2 >0 no PSC Not applicable when ``type`` is "cathedral ceiling" or "flat roof"
``floorAssemblyEffectiveRValue`` float F-ft2-hr/Btu >0 no BSA Not applicable when ``type`` is "cathedral ceiling" or "flat roof"
================================= ======= ================ ============== ======== ================== ==============================================

.. [#] ``type`` options are "attic vented", "attic unvented", "cathedral ceiling", or "flat roof".

Roofs
~~~~~

Expand Down Expand Up @@ -259,7 +263,7 @@ Property Type Units Constraints Re
``wallHeight`` float ft >=0 no PSC
================================= ======= ================ ============== ======== ================== ==============================================

.. [#] ``type`` choices are "basement conditioned", "basement unconditioned", "crawl vented", "crawl unvented", "slab", and "pier and beam".
.. [#] ``type`` choices are "basement conditioned", "basement unconditioned", "crawl vented", "crawl unvented", "slab", and "belly and wing".

Walls
~~~~~
Expand Down Expand Up @@ -365,7 +369,7 @@ Property Type Units Constra
.. [#] If ``systemType`` is "central air conditioner"
.. [#] ``systemType`` choices are "central air conditioner", "room air conditioner", "evaporative cooler", "packaged terminal air conditioner", and "mini-split".
.. [#] ``compressorType`` choices are "single stage", "two stage", and "variable speed".
.. [#] ``coolEfficiencyUnits`` choices are "percent", "EER", "CEER", and "SEER". The option to use "SEER2" is planned for a future release.
.. [#] ``coolEfficiencyUnits`` choices are "fraction", "EER", "CEER", "SEER", and "SEER2".

HVAC Heating Systems
~~~~~~~~~~~~~~~~~~~~
Expand All @@ -388,7 +392,7 @@ Property Type Units Constra

.. [#] Required when ``systemType`` is "furnace" or "boiler".
.. [#] ``fuel`` choices are "electricity", "natural gas", "fuel oil", "propane", "coal", "wood", and "wood pellets".
.. [#] ``heatEfficiencyUnits`` choices are "AFUE" and "percent".
.. [#] ``heatEfficiencyUnits`` choices are "AFUE" and "fraction".

HVAC Heat Pumps
~~~~~~~~~~~~~~~
Expand All @@ -406,9 +410,9 @@ Property Type Units Constrai
``heatCapacityBtuPerHour`` float Btu/hr >=0 no autosized by modeling engine if undefined
``coolCapacityBtuPerHour`` float Btu/hr >=0 no autosized by modeling engine if undefined
``heatEfficiency`` float Btu/Wh >0 no PSC
``heatEfficiencyUnits`` string HSPF [#]_ no HSPF
``heatEfficiencyUnits`` string see [#]_ no HSPF
``coolEfficiency`` float Btu/Wh >0 no PSC
``coolEfficiencyUnits`` string SEER [#]_ no SEER
``coolEfficiencyUnits`` string see [#]_ no SEER
``heatLoadFraction`` float fraction 0-1 yes 1
``coolLoadFraction`` float fraction 0-1 yes 1
``backupSystem`` object yes
Expand All @@ -418,8 +422,8 @@ Property Type Units Constrai
.. [#] Required when ``systemType`` is "air-to-air" or "ground-to-air".
.. [#] ``systemType`` choices are "mini-split", "air-to-air", and "ground-to-air".
.. [#] ``compressorType`` choices are "single stage", "two stage", and "variable speed".
.. [#] The option to use "HSPF2" is planned for a future release.
.. [#] The option to use "SEER2" is planned for a future release.
.. [#] ``heatEfficiencyUnits`` choices are "HSPF" and "HSPF2".
.. [#] ``coolEfficiencyUnits`` choices are "SEER" and "SEER2".

``backupSystem`` schema for HVAC Heat Pumps:

Expand All @@ -430,15 +434,15 @@ Property Type Units Constrai
``heatingSwitchoverTemp`` float F no determined by modeling engine if undefined
``fuel`` string see [#]_ no electricity only applicable if backupSystem.systemType = "integrated"
``heatEfficiency`` float see ``heatEfficiencyUnit`` 0-1 no 1 only applicable if backupSystem.systemType = "integrated"
``heatEfficiencyUnits`` string see [#]_ no percent only applicable if backupSystem.systemType = "integrated"
``heatEfficiencyUnits`` string see [#]_ no fraction only applicable if backupSystem.systemType = "integrated"
``heatCapacityBtuPerHour`` float Btu/hr >=0 no autosized by modeling engine if undefined, only applicable if backupSystem.systemType = "integrated"
``backupHvacId`` idref see [#]_ see [#]_ PSC
================================= ======= ========================== ============== ======== ================== ==============================================

.. [#] ``systemType`` choices are "integrated" and "separate".
.. [#] ``fuel`` choices are "electricity", "natural gas", "fuel oil", "propane", "coal", "wood", and "wood pellets".
.. [#] ``heatEfficiencyUnits`` choices are "AFUE" and "percent".
.. [#] Must reference an defined ``hvacHeatingSystem.id``
.. [#] ``heatEfficiencyUnits`` choices are "AFUE" and "fraction".
.. [#] Must reference a defined ``hvacHeatingSystem.id``
.. [#] Required when ``backupSystem.systemType`` is "separate".

HVAC Air Distribution Systems
Expand Down Expand Up @@ -468,14 +472,14 @@ Property Type Units Constrai
``systemType`` string see [#]_ yes "supply" and "return" both supply and return must be defined
``insulationRValue`` float F-ft2-hr/Btu >=0 no 0
``leakageValue`` float see ``leakageUnits`` >=0 no BSA
``leakageUnits`` string see [#]_ no Percent
``leakageUnits`` string see [#]_ no fraction
``location`` string see [#]_ no see notes [#]_
================================= ======= ========================== ============== ======== ====================== ==============================================

.. [#] ``systemType`` choices are "supply" and "return".
.. [#] ``leakageUnits`` choices are"CFM25", "CFM50", and "percent".
.. [#] ``location`` choices are "living space", "basement conditioned", "basement unconditioned", "crawlspace unvented", "crawlspace vented", "attic unvented", "attic vented", "garage", "outside", "exterior wall", "under slab", "roof deck", "other heated space", and "other non-freezing space".
.. [#] If ``location`` not provided, defaults to the first present space type: "basement conditioned", "basement unconditioned", "crawlspace vented", "crawlspace unvented", "attic vented", "attic unvented", "garage", or "living space".
.. [#] ``leakageUnits`` choices are "CFM25", "CFM50", and "fraction".
.. [#] ``location`` choices are "conditioned space", "basement conditioned", "basement unconditioned", "crawlspace unvented", "crawlspace vented", "attic unvented", "attic vented", "garage", "outside", "exterior wall", "under slab", "roof deck", "other heated space", "other non-freezing space", and "manufactured home belly".
.. [#] If ``location`` not provided, defaults to the first present space type: "basement conditioned", "basement unconditioned", "crawlspace conditioned", "crawlspace vented", "crawlspace unvented", "attic vented", "attic unvented", "garage", or "conditioned space".

HVAC Hydronic Distribution Systems
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -725,20 +729,22 @@ Property Type Units
``tankVolume`` float gal no
``dhwLoadFraction`` float fraction 0-1 yes sum of dhwLoadFraction must equal 1
``heatCapacityBtuPerHour`` float Btu/hr >0 no autosized by modeling engine if undefined
``energyFactor`` or ``uniformEnergyFactor`` float fraction <1 no BSA
``efficiency`` float fraction >0 no BSA
``efficiencyUnits`` string see [#]_ no BSA
``hotWaterTemperature`` float F >0 no 125
=========================================== ======= ========================== ============== ======== ==================== ==============================================

.. [#] ``systemType`` choices are "storage water heater", "instantaneous water heater", "heat pump water heater", "space-heating boiler with storage tank", and "space-heating boiler with tankless coil".
.. [#] Must reference a defined ``hvacHeatingSystem.id``.
.. [#] Only required when ``systemType`` is "space-heating boiler with ..."
.. [#] ``fuel`` choices are "electricity", "natural gas", "fuel oil", "propane", "coal", "wood", and "wood pellets".
.. [#] ``location`` choices are "living space", "basement conditioned", "basement unconditioned", "crawlspace unvented", "crawlspace vented", "attic unvented", "attic vented", "garage", “other exterior”, “other heated space”, and “other non-freezing space”.
.. [#] ``location`` choices are "conditioned space", "basement conditioned", "basement unconditioned", "crawlspace unvented", "crawlspace vented", "attic unvented", "attic vented", "garage", “other exterior”, “other heated space”, and “other non-freezing space”.
.. [#] If ``location`` not provided, defaults to the first present space type:

IECC zones 1-3, excluding 3A: "garage", "living space"
IECC zones 1-3, excluding 3A: "garage", "conditioned space"

IECC zones 3A, 4-8, unknown: "basement conditioned", "basement unconditioned", "living space"
IECC zones 3A, 4-8, unknown: "basement conditioned", "basement unconditioned", "conditioned space"
.. [#] ``efficiencyUnits`` choices are "EF" and "UEF".

.. _weather:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,17 +123,17 @@ connected to the base building's heating and cooling systems.

``adjust`` schema for existing HVAC distribution system:

==================== ======= =========== ==============================================
==================== ======= =========== ========================================================
Property Type Constraints Description
==================== ======= =========== ==============================================
``leakageUnits`` String See [#]_ Duct leakage units
==================== ======= =========== ========================================================
``leakageUnits`` String See [#]_ Duct leakage units must be the same as ``baseBuilding``
``leakageValue`` Double >= 0.0 Duct leakage value
``insulationRValue`` Double >= 0.0
==================== ======= =========== ==============================================
==================== ======= =========== ========================================================

Values can be defined and will only be applied if applicable. For example, if there isn't ``airDistribution``, then ``leakageValue`` won't be applied.

.. [#] Units choices are CFM25, CFM50, or Percent.
.. [#] Units choices are "CFM25", "CFM50", or "fraction".

.. _existing_water_heating_system:

Expand Down Expand Up @@ -218,7 +218,7 @@ Characteristics of a new water heating system can be entered in ``automatedMeasu
===================== ==================== =========== ======== ======= ===================================
Property Type Constraints Required Default Description
===================== ==================== =========== ======== ======= ===================================
``systemType`` String See [#]_ Yes Type of water heating system. fuelType assumed as base heating fuel for "storage water heater" and "instantaneous water heater".
``systemType`` String See [#]_ Yes Type of water heating system. ``fuelType`` assumed as base heating fuel for "storage water heater" and "instantaneous water heater".
``efficiencyClass`` String See [#]_ Yes
``dhwLoadFraction`` Double 0 - 1 [#]_ No 1.0 DHW load for the new water heating system
``costs`` Array of :ref:`cost` No ``[]`` Implied costs of measure
Expand Down Expand Up @@ -246,6 +246,16 @@ Assumptions for ``efficiencyClass``:
instantaneous water heater other N/A N/A
========================== =========== ======== =======

Assumptions for ``tankVolume`` when ``systemType`` is "heat pump water heater":
=============== =============
Resident Count Volume (gal)
=============== =============
2 or less 50
3 65
4 or more 80
=============== =============


Adjust global aspects of the building
-------------------------------------

Expand Down Expand Up @@ -280,6 +290,8 @@ Adjustments to the building air leakage rates can be entered in ``automatedMeasu

.. [#] rateUnit choices are ACH or CFM.

The air sealing measure is only applicable when the improved air sealing rate is less than the base rate.

.. _adjust_attic_insulation:

Attic Insulation
Expand All @@ -304,6 +316,19 @@ Adjustments to existing attic insulation can be entered in ``automatedMeasures.a
``floorAssemblyEffectiveRValue`` Double F-ft2-hr/Btu > 0.0 50.6 Effective R-value of attic floor assembly
================================ ====== ============ =========== ======= =======================================

Attic insulation measure applicability is determined based on the difference between the base and improved assembly effective R-value using the following table.

===================== ========================= ===========
Base Assembly R-Value Improved Assembly R-Value Applicable?
===================== ========================= ===========
< 8.7 < 8.7 false
< 8.7 >= 8.7 true
8.7 - 20.6 < 26.6 false
8.7 - 20.6 >= 26.6 true
> 20.6 < 31.6 false
> 20.6 >= 31.6 true
===================== ========================= ===========

.. _adjust_thermostat:

Thermostat
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
"residentCount": 5,
"storiesCount": 1,
"windowToWallFraction": 0.14,
"yearBuilt": 1945
"yearBuilt": 1945,
"propertyUse": "single-family detached"
},
"enclosure": {
"airInfiltration": {
Expand Down Expand Up @@ -81,7 +82,7 @@
"systemType": "electric resistance",
"fuel": "electricity",
"heatEfficiency": 1,
"heatEfficiencyUnits": "percent",
"heatEfficiencyUnits": "fraction",
"heatLoadFraction": 1
}
],
Expand All @@ -101,13 +102,14 @@
"waterHeating": {
"waterHeatingSystems": [
{
"energyFactor": 0.92,
"efficiency": 0.92,
"efficiencyUnits": "EF",
"dhwLoadFraction": 1,
"systemType": "storage water heater",
"fuel": "electricity",
"id": "WaterHeater1",
"hotWaterTemperature": 125,
"location": "living space",
"location": "conditioned space",
"lifetime": {
"replacementCost": 1000,
"installedDate": "2015-11-12"
Expand Down
Loading