diff --git a/docs/source/api.rst b/docs/source/api.rst index 3552a56..18f91b0 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -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 ================================= ======= ================ ============== ======== ================== ============================================== @@ -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" @@ -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". @@ -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 ================================= ======= ========================== ============== ======== ================== ============================================== @@ -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 diff --git a/docs/source/automated_measures.rst b/docs/source/automated_measures.rst index e465529..bbb0e20 100644 --- a/docs/source/automated_measures.rst +++ b/docs/source/automated_measures.rst @@ -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. @@ -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: @@ -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``. @@ -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: @@ -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. @@ -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 @@ -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 ========================= ==================== =========== ======== ======= =================================== @@ -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``: diff --git a/docs/source/examples/request/timelines/post/extensive_inputs.json b/docs/source/examples/request/timelines/post/extensive_inputs.json index e275cf6..b7c658a 100644 --- a/docs/source/examples/request/timelines/post/extensive_inputs.json +++ b/docs/source/examples/request/timelines/post/extensive_inputs.json @@ -47,7 +47,7 @@ "id": "Wall1", "type": "wood stud", "assemblyEffectiveRValue": 16.0, - "percentageAreaShared": 0.0 + "fractionAreaShared": 0.0 } ], "foundations": [ @@ -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" @@ -81,7 +81,7 @@ "fuel": "natural gas", "heatEfficiency": 0.8, "heatEfficiencyUnits": "AFUE", - "heatLoadPercentage": 1.0 + "heatLoadFraction": 1.0 } ], "hvacControlSystems": [ @@ -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": { @@ -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 @@ -304,7 +304,7 @@ "systemType": "heat pump water heater", "fuel": "electricity", "tankVolume": 80, - "dhwLoadPercentage": 1.0, + "dhwLoadFraction": 1.0, "energyFactor": 3.5, "costs": [ { diff --git a/docs/source/examples/response/timelines/post/automated_measures_new_heat_pump.json b/docs/source/examples/response/timelines/post/automated_measures_new_heat_pump.json index 9ee25ed..9c4448c 100644 --- a/docs/source/examples/response/timelines/post/automated_measures_new_heat_pump.json +++ b/docs/source/examples/response/timelines/post/automated_measures_new_heat_pump.json @@ -58,7 +58,7 @@ "id": "Wall1", "type": "wood stud", "assemblyEffectiveRValue": 4.0, - "percentageAreaShared": 0.0 + "fractionAreaShared": 0.0 } ], "foundations": [ @@ -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" @@ -92,7 +92,7 @@ "fuel": "electricity", "heatEfficiency": 1.0, "heatEfficiencyUnits": "percent", - "heatLoadPercentage": 1.0 + "heatLoadFraction": 1.0 } ], "hvacControlSystems": [ @@ -115,7 +115,7 @@ "fuel": "electricity", "location": "living space", "tankVolume": 40, - "dhwLoadPercentage": 1.0, + "dhwLoadFraction": 1.0, "energyFactor": 0.92, "hotWaterTemperature": 125.0, "lifetime": { @@ -263,7 +263,7 @@ "id": "Wall1", "type": "wood stud", "assemblyEffectiveRValue": 4.0, - "percentageAreaShared": 0.0 + "fractionAreaShared": 0.0 } ], "foundations": [ @@ -310,8 +310,8 @@ "heatEfficiencyUnits": "HSPF", "coolEfficiency": 14, "coolEfficiencyUnits": "SEER", - "heatLoadPercentage": 1.0, - "coolLoadPercentage": 1.0 + "heatLoadFraction": 1.0, + "coolLoadFraction": 1.0 } ], "hvacControlSystems": [ @@ -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, diff --git a/docs/source/examples/response/timelines/post/extensive_inputs.json b/docs/source/examples/response/timelines/post/extensive_inputs.json index efe9187..93ebd85 100644 --- a/docs/source/examples/response/timelines/post/extensive_inputs.json +++ b/docs/source/examples/response/timelines/post/extensive_inputs.json @@ -85,7 +85,7 @@ "id": "Wall1", "type": "wood stud", "assemblyEffectiveRValue": 4.0, - "percentageAreaShared": 0.0 + "fractionAreaShared": 0.0 } ], "foundations": [ @@ -105,7 +105,7 @@ "systemType": "room air conditioner", "coolEfficiency": 10.7, "coolEfficiencyUnits": "EER", - "coolLoadPercentage": 0.33, + "coolLoadFraction": 0.33, "lifetime": { "replacementCost": 200, "endOfLifeDate": "2024-07-01" @@ -119,7 +119,7 @@ "fuel": "electricity", "heatEfficiency": 1.0, "heatEfficiencyUnits": "percent", - "heatLoadPercentage": 1.0 + "heatLoadFraction": 1.0 } ], "hvacControlSystems": [ @@ -142,7 +142,7 @@ "fuel": "electricity", "location": "living space", "tankVolume": 40, - "dhwLoadPercentage": 1.0, + "dhwLoadFraction": 1.0, "energyFactor": 0.92, "hotWaterTemperature": 125.0, "lifetime": { @@ -223,7 +223,7 @@ "type": "wood stud", "area": 1234, "assemblyEffectiveRValue": 4, - "percentageAreaShared": 0 + "fractionAreaShared": 0 } ] }, @@ -236,7 +236,7 @@ "compressorType": "single stage", "coolEfficiency": 10.7, "coolEfficiencyUnits": "EER", - "coolLoadPercentage": 0.33, + "coolLoadFraction": 0.33, "lifetime": { "replacementCost": 200, "endOfLifeDate": "2024-07-01" @@ -250,7 +250,7 @@ "fuel": "electricity", "heatEfficiency": 1, "heatEfficiencyUnits": "percent", - "heatLoadPercentage": 1 + "heatLoadFraction": 1 } ], "hvacControlSystems": [ @@ -264,8 +264,8 @@ } } ], - "coolLoadGapPercentage": 0.67, - "heatLoadGapPercentage": 0.0 + "coolLoadGapFraction": 0.67, + "heatLoadGapFraction": 0.0 }, "waterHeating": { "waterHeatingSystems": [ @@ -275,7 +275,7 @@ "fuel": "electricity", "location": "living space", "tankVolume": 40, - "dhwLoadPercentage": 1, + "dhwLoadFraction": 1, "energyFactor": 0.92, "hotWaterTemperature": 125, "lifetime": { @@ -452,7 +452,7 @@ "id": "Furnace1", "systemType": "furnace", "fuel": "natural gas", - "heatLoadPercentage": 1, + "heatLoadFraction": 1, "costs": [ { "fixedCost": 6000 @@ -923,7 +923,7 @@ "id": "Wall1", "type": "wood stud", "assemblyEffectiveRValue": 4.0, - "percentageAreaShared": 0.0 + "fractionAreaShared": 0.0 } ], "foundations": [ @@ -943,7 +943,7 @@ "systemType": "room air conditioner", "coolEfficiency": 10.7, "coolEfficiencyUnits": "EER", - "coolLoadPercentage": 0.33, + "coolLoadFraction": 0.33, "lifetime": { "replacementCost": 200, "endOfLifeDate": "2024-07-01" @@ -957,7 +957,7 @@ "fuel": "electricity", "heatEfficiency": 1.0, "heatEfficiencyUnits": "percent", - "heatLoadPercentage": 1.0 + "heatLoadFraction": 1.0 } ], "hvacControlSystems": [ @@ -980,7 +980,7 @@ "fuel": "electricity", "location": "living space", "tankVolume": 40, - "dhwLoadPercentage": 1.0, + "dhwLoadFraction": 1.0, "energyFactor": 0.92, "hotWaterTemperature": 125.0, "lifetime": { @@ -1061,7 +1061,7 @@ "type": "wood stud", "area": 1234, "assemblyEffectiveRValue": 4, - "percentageAreaShared": 0 + "fractionAreaShared": 0 } ] }, @@ -1074,7 +1074,7 @@ "compressorType": "single stage", "coolEfficiency": 10.7, "coolEfficiencyUnits": "EER", - "coolLoadPercentage": 0.33, + "coolLoadFraction": 0.33, "lifetime": { "replacementCost": 200, "endOfLifeDate": "2024-07-01" @@ -1088,7 +1088,7 @@ "fuel": "electricity", "heatEfficiency": 1, "heatEfficiencyUnits": "percent", - "heatLoadPercentage": 1 + "heatLoadFraction": 1 } ], "hvacControlSystems": [ @@ -1102,8 +1102,8 @@ } } ], - "coolLoadGapPercentage": 0.67, - "heatLoadGapPercentage": 0.0 + "coolLoadGapFraction": 0.67, + "heatLoadGapFraction": 0.0 }, "waterHeating": { "waterHeatingSystems": [ @@ -1113,7 +1113,7 @@ "fuel": "electricity", "location": "living space", "tankVolume": 40, - "dhwLoadPercentage": 1, + "dhwLoadFraction": 1, "energyFactor": 0.92, "hotWaterTemperature": 125, "lifetime": { @@ -1334,8 +1334,8 @@ "heatEfficiencyUnits": "HSPF", "coolEfficiency": 20, "coolEfficiencyUnits": "SEER", - "heatLoadPercentage": 1, - "coolLoadPercentage": 1, + "heatLoadFraction": 1, + "coolLoadFraction": 1, "costs": [ { "fixedCost": 20190 @@ -1379,7 +1379,7 @@ "systemType": "heat pump water heater", "fuel": "electricity", "tankVolume": 80, - "dhwLoadPercentage": 1, + "dhwLoadFraction": 1, "energyFactor": 3.5, "costs": [ { @@ -1439,7 +1439,7 @@ "id": "Wall1", "type": "wood stud", "assemblyEffectiveRValue": 4, - "percentageAreaShared": 0 + "fractionAreaShared": 0 } ], "foundations": [ @@ -1470,8 +1470,8 @@ "heatEfficiencyUnits": "HSPF", "coolEfficiency": 20, "coolEfficiencyUnits": "SEER", - "heatLoadPercentage": 1, - "coolLoadPercentage": 1, + "heatLoadFraction": 1, + "coolLoadFraction": 1, "costs": [ { "fixedCost": 20190 @@ -1509,7 +1509,7 @@ "systemType": "heat pump water heater", "fuel": "electricity", "tankVolume": 80, - "dhwLoadPercentage": 1, + "dhwLoadFraction": 1, "energyFactor": 3.5, "hotWaterTemperature": 125, "costs": [ @@ -1999,7 +1999,7 @@ "id": "Wall1", "type": "wood stud", "assemblyEffectiveRValue": 4, - "percentageAreaShared": 0 + "fractionAreaShared": 0 } ], "foundations": [ @@ -2019,7 +2019,7 @@ "systemType": "room air conditioner", "coolEfficiency": 10.7, "coolEfficiencyUnits": "EER", - "coolLoadPercentage": 0.33, + "coolLoadFraction": 0.33, "lifetime": { "replacementCost": 200, "endOfLifeDate": "2024-07-01" @@ -2033,7 +2033,7 @@ "fuel": "electricity", "heatEfficiency": 1, "heatEfficiencyUnits": "percent", - "heatLoadPercentage": 1 + "heatLoadFraction": 1 } ], "hvacControlSystems": [ @@ -2047,7 +2047,7 @@ } } ], - "coolLoadGapPercentage": 0.67 + "coolLoadGapFraction": 0.67 }, "waterHeating": { "waterHeatingSystems": [ @@ -2057,7 +2057,7 @@ "fuel": "electricity", "location": "living space", "tankVolume": 40, - "dhwLoadPercentage": 1, + "dhwLoadFraction": 1, "energyFactor": 0.92, "hotWaterTemperature": 125, "lifetime": { diff --git a/docs/source/examples/response/timelines/post/simple_bare_bones.json b/docs/source/examples/response/timelines/post/simple_bare_bones.json index 5542128..5e4050e 100644 --- a/docs/source/examples/response/timelines/post/simple_bare_bones.json +++ b/docs/source/examples/response/timelines/post/simple_bare_bones.json @@ -58,7 +58,7 @@ "id": "Wall1", "type": "wood stud", "assemblyEffectiveRValue": 16.0, - "percentageAreaShared": 0.0 + "fractionAreaShared": 0.0 } ], "foundations": [ @@ -78,7 +78,7 @@ "systemType": "central air conditioner", "coolEfficiency": 13.0, "coolEfficiencyUnits": "SEER", - "coolLoadPercentage": 1.0, + "coolLoadFraction": 1.0, "lifetime": { "replacementCost": 2000, "endOfLifeDate": "2024-07-01" @@ -92,7 +92,7 @@ "fuel": "natural gas", "heatEfficiency": 0.8, "heatEfficiencyUnits": "AFUE", - "heatLoadPercentage": 1.0 + "heatLoadFraction": 1.0 } ], "hvacControlSystems": [ @@ -143,7 +143,7 @@ "fuel": "natural gas", "location": "living space", "tankVolume": 40, - "dhwLoadPercentage": 1.0, + "dhwLoadFraction": 1.0, "energyFactor": 0.59, "hotWaterTemperature": 125.0, "lifetime": { diff --git a/docs/source/examples/response/timelines/post/simple_with_monthly.json b/docs/source/examples/response/timelines/post/simple_with_monthly.json index e3b7597..6a54bfe 100644 --- a/docs/source/examples/response/timelines/post/simple_with_monthly.json +++ b/docs/source/examples/response/timelines/post/simple_with_monthly.json @@ -58,7 +58,7 @@ "id": "Wall1", "type": "wood stud", "assemblyEffectiveRValue": 16.0, - "percentageAreaShared": 0.0 + "fractionAreaShared": 0.0 } ], "foundations": [ @@ -78,7 +78,7 @@ "systemType": "central air conditioner", "coolEfficiency": 13.0, "coolEfficiencyUnits": "SEER", - "coolLoadPercentage": 1.0, + "coolLoadFraction": 1.0, "lifetime": { "replacementCost": 2000, "endOfLifeDate": "2024-07-01" @@ -92,7 +92,7 @@ "fuel": "natural gas", "heatEfficiency": 0.8, "heatEfficiencyUnits": "AFUE", - "heatLoadPercentage": 1.0 + "heatLoadFraction": 1.0 } ], "hvacControlSystems": [ @@ -143,7 +143,7 @@ "fuel": "natural gas", "location": "living space", "tankVolume": 40, - "dhwLoadPercentage": 1.0, + "dhwLoadFraction": 1.0, "energyFactor": 0.59, "hotWaterTemperature": 125.0, "lifetime": { diff --git a/docs/source/examples/response/timelines/post/simple_with_monthly_and_hourly.json.gz b/docs/source/examples/response/timelines/post/simple_with_monthly_and_hourly.json.gz index 4234e5a..db0b143 100644 Binary files a/docs/source/examples/response/timelines/post/simple_with_monthly_and_hourly.json.gz and b/docs/source/examples/response/timelines/post/simple_with_monthly_and_hourly.json.gz differ diff --git a/docs/source/schemas/request/AutomatedMeasures.json5 b/docs/source/schemas/request/AutomatedMeasures.json5 index 9242cb5..a043dc0 100644 --- a/docs/source/schemas/request/AutomatedMeasures.json5 +++ b/docs/source/schemas/request/AutomatedMeasures.json5 @@ -2,7 +2,7 @@ "existingHvacHeatingSystem": { "action": "adjust", // ("keep" | "remove" | "adjust") "adjust": { - "heatLoadPercentage": 0.2, + "heatLoadFraction": 0.2, "backup": true }, "costs": [ COST ] @@ -10,7 +10,7 @@ "existingHvacCoolingSystem": { "action": "adjust", // ("keep" | "remove" | "adjust") "adjust": { - "coolLoadPercentage": 0.2 + "coolLoadFraction": 0.2 }, "costs": [ COST ] }, @@ -25,21 +25,21 @@ "newHeatPump": { "systemType": "heat-pump", // ("heat-pump" | "mini-split" | "air-to-air") "performanceClass": "", // ("federal-minimally-compliant" | "energy-star-compliant") - "heatLoadPercentage": 0.8, - "coolLoadPercentage": 0.8, + "heatLoadFraction": 0.8, + "coolLoadFraction": 0.8, "costs": [ COST ] }, "existingWaterHeatingSystem": { "action": "adjust", // ("keep" | "remove" | "adjust") "adjust": { - "dhwLoadPercentage": 0.8 + "dhwLoadFraction": 0.8 }, "costs": [ COST ] }, "newWaterHeatingSystem": { "systemType": "storage-water-heater", // ( “storage-water-heater” | “instantaneous-water-heater” | “heat-pump-water-heater”) "efficiencyClass": "", //("standard" | "high") - "dhwLoadPercentage": 1.0, + "dhwLoadFraction": 1.0, "costs": [ COST ] }, "thermostat": { @@ -71,4 +71,4 @@ }, "costs": [ COST ] } -} \ No newline at end of file +} diff --git a/docs/source/schemas/request/Enclosure.json5 b/docs/source/schemas/request/Enclosure.json5 index b1ebf59..61a9e83 100644 --- a/docs/source/schemas/request/Enclosure.json5 +++ b/docs/source/schemas/request/Enclosure.json5 @@ -40,7 +40,7 @@ "type": "wood stud", // ("wood stud" | "concrete masonry unit" | "structural brick" | "steel frame" | "stone" | "adobe" | "log wall" | "solid concrete") "area": 1234, "assemblyEffectiveRValue": 10.9, - "percentageAreaShared": 0.0, // percentage of wall area shared with an adjacent structure or dwelling unit (e.g. townhouses) + "fractionAreaShared": 0.0, // fraction of wall area shared with an adjacent structure or dwelling unit (e.g. townhouses) } ], -} \ No newline at end of file +} diff --git a/docs/source/schemas/request/HVAC.json5 b/docs/source/schemas/request/HVAC.json5 index defd478..8245acf 100644 --- a/docs/source/schemas/request/HVAC.json5 +++ b/docs/source/schemas/request/HVAC.json5 @@ -10,7 +10,7 @@ "compressorType": "single stage", "coolEfficiency": 12, "coolEfficiencyUnits": "SEER", //("percent" | "EER" | "CEER" | "SEER" | *"SEER2") //SEER2 coming soon - "coolLoadPercentage": 0.8, // required. Sum of coolLoadPercentage across all systems plus unmetCoolLoadPercentage must equal 1. + "coolLoadFraction": 0.8, // required. Sum of coolLoadFraction across all systems plus coolLoadGapFraction must equal 1. "lifetime": LIFETIME // optional, refer to Lifetime schema } ], @@ -24,7 +24,7 @@ "heatCapacityBtuPerHour": 1000.0, //optional. If missing, model will autosize. See Model Controls for autosizing settings. "heatEfficiency": 0.8, "heatEfficiencyUnits": "AFUE", //("AFUE" | "percent") - "heatLoadPercentage": 0.8, // required. Sum of heatLoadPercentage across all systems plus unmetHeatLoadPercentage must equal 1. + "heatLoadFraction": 0.8, // required. Sum of heatLoadFraction across all systems plus heatLoadGapFraction must equal 1. "lifetime": LIFETIME // optional, refer to Lifetime schema } ], @@ -52,8 +52,8 @@ "heatEfficiencyUnits": "HSPF", //("HSPF" | *"HSPF2") //HSPF2 coming soon "coolEfficiency": 19, "coolEfficiencyUnits": "SEER", //("SEER" | *"SEER2") //SEER2 coming soon - "heatLoadPercentage": 0.8, // required. Sum of heatLoadPercentage across all systems plus unmetHeatLoadPercentage must equal 1. - "coolLoadPercentage": 0.8, // required. Sum of coolLoadPercentage across all systems plus unmetCoolLoadPercentage must equal 1. + "heatLoadFraction": 0.8, // required. Sum of heatLoadFraction across all systems plus heatLoadGapFraction must equal 1. + "coolLoadFraction": 0.8, // required. Sum of coolLoadFraction across all systems plus coolLoadGapFraction must equal 1. "lifetime": LIFETIME // optional, refer to Lifetime schema } ], @@ -114,6 +114,6 @@ "lifetime": LIFETIME // optional, refer to Lifetime schema } ], - "coolLoadGapPercentage": 0.2, // required if the sum of all systems' coolLoadPercentage is less than 1.0. - "heatLoadGapPercentage": 0.0, // required if the sum of all systems' heatLoadPercentage is less than 1.0. + "coolLoadGapFraction": 0.2, // required if the sum of all systems' coolLoadFraction is less than 1.0. + "heatLoadGapFraction": 0.0, // required if the sum of all systems' heatLoadFraction is less than 1.0. } diff --git a/docs/source/schemas/request/ImprovedHVAC.json5 b/docs/source/schemas/request/ImprovedHVAC.json5 index 15d3072..da3458b 100644 --- a/docs/source/schemas/request/ImprovedHVAC.json5 +++ b/docs/source/schemas/request/ImprovedHVAC.json5 @@ -9,7 +9,7 @@ "compressorType": "single stage", "coolEfficiency": 12, "coolEfficiencyUnits": "SEER", - "coolLoadPercentage": 0.8, // required. Sum of coolLoadPercentage across all systems plus unmetCoolLoadPercentage must equal 1. + "coolLoadFraction": 0.8, // required. Sum of coolLoadFraction across all systems plus coolLoadGapFraction must equal 1. "remove": true, // if true, system is removed and any other properties defined are ignored. "costs": [ COST ], // refer to the Cost schema } @@ -24,7 +24,7 @@ "heatCapacityBtuPerHour": 1000.0, //optional. If missing, model will autosize. See Model Controls for autosizing settings. "heatEfficiency": 0.8, "heatEfficiencyUnits": "AFUE", - "heatLoadPercentage": 0.8, // required. Sum of heatLoadPercentage across all systems plus unmetHeatLoadPercentage must equal 1. + "heatLoadFraction": 0.8, // required. Sum of heatLoadFraction across all systems plus heatLoadGapFraction must equal 1. "remove": true, //if true, system is removed and any other properties defined are ignored. "costs": [ COST ], // refer to the Cost schema @@ -54,8 +54,8 @@ "heatEfficiencyUnits": "HSPF", "coolEfficiency": 19, "coolEfficiencyUnits": "SEER", - "heatLoadPercentage": 0.8, //required // If both heatLoadPercentage and coolLoadPercentage are 0, the system is being removed. - "coolLoadPercentage": 0.8, //required // If both heatLoadPercentage and coolLoadPercentage are 0, the system is being removed. + "heatLoadFraction": 0.8, //required // If both heatLoadFraction and coolLoadFraction are 0, the system is being removed. + "coolLoadFraction": 0.8, //required // If both heatLoadFraction and coolLoadFraction are 0, the system is being removed. "remove": false, // if true, system is removed and any other properties defined are ignored. "costs": [ COST ], // refer to the Cost schema @@ -123,13 +123,11 @@ "setbackStartHour": 9, "totalWeeklySetbackHours": 42, }, - "unmetCoolLoadPercentage": 0.2, // required if the sum of all systems' coolLoadPercentage is less than 1.0. - "unmetHeatLoadPercentage": 0.2, // required if the sum of all systems' heatLoadPercentage is less than 1.0 "remove": false, //if true, system is removed and any other properties defined are ignored. "costs": [ COST ], // refer to the Cost schema } ], - "coolLoadGapPercentage": 0.2, // required if the sum of all systems' coolLoadPercentage is less than 1.0. - "heatLoadGapPercentage": 0.0, // required if the sum of all systems' heatLoadPercentage is less than 1.0. + "coolLoadGapFraction": 0.2, // required if the sum of all systems' coolLoadFraction is less than 1.0. + "heatLoadGapFraction": 0.0, // required if the sum of all systems' heatLoadFraction is less than 1.0. } diff --git a/docs/source/schemas/request/ImprovedWaterHeating.json5 b/docs/source/schemas/request/ImprovedWaterHeating.json5 index 3f623ac..ef0c990 100644 --- a/docs/source/schemas/request/ImprovedWaterHeating.json5 +++ b/docs/source/schemas/request/ImprovedWaterHeating.json5 @@ -7,7 +7,7 @@ "connectedHeatingId": "", "fuel": "electricity", //("electricity" | "natural gas" | "fuel oil" | "propane" | "coal" | "wood" | "wood pellets") "tankVolume": 80, - "dhwLoadPercentage": 1.0, // required, sum across all systems must equal 1 + "dhwLoadFraction": 1.0, // required, sum across all systems must equal 1 "heatCapacityBtuPerHour": null, "energyFactor": 3.5, "uniformEnergyFactor": null, diff --git a/docs/source/schemas/request/Incentive.json5 b/docs/source/schemas/request/Incentive.json5 index bbc3f3f..a1f9ef1 100644 --- a/docs/source/schemas/request/Incentive.json5 +++ b/docs/source/schemas/request/Incentive.json5 @@ -2,7 +2,7 @@ { "id": "Incentive1", "fixedAmount": 100, - "relativePercentage": 0.04, + "relativeFraction": 0.04, "absoluteMin": 100, "absoluteMax": 10000, "availableDate": "2023-01-01" //if null, defaults to model.appliedOn diff --git a/docs/source/schemas/request/WaterHeating.json5 b/docs/source/schemas/request/WaterHeating.json5 index bb14db8..de1d151 100644 --- a/docs/source/schemas/request/WaterHeating.json5 +++ b/docs/source/schemas/request/WaterHeating.json5 @@ -9,7 +9,7 @@ "fuel": "natural gas", // ("electricity" | "natural gas" | "fuel oil" | "propane" | "coal" | "wood" | "wood pellets") "location": "living space", "tankVolume": 40, - "dhwLoadPercentage": 1.0, // required, sum across all systems must equal 1 + "dhwLoadFraction": 1.0, // required, sum across all systems must equal 1 "heatCapacityBtuPerHour": null, "energyFactor": 0.92, "uniformEnergyFactor": null,