Skip to content

Commit 47b349b

Browse files
joshuamzmjoshuamzm
authored
Merge pull request #52 from RadiantLabs/add-energy-end-use-to-response
Add energy end use to response
2 parents 80f0bfc + 74f45b2 commit 47b349b

File tree

5 files changed

+325
-2
lines changed

5 files changed

+325
-2
lines changed

‎docs/source/response_structure.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,30 @@ Energy Totals per Fuel Time Series
7070
.. literalinclude:: schemas/response/EnergyTotalsPerFuelTimeSeries.json5
7171
:language: javascript
7272

73+
Energy End Uses
74+
~~~~~~~~~~~~~~~
75+
76+
.. literalinclude:: schemas/response/EnergyEndUses.json5
77+
:language: javascript
78+
79+
Energy End Uses per Fuel Time Series
80+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
81+
82+
.. literalinclude:: schemas/response/EnergyEndUsesPerFuelTimeSeries.json5
83+
:language: javascript
84+
85+
================================== ==========================================================================================================
86+
Property Notes
87+
================================== ==========================================================================================================
88+
``heating`` Excludes heat pump backup and fans/pumps
89+
``heatingFansPumps`` Includes supply fan (air distribution) or circulating pump (hydronic distribution or geothermal loop)
90+
``heatingHeatPumpBackup`` Excludes heat pump backup fans/pumps
91+
``heatingHeatPumpBackupFansPumps`` Includes supply fan (air distribution) or circulating pump (hydronic distribution) during heat pump backup
92+
``cooling`` Excludes fans/pumps
93+
``coolingFansPumps`` Includes supply fan (air distribution) and circulating pump (geothermal loop)
94+
``pv`` Negative value for any power produced
95+
================================== ==========================================================================================================
96+
7397
Energy Costs
7498
~~~~~~~~~~~~
7599

‎docs/source/schemas/request/GlobalControls.json5‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
"includeInputs": true, // defaults to true, mirror user inputs in the response
66

7+
"includeEnergyEndUses": false, // defaults to false
8+
79
"includeDefaultAssumptions": false, // defaults to false
810

911
"includeBaseResults": true, // defaults to true
@@ -43,4 +45,4 @@
4345
"units": UNITS, // optional, refer to the Units schema
4446

4547
"escalationRates": ESCALATION_RATES, // optional, refer to the Escalation Rates schema
46-
}
48+
}

‎docs/source/schemas/response/EnergyEndUses.json5‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// ENERGY_END_USES
2+
{
3+
// given if resolution included "hourly"
4+
// it is guaranteed the timeseries will contain 8,760 datapoints
5+
"hourly": ENERGY_END_USES_PER_FUEL_TIME_SERIES,
6+
7+
// given if resolution included "monthly"
8+
// it is guaranteed the timeseries will contain 12 datapoints
9+
"monthly": ENERGY_END_USES_PER_FUEL_TIME_SERIES,
10+
11+
// given if resolution included "annual"
12+
// it is guaranteed the timeseries will only contain 1 datapoint
13+
"annual": ENERGY_END_USES_PER_FUEL_TIME_SERIES,
14+
}

‎docs/source/schemas/response/EnergyEndUsesPerFuelTimeSeries.json5‎

Lines changed: 282 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,282 @@
1+
{
2+
"electricity": {
3+
"heating": {
4+
"mbtu": [0.0, ..., 0.0],
5+
"kwh": [0.0, ..., 0.0]
6+
},
7+
"heatingFansPumps": {
8+
"mbtu": [0.0, ..., 0.0],
9+
"kwh": [0.0, ..., 0.0]
10+
},
11+
"heatingHeatPumpBackup": {
12+
"mbtu": [0.0, ..., 0.0],
13+
"kwh": [0.0, ..., 0.0]
14+
},
15+
"heatingHeatPumpBackupFansPumps": {
16+
"mbtu": [0.0, ..., 0.0],
17+
"kwh": [0.0, ..., 0.0]
18+
},
19+
"cooling": {
20+
"mbtu": [0.0, ..., 0.0],
21+
"kwh": [0.0, ..., 0.0]
22+
},
23+
"coolingFansPumps": {
24+
"mbtu": [0.0, ..., 0.0],
25+
"kwh": [0.0, ..., 0.0]
26+
},
27+
"hotWater": {
28+
"mbtu": [0.0, ..., 0.0],
29+
"kwh": [0.0, ..., 0.0]
30+
},
31+
"lightingInterior": {
32+
"mbtu": [0.0, ..., 0.0],
33+
"kwh": [0.0, ..., 0.0]
34+
},
35+
"lightingGarage": {
36+
"mbtu": [0.0, ..., 0.0],
37+
"kwh": [0.0, ..., 0.0]
38+
},
39+
"lightingExterior": {
40+
"mbtu": [0.0, ..., 0.0],
41+
"kwh": [0.0, ..., 0.0]
42+
},
43+
"mechVent": {
44+
"mbtu": [0.0, ..., 0.0],
45+
"kwh": [0.0, ..., 0.0]
46+
},
47+
"refrigerator": {
48+
"mbtu": [0.0, ..., 0.0],
49+
"kwh": [0.0, ..., 0.0]
50+
},
51+
"freezer": {
52+
"mbtu": [0.0, ..., 0.0],
53+
"kwh": [0.0, ..., 0.0]
54+
},
55+
"dehumidifier": {
56+
"mbtu": [0.0, ..., 0.0],
57+
"kwh": [0.0, ..., 0.0]
58+
},
59+
"dishwasher": {
60+
"mbtu": [0.0, ..., 0.0],
61+
"kwh": [0.0, ..., 0.0]
62+
},
63+
"clothesWasher": {
64+
"mbtu": [0.0, ..., 0.0],
65+
"kwh": [0.0, ..., 0.0]
66+
},
67+
"clothesDryer": {
68+
"mbtu": [0.0, ..., 0.0],
69+
"kwh": [0.0, ..., 0.0]
70+
},
71+
"rangeOven": {
72+
"mbtu": [0.0, ..., 0.0],
73+
"kwh": [0.0, ..., 0.0]
74+
},
75+
"ceilingFan": {
76+
"mbtu": [0.0, ..., 0.0],
77+
"kwh": [0.0, ..., 0.0]
78+
},
79+
"television": {
80+
"mbtu": [0.0, ..., 0.0],
81+
"kwh": [0.0, ..., 0.0]
82+
},
83+
"plugLoads": {
84+
"mbtu": [0.0, ..., 0.0],
85+
"kwh": [0.0, ..., 0.0]
86+
},
87+
"poolHeater": {
88+
"mbtu": [0.0, ..., 0.0],
89+
"kwh": [0.0, ..., 0.0]
90+
},
91+
"poolPump": {
92+
"mbtu": [0.0, ..., 0.0],
93+
"kwh": [0.0, ..., 0.0]
94+
},
95+
"permanentSpaHeater": {
96+
"mbtu": [0.0, ..., 0.0],
97+
"kwh": [0.0, ..., 0.0]
98+
},
99+
"permanentSpaPump": {
100+
"mbtu": [0.0, ..., 0.0],
101+
"kwh": [0.0, ..., 0.0]
102+
},
103+
"pv": {
104+
"mbtu": [0.0, ..., 0.0],
105+
"kwh": [0.0, ..., 0.0]
106+
}
107+
},
108+
"naturalGas": {
109+
"heating": {
110+
"mbtu": [0.0, ..., 0.0],
111+
"ccf": [0.0, ..., 0.0]
112+
},
113+
"heatingHeatPumpBackup": {
114+
"mbtu": [0.0, ..., 0.0],
115+
"ccf": [0.0, ..., 0.0]
116+
},
117+
"hotWater": {
118+
"mbtu": [0.0, ..., 0.0],
119+
"ccf": [0.0, ..., 0.0]
120+
},
121+
"clothesDryer": {
122+
"mbtu": [0.0, ..., 0.0],
123+
"ccf": [0.0, ..., 0.0]
124+
},
125+
"rangeOven": {
126+
"mbtu": [0.0, ..., 0.0],
127+
"ccf": [0.0, ..., 0.0]
128+
},
129+
"poolHeater": {
130+
"mbtu": [0.0, ..., 0.0],
131+
"ccf": [0.0, ..., 0.0]
132+
},
133+
"permanentSpaHeater": {
134+
"mbtu": [0.0, ..., 0.0],
135+
"ccf": [0.0, ..., 0.0]
136+
},
137+
"lighting": {
138+
"mbtu": [0.0, ..., 0.0],
139+
"ccf": [0.0, ..., 0.0]
140+
},
141+
"fireplace": {
142+
"mbtu": [0.0, ..., 0.0],
143+
"ccf": [0.0, ..., 0.0]
144+
}
145+
},
146+
"fuelOil": {
147+
"heating": {
148+
"mbtu": [0.0, ..., 0.0],
149+
"gallons": [0.0, ..., 0.0]
150+
},
151+
"heatingHeatPumpBackup": {
152+
"mbtu": [0.0, ..., 0.0],
153+
"gallons": [0.0, ..., 0.0]
154+
},
155+
"hotWater": {
156+
"mbtu": [0.0, ..., 0.0],
157+
"gallons": [0.0, ..., 0.0]
158+
},
159+
"clothesDryer": {
160+
"mbtu": [0.0, ..., 0.0],
161+
"gallons": [0.0, ..., 0.0]
162+
},
163+
"rangeOven": {
164+
"mbtu": [0.0, ..., 0.0],
165+
"gallons": [0.0, ..., 0.0]
166+
},
167+
"lighting": {
168+
"mbtu": [0.0, ..., 0.0],
169+
"gallons": [0.0, ..., 0.0]
170+
},
171+
"fireplace": {
172+
"mbtu": [0.0, ..., 0.0],
173+
"gallons": [0.0, ..., 0.0]
174+
}
175+
},
176+
"propane": {
177+
"heating": {
178+
"mbtu": [0.0, ..., 0.0],
179+
"gallons": [0.0, ..., 0.0]
180+
},
181+
"heatingHeatPumpBackup": {
182+
"mbtu": [0.0, ..., 0.0],
183+
"gallons": [0.0, ..., 0.0]
184+
},
185+
"hotWater": {
186+
"mbtu": [0.0, ..., 0.0],
187+
"gallons": [0.0, ..., 0.0]
188+
},
189+
"clothesDryer": {
190+
"mbtu": [0.0, ..., 0.0],
191+
"gallons": [0.0, ..., 0.0]
192+
},
193+
"rangeOven": {
194+
"mbtu": [0.0, ..., 0.0],
195+
"gallons": [0.0, ..., 0.0]
196+
},
197+
"lighting": {
198+
"mbtu": [0.0, ..., 0.0],
199+
"gallons": [0.0, ..., 0.0]
200+
},
201+
"fireplace": {
202+
"mbtu": [0.0, ..., 0.0],
203+
"gallons": [0.0, ..., 0.0]
204+
}
205+
},
206+
"woodCord": {
207+
"heating": {
208+
"mbtu": [0.0, ..., 0.0],
209+
},
210+
"heatingHeatPumpBackup": {
211+
"mbtu": [0.0, ..., 0.0],
212+
},
213+
"hotWater": {
214+
"mbtu": [0.0, ..., 0.0],
215+
},
216+
"clothesDryer": {
217+
"mbtu": [0.0, ..., 0.0],
218+
},
219+
"rangeOven": {
220+
"mbtu": [0.0, ..., 0.0],
221+
},
222+
"lighting": {
223+
"mbtu": [0.0, ..., 0.0],
224+
},
225+
"fireplace": {
226+
"mbtu": [0.0, ..., 0.0],
227+
}
228+
},
229+
"woodPellets": {
230+
"heating": {
231+
"mbtu": [0.0, ..., 0.0],
232+
},
233+
"heatingHeatPumpBackup": {
234+
"mbtu": [0.0, ..., 0.0],
235+
},
236+
"hotWater": {
237+
"mbtu": [0.0, ..., 0.0],
238+
},
239+
"clothesDryer": {
240+
"mbtu": [0.0, ..., 0.0],
241+
},
242+
"rangeOven": {
243+
"mbtu": [0.0, ..., 0.0],
244+
},
245+
"lighting": {
246+
"mbtu": [0.0, ..., 0.0],
247+
},
248+
"fireplace": {
249+
"mbtu": [0.0, ..., 0.0],
250+
}
251+
},
252+
"coal": {
253+
"heating": {
254+
"mbtu": [0.0, ..., 0.0],
255+
"metricTons": [0.0, ..., 0.0]
256+
},
257+
"heatingHeatPumpBackup": {
258+
"mbtu": [0.0, ..., 0.0],
259+
"metricTons": [0.0, ..., 0.0]
260+
},
261+
"hotWater": {
262+
"mbtu": [0.0, ..., 0.0],
263+
"metricTons": [0.0, ..., 0.0]
264+
},
265+
"clothesDryer": {
266+
"mbtu": [0.0, ..., 0.0],
267+
"metricTons": [0.0, ..., 0.0]
268+
},
269+
"rangeOven": {
270+
"mbtu": [0.0, ..., 0.0],
271+
"metricTons": [0.0, ..., 0.0]
272+
},
273+
"lighting": {
274+
"mbtu": [0.0, ..., 0.0],
275+
"metricTons": [0.0, ..., 0.0]
276+
},
277+
"fireplace": {
278+
"mbtu": [0.0, ..., 0.0],
279+
"metricTons": [0.0, ..., 0.0]
280+
}
281+
}
282+
}

‎docs/source/schemas/response/ResponseModel.json5‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
},
3636

3737
"energyTotals": ENERGY_TOTALS,
38+
"energyEndUses": ENERGY_END_USES,
3839
"energyCosts": ENERGY_COSTS,
3940
"emissionTotals": EMISSION_TOTALS,
4041

@@ -59,4 +60,4 @@
5960
"averageMonthly": 0.0, // annual electricity difference/savings - loan cost / 12
6061
},
6162
}
62-
}
63+
}

0 commit comments

Comments
 (0)