Skip to content

32 change xloadpercentage to xloadfraction #33

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
joshuamzm merged 15 commits into from
Oct 18, 2023
Merged

32 change xloadpercentage to xloadfraction #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c0f67e3
revisions in API.rst
kloconnell Oct 13, 2023
0b066af
Revise to fraction in automated_measures.rst
kloconnell Oct 13, 2023
44324ac
Update AutomatedMeasures.json5
kloconnell Oct 13, 2023
aad6759
Update Enclosure.json5
kloconnell Oct 13, 2023
2c4e8e1
Update HVAC.json5
kloconnell Oct 13, 2023
462ac6f
Update ImprovedHVAC.json5
kloconnell Oct 13, 2023
303258f
Update ImprovedWaterHeating.json5
kloconnell Oct 13, 2023
59eb898
Update WaterHeating.json5
kloconnell Oct 13, 2023
b9d215a
Update extensive_inputs.json
kloconnell Oct 13, 2023
f78335a
Update automated_measures_new_heat_pump.json
kloconnell Oct 13, 2023
150d416
Update extensive_inputs.json
kloconnell Oct 13, 2023
75b6969
Update simple_bare_bones.json
kloconnell Oct 13, 2023
bb739c3
Update simple_with_monthly.json
kloconnell Oct 13, 2023
7041451
Revise simple_with_monthly_and_hourly.json.gz
kloconnell Oct 13, 2023
176fd02
Rename last percentage occurrence to fraction
joshuamzm Oct 18, 2023
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
12 changes: 6 additions & 6 deletions docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ Property Type Units Constraints Re
``id`` id Must be unique yes Wall1
``type`` string see [#]_ no BSA
``assemblyEffectiveRValue`` float F-ft2-hr/Btu >0 no BSA
``percentageAreaShared`` float fraction 0-1 no PSC
``fractionAreaShared`` float fraction 0-1 no PSC
``area`` float ft2 >0 no PSC
================================= ======= ================ ============== ======== ================== ==============================================

Expand Down Expand Up @@ -359,7 +359,7 @@ Property Type Units Constra
``compressorType`` string see [#]_ no single stage only applicable if systemType = "central air conditioner"
``coolEfficiency`` float see ``coolEfficiencyUnits`` >0 no PSC
``coolEfficiencyUnits`` string see [#]_ no PSC
``coolLoadPercentage`` float fraction <=1 yes 1
``coolLoadFraction`` float fraction <=1 yes 1
================================= ======= =========================== ============== ======== ================== ==============================================

.. [#] If ``systemType`` is "central air conditioner"
Expand All @@ -383,7 +383,7 @@ Property Type Units Constra
``heatCapacityBtuPerHour`` float Btu/hr >=0 no autosized by modeling engine if undefined
``heatEfficiency`` float see ``heatEfficiencyUnits`` 0-1 no PSC
``heatEfficiencyUnits`` string see [#]_ no PSC
``heatLoadPercentage`` float fraction 0-1 yes 1
``heatLoadFraction`` float fraction 0-1 yes 1
================================= ======= =========================== ============== ======== ================== ==============================================

.. [#] Required when ``systemType`` is "furnace" or "boiler".
Expand All @@ -409,8 +409,8 @@ Property Type Units Constrai
``heatEfficiencyUnits`` string HSPF [#]_ no HSPF
``coolEfficiency`` float Btu/Wh >0 no PSC
``coolEfficiencyUnits`` string SEER [#]_ no SEER
``heatLoadPercentage`` float fraction 0-1 yes 1
``coolLoadPercentage`` float fraction 0-1 yes 1
``heatLoadFraction`` float fraction 0-1 yes 1
``coolLoadFraction`` float fraction 0-1 yes 1
``backupSystem`` object yes
================================= ======= ========================== ============== ======== ================== ==============================================

Expand Down Expand Up @@ -723,7 +723,7 @@ Property Type Units
``fuel`` string see [#]_ no
``location`` string see [#]_ no see [#]_
``tankVolume`` float gal no
``dhwLoadPercentage`` float fraction 0-1 yes sum of dhwLoadPercentage must equal 1
``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
``hotWaterTemperature`` float F >0 no 125
Expand Down
30 changes: 15 additions & 15 deletions docs/source/automated_measures.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ Operations to the existing HVAC heating system are entered in ``automatedMeasure

.. [#] ``action`` choices are "keep", "remove", or "adjust".

**"keep"** maintains existing heating system as is, including load percentage. Using this action indicates that there are no changes to heating at all. This action will override anything in ``adjust`` object.
**"keep"** maintains existing heating system as is, including load fraction. Using this action indicates that there are no changes to heating at all. This action will override anything in ``adjust`` object.

**"remove"** indicates the existing heating system is completely removed. New system(s) must cover 100% of load or specify ``heatLoadGapPercentage``. This action will override anything in ``adjust`` object.
**"remove"** indicates the existing heating system is completely removed. New system(s) must cover 100% of load or specify ``heatLoadGapFraction``. This action will override anything in ``adjust`` object.

.. [#] The ``adjust`` object is required if ``action`` is set to ``adjust``.
.. [#] Defaults to ``[]`` if not provided.
Expand All @@ -54,10 +54,10 @@ Operations to the existing HVAC heating system are entered in ``automatedMeasure
Property Type Constraints Required Description
====================== ======= =========== ========= ==============================================
``backup`` Boolean See [#a]_ Indicates the existing heating system is being kept, but switched to be a backup system
``heatLoadPercentage`` Double 0 - 1 See [#a]_ Heat load for the existing heating system
``heatLoadFraction`` Double 0 - 1 See [#a]_ Heat load for the existing heating system
====================== ======= =========== ========= ==============================================

.. [#a] Either ``backup`` or ``heatLoadPercentage`` can be defined. If ``backup`` is true, then ``heatLoadPercentage`` must be 0 or undefined. If ``backup`` is false, then ``heatLoadPercentage must be > 0.
.. [#a] Either ``backup`` or ``heatLoadFraction`` can be defined. If ``backup`` is true, then ``heatLoadFraction`` must be 0 or undefined. If ``backup`` is false, then ``heatLoadFraction must be > 0.

.. _existing_hvac_cooling_system:

Expand All @@ -76,9 +76,9 @@ Operations on the existing cooling systems are entered in ``automatedMeasures.ex

.. [#] ``action`` choices are "keep", "remove", or "adjust".

**"keep"** maintains existing cooling system as is, including load percentage. Using this action indicates that there are no changes to cooling at all. This action will override anything in ``adjust`` object.
**"keep"** maintains existing cooling system as is, including load fraction. Using this action indicates that there are no changes to cooling at all. This action will override anything in ``adjust`` object.

**"remove"** indicates the existing cooling system is completely removed. New system(s) must cover 100% of load or specify ``coolLoadGapPercentage``. This action will override anything in ``adjust`` object.
**"remove"** indicates the existing cooling system is completely removed. New system(s) must cover 100% of load or specify ``coolLoadGapFraction``. This action will override anything in ``adjust`` object.


.. [#] The ``adjust`` object is required if ``action`` is set to ``adjust``.
Expand All @@ -93,7 +93,7 @@ Operations on the existing cooling systems are entered in ``automatedMeasures.ex
====================== ======= =================== ======== =========================================
Property Type Constraints Required Description
====================== ======= =================== ======== =========================================
``coolLoadPercentage`` Double 0 - 1 Yes Cool load for the existing cooling system
``coolLoadFraction`` Double 0 - 1 Yes Cool load for the existing cooling system
====================== ======= =================== ======== =========================================

.. _existing_hvac_distribution_system:
Expand Down Expand Up @@ -152,7 +152,7 @@ Operations on the existing water heating system can be entered in ``automatedMea

.. [#] ``action`` choices are "keep", "remove", or "adjust".

**"keep"** maintains existing water heating system as is, including load percentage. Using this action indicates that there are no changes to the water heating system at all. This action will override anything in ``adjust`` object.
**"keep"** maintains existing water heating system as is, including load fraction. Using this action indicates that there are no changes to the water heating system at all. This action will override anything in ``adjust`` object.

**"remove"** indicates the existing water heating system is completely removed. This action will override anything in ``adjust`` object.

Expand All @@ -164,7 +164,7 @@ Operations on the existing water heating system can be entered in ``automatedMea
===================== ======= =========== ==============================================
Property Type Constraints Description
===================== ======= =========== ==============================================
``dhwLoadPercentage`` Double 0 - 1 Domestic hot water load for the existing water heating system
``dhwLoadFraction`` Double 0 - 1 Domestic hot water load for the existing water heating system
===================== ======= =========== ==============================================

Add new systems with minimal configuration
Expand All @@ -186,10 +186,10 @@ Characteristics of a new heat pump system can be entered in ``automatedMeasures.
========================= ==================== =========== ======== ======= ===================================
``systemType`` String See [#]_ Yes Type of heat pump
``performanceClass`` String See [#]_ Yes
``heatLoadPercentage`` Double 0 - 1 Yes Heat load for the new heat pump
``heatLoadGapPercentage`` Double 0 - 1 No 0.0 Heat load for the new heat pump
``coolLoadPercentage`` Double 0 - 1 Yes Cool load for the new heat pump
``coolLoadGapPercentage`` Double 0 - 1 No 0.0 Cool load for the new heat pump
``heatLoadFraction`` Double 0 - 1 Yes Heat load for the new heat pump
``heatLoadGapFraction`` Double 0 - 1 No 0.0 Heat load for the new heat pump
``coolLoadFraction`` Double 0 - 1 Yes Cool load for the new heat pump
``coolLoadGapFraction`` Double 0 - 1 No 0.0 Cool load for the new heat pump
``costs`` Array of :ref:`cost` No ``[]`` Implied costs of measure
========================= ==================== =========== ======== ======= ===================================

Expand Down Expand Up @@ -220,13 +220,13 @@ Characteristics of a new water heating system can be entered in ``automatedMeasu
===================== ==================== =========== ======== ======= ===================================
``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
``dhwLoadPercentage`` Double 0 - 1 [#]_ No 1.0 DHW load for the new water heating system
``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
===================== ==================== =========== ======== ======= ===================================

.. [#] ``systemType`` choices are "storage water heater", "instantaneous water heater", and "heat pump water heater"
.. [#] ``efficiencyClass`` choices are "standard" or "premium"
.. [#] The sum of ``dhwLoadPercentage`` across all water heating systems must be <= 1.
.. [#] The sum of ``dhwLoadFraction`` across all water heating systems must be <= 1.


Assumptions for ``efficiencyClass``:
Expand Down
14 changes: 7 additions & 7 deletions docs/source/examples/request/timelines/post/extensive_inputs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"id": "Wall1",
"type": "wood stud",
"assemblyEffectiveRValue": 16.0,
"percentageAreaShared": 0.0
"fractionAreaShared": 0.0
}
],
"foundations": [
Expand All @@ -67,7 +67,7 @@
"systemType": "central air conditioner",
"coolEfficiency": 13.0,
"coolEfficiencyUnits": "SEER",
"coolLoadPercentage": 1.0,
"coolLoadFraction": 1.0,
"lifetime": {
"replacementCost": 2000,
"endOfLifeDate": "2024-07-01"
Expand All @@ -81,7 +81,7 @@
"fuel": "natural gas",
"heatEfficiency": 0.8,
"heatEfficiencyUnits": "AFUE",
"heatLoadPercentage": 1.0
"heatLoadFraction": 1.0
}
],
"hvacControlSystems": [
Expand Down Expand Up @@ -132,7 +132,7 @@
"fuel": "natural gas",
"location": "living space",
"tankVolume": 40,
"dhwLoadPercentage": 1.0,
"dhwLoadFraction": 1.0,
"energyFactor": 0.59,
"hotWaterTemperature": 125.0,
"lifetime": {
Expand Down Expand Up @@ -246,8 +246,8 @@
"heatEfficiencyUnits": "HSPF",
"coolEfficiency": 19,
"coolEfficiencyUnits": "SEER",
"heatLoadPercentage": 1.0,
"coolLoadPercentage": 1.0,
"heatLoadFraction": 1.0,
"coolLoadFraction": 1.0,
"costs": [
{
"fixedCost": 20190
Expand Down Expand Up @@ -304,7 +304,7 @@
"systemType": "heat pump water heater",
"fuel": "electricity",
"tankVolume": 80,
"dhwLoadPercentage": 1.0,
"dhwLoadFraction": 1.0,
"energyFactor": 3.5,
"costs": [
{
Expand Down
16 changes: 8 additions & 8 deletions docs/source/examples/response/timelines/post/automated_measures_new_heat_pump.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"id": "Wall1",
"type": "wood stud",
"assemblyEffectiveRValue": 4.0,
"percentageAreaShared": 0.0
"fractionAreaShared": 0.0
}
],
"foundations": [
Expand All @@ -78,7 +78,7 @@
"systemType": "room air conditioner",
"coolEfficiency": 10.7,
"coolEfficiencyUnits": "EER",
"coolLoadPercentage": 0.33,
"coolLoadFraction": 0.33,
"lifetime": {
"replacementCost": 200,
"endOfLifeDate": "2024-07-01"
Expand All @@ -92,7 +92,7 @@
"fuel": "electricity",
"heatEfficiency": 1.0,
"heatEfficiencyUnits": "percent",
"heatLoadPercentage": 1.0
"heatLoadFraction": 1.0
}
],
"hvacControlSystems": [
Expand All @@ -115,7 +115,7 @@
"fuel": "electricity",
"location": "living space",
"tankVolume": 40,
"dhwLoadPercentage": 1.0,
"dhwLoadFraction": 1.0,
"energyFactor": 0.92,
"hotWaterTemperature": 125.0,
"lifetime": {
Expand Down Expand Up @@ -263,7 +263,7 @@
"id": "Wall1",
"type": "wood stud",
"assemblyEffectiveRValue": 4.0,
"percentageAreaShared": 0.0
"fractionAreaShared": 0.0
}
],
"foundations": [
Expand Down Expand Up @@ -310,8 +310,8 @@
"heatEfficiencyUnits": "HSPF",
"coolEfficiency": 14,
"coolEfficiencyUnits": "SEER",
"heatLoadPercentage": 1.0,
"coolLoadPercentage": 1.0
"heatLoadFraction": 1.0,
"coolLoadFraction": 1.0
}
],
"hvacControlSystems": [
Expand All @@ -335,7 +335,7 @@
"fuel": "natural gas",
"location": "living space",
"tankVolume": 40,
"dhwLoadPercentage": 1.0,
"dhwLoadFraction": 1.0,
"heatCapacityBtuPerHour": null,
"energyFactor": 0.92,
"uniformEnergyFactor": null,
Expand Down
Loading