Add energy end use to response

docs/source/response_structure.rst

@@ -70,6 +70,30 @@ Energy Totals per Fuel Time Series
 .. literalinclude:: schemas/response/EnergyTotalsPerFuelTimeSeries.json5
    :language: javascript
 
+Energy End Uses
+~~~~~~~~~~~~~~~
+
+.. literalinclude:: schemas/response/EnergyEndUses.json5
+   :language: javascript
+
+Energy End Uses per Fuel Time Series
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. literalinclude:: schemas/response/EnergyEndUsesPerFuelTimeSeries.json5
+   :language: javascript
+
+================================== ==========================================================================================================
+Property                           Notes
+================================== ==========================================================================================================
+``heating``                        Excludes heat pump backup and fans/pumps
+``heatingFansPumps``               Includes supply fan (air distribution) or circulating pump (hydronic distribution or geothermal loop)
+``heatingHeatPumpBackup``          Excludes heat pump backup fans/pumps
+``heatingHeatPumpBackupFansPumps`` Includes supply fan (air distribution) or circulating pump (hydronic distribution) during heat pump backup
+``cooling``                        Excludes fans/pumps
+``coolingFansPumps``               Includes supply fan (air distribution) and circulating pump (geothermal loop)
+``pv``                             Negative value for any power produced
+================================== ==========================================================================================================
+
 Energy Costs
 ~~~~~~~~~~~~
 

docs/source/schemas/request/GlobalControls.json5

@@ -4,6 +4,8 @@
 
   "includeInputs": true, // defaults to true, mirror user inputs in the response
 
+  "includeEnergyEndUses": false, // defaults to false
+
   "includeDefaultAssumptions": false, // defaults to false
 
   "includeBaseResults": true, // defaults to true
@@ -43,4 +45,4 @@
   "units": UNITS, // optional, refer to the Units schema
 
   "escalationRates": ESCALATION_RATES, // optional, refer to the Escalation Rates schema
-}
+}

docs/source/schemas/response/EnergyEndUses.json5

@@ -0,0 +1,14 @@
+// ENERGY_END_USES
+{
+  // given if resolution included "hourly"
+  // it is guaranteed the timeseries will contain 8,760 datapoints
+  "hourly": ENERGY_END_USES_PER_FUEL_TIME_SERIES,
+
+  // given if resolution included "monthly"
+  // it is guaranteed the timeseries will contain 12 datapoints
+  "monthly": ENERGY_END_USES_PER_FUEL_TIME_SERIES,
+
+  // given if resolution included "annual"
+  // it is guaranteed the timeseries will only contain 1 datapoint
+  "annual": ENERGY_END_USES_PER_FUEL_TIME_SERIES,
+}

docs/source/schemas/response/EnergyEndUsesPerFuelTimeSeries.json5

@@ -0,0 +1,282 @@
+{
+  "electricity": {
+    "heating": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "heatingFansPumps": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "heatingHeatPumpBackup": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "heatingHeatPumpBackupFansPumps": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "cooling": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "coolingFansPumps": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "hotWater": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "lightingInterior": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "lightingGarage": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "lightingExterior": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "mechVent": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "refrigerator": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "freezer": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "dehumidifier": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "dishwasher": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "clothesWasher": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "clothesDryer": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "rangeOven": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "ceilingFan": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "television": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "plugLoads": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "poolHeater": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "poolPump": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "permanentSpaHeater": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "permanentSpaPump": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    },
+    "pv": {
+      "mbtu": [0.0, ..., 0.0],
+      "kwh": [0.0, ..., 0.0]
+    }
+  },
+  "naturalGas": {
+    "heating": {
+      "mbtu": [0.0, ..., 0.0],
+      "ccf": [0.0, ..., 0.0]
+    },
+    "heatingHeatPumpBackup": {
+      "mbtu": [0.0, ..., 0.0],
+      "ccf": [0.0, ..., 0.0]
+    },
+    "hotWater": {
+      "mbtu": [0.0, ..., 0.0],
+      "ccf": [0.0, ..., 0.0]
+    },
+    "clothesDryer": {
+      "mbtu": [0.0, ..., 0.0],
+      "ccf": [0.0, ..., 0.0]
+    },
+    "rangeOven": {
+      "mbtu": [0.0, ..., 0.0],
+      "ccf": [0.0, ..., 0.0]
+    },
+    "poolHeater": {
+      "mbtu": [0.0, ..., 0.0],
+      "ccf": [0.0, ..., 0.0]
+    },
+    "permanentSpaHeater": {
+      "mbtu": [0.0, ..., 0.0],
+      "ccf": [0.0, ..., 0.0]
+    },
+    "lighting": {
+      "mbtu": [0.0, ..., 0.0],
+      "ccf": [0.0, ..., 0.0]
+    },
+    "fireplace": {
+      "mbtu": [0.0, ..., 0.0],
+      "ccf": [0.0, ..., 0.0]
+    }
+  },
+  "fuelOil": {
+    "heating": {
+      "mbtu": [0.0, ..., 0.0],
+      "gallons": [0.0, ..., 0.0]
+    },
+    "heatingHeatPumpBackup": {
+      "mbtu": [0.0, ..., 0.0],
+      "gallons": [0.0, ..., 0.0]
+    },
+    "hotWater": {
+      "mbtu": [0.0, ..., 0.0],
+      "gallons": [0.0, ..., 0.0]
+    },
+    "clothesDryer": {
+      "mbtu": [0.0, ..., 0.0],
+      "gallons": [0.0, ..., 0.0]
+    },
+    "rangeOven": {
+      "mbtu": [0.0, ..., 0.0],
+      "gallons": [0.0, ..., 0.0]
+    },
+    "lighting": {
+      "mbtu": [0.0, ..., 0.0],
+      "gallons": [0.0, ..., 0.0]
+    },
+    "fireplace": {
+      "mbtu": [0.0, ..., 0.0],
+      "gallons": [0.0, ..., 0.0]
+    }
+  },
+  "propane": {
+    "heating": {
+      "mbtu": [0.0, ..., 0.0],
+      "gallons": [0.0, ..., 0.0]
+    },
+    "heatingHeatPumpBackup": {
+      "mbtu": [0.0, ..., 0.0],
+      "gallons": [0.0, ..., 0.0]
+    },
+    "hotWater": {
+      "mbtu": [0.0, ..., 0.0],
+      "gallons": [0.0, ..., 0.0]
+    },
+    "clothesDryer": {
+      "mbtu": [0.0, ..., 0.0],
+      "gallons": [0.0, ..., 0.0]
+    },
+    "rangeOven": {
+      "mbtu": [0.0, ..., 0.0],
+      "gallons": [0.0, ..., 0.0]
+    },
+    "lighting": {
+      "mbtu": [0.0, ..., 0.0],
+      "gallons": [0.0, ..., 0.0]
+    },
+    "fireplace": {
+      "mbtu": [0.0, ..., 0.0],
+      "gallons": [0.0, ..., 0.0]
+    }
+  },
+  "woodCord": {
+    "heating": {
+      "mbtu": [0.0, ..., 0.0],
+    },
+    "heatingHeatPumpBackup": {
+      "mbtu": [0.0, ..., 0.0],
+    },
+    "hotWater": {
+      "mbtu": [0.0, ..., 0.0],
+    },
+    "clothesDryer": {
+      "mbtu": [0.0, ..., 0.0],
+    },
+    "rangeOven": {
+      "mbtu": [0.0, ..., 0.0],
+    },
+    "lighting": {
+      "mbtu": [0.0, ..., 0.0],
+    },
+    "fireplace": {
+      "mbtu": [0.0, ..., 0.0],
+    }
+  },
+  "woodPellets": {
+    "heating": {
+      "mbtu": [0.0, ..., 0.0],
+    },
+    "heatingHeatPumpBackup": {
+      "mbtu": [0.0, ..., 0.0],
+    },
+    "hotWater": {
+      "mbtu": [0.0, ..., 0.0],
+    },
+    "clothesDryer": {
+      "mbtu": [0.0, ..., 0.0],
+    },
+    "rangeOven": {
+      "mbtu": [0.0, ..., 0.0],
+    },
+    "lighting": {
+      "mbtu": [0.0, ..., 0.0],
+    },
+    "fireplace": {
+      "mbtu": [0.0, ..., 0.0],
+    }
+  },
+  "coal": {
+    "heating": {
+      "mbtu": [0.0, ..., 0.0],
+      "metricTons": [0.0, ..., 0.0]
+    },
+    "heatingHeatPumpBackup": {
+      "mbtu": [0.0, ..., 0.0],
+      "metricTons": [0.0, ..., 0.0]
+    },
+    "hotWater": {
+      "mbtu": [0.0, ..., 0.0],
+      "metricTons": [0.0, ..., 0.0]
+    },
+    "clothesDryer": {
+      "mbtu": [0.0, ..., 0.0],
+      "metricTons": [0.0, ..., 0.0]
+    },
+    "rangeOven": {
+      "mbtu": [0.0, ..., 0.0],
+      "metricTons": [0.0, ..., 0.0]
+    },
+    "lighting": {
+      "mbtu": [0.0, ..., 0.0],
+      "metricTons": [0.0, ..., 0.0]
+    },
+    "fireplace": {
+      "mbtu": [0.0, ..., 0.0],
+      "metricTons": [0.0, ..., 0.0]
+    }
+  }
+}

docs/source/schemas/response/ResponseModel.json5

@@ -35,6 +35,7 @@
   },
 
   "energyTotals": ENERGY_TOTALS,
+  "energyEndUses": ENERGY_END_USES,
   "energyCosts": ENERGY_COSTS,
   "emissionTotals": EMISSION_TOTALS,
 
@@ -59,4 +60,4 @@
       "averageMonthly": 0.0, // annual electricity difference/savings - loan cost / 12
     },
   }
-}
+}