urbanopt-reopt 0.10.0 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (26) hide show
  1. checksums.yaml +4 -4
  2. data/.github/release.yml +25 -0
  3. data/.github/workflows/nightly_ci_build.yml +10 -3
  4. data/CHANGELOG.md +16 -0
  5. data/Gemfile +1 -1
  6. data/LICENSE.md +1 -1
  7. data/RDOC_MAIN.md +19 -19
  8. data/README.md +20 -20
  9. data/doc_templates/LICENSE.md +1 -1
  10. data/doc_templates/copyright_erb.txt +1 -1
  11. data/docs/README.md +18 -18
  12. data/docs/package-lock.json +4806 -4836
  13. data/docs/schemas/reopt-input-schema.md +25 -23
  14. data/docs/schemas/reopt-output-schema.md +7 -7
  15. data/index.md +22 -22
  16. data/lib/urbanopt/reopt/feature_report_adapter.rb +241 -208
  17. data/lib/urbanopt/reopt/reopt_lite_api.rb +98 -59
  18. data/lib/urbanopt/reopt/reopt_post_processor.rb +34 -33
  19. data/lib/urbanopt/reopt/reopt_schema/reopt_input_schema.json +1126 -1106
  20. data/lib/urbanopt/reopt/reopt_schema/reopt_output_schema.json +449 -524
  21. data/lib/urbanopt/reopt/scenario/reopt_scenario_csv.rb +7 -7
  22. data/lib/urbanopt/reopt/scenario_report_adapter.rb +275 -240
  23. data/lib/urbanopt/reopt/version.rb +1 -1
  24. data/urbanopt-reopt.gemspec +5 -3
  25. metadata +35 -8
  26. data/Jenkinsfile +0 -10
data/lib/urbanopt/reopt/reopt_schema/reopt_input_schema.json CHANGED
@@ -1,1113 +1,1133 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-04/schema#",
3
- "description": "Data Dictionary for REopt Lite Inputs",
3
+ "description": "Data Dictionary for REopt Inputs",
4
4
  "type": "object",
5
5
  "properties": {
6
- "$ref": "#/definitions/Scenario"
7
- },
8
- "required": [
9
- "Scenario"
10
- ],
11
- "definitions": {
12
- "Scenario": {
13
- "Scenario": {
14
- "type":"object",
15
- "properties":{
16
- "user_uuid": {
17
- "type": "str",
18
- "description": "The assigned unique ID of a signed in REOpt user"
19
- },
20
- "time_steps_per_hour": {
21
- "default": 1,
22
- "max": 4,
23
- "type": "int",
24
- "description": "The number of time steps per hour in the REopt simulation",
25
- "min": 1
26
- },
27
- "timeout_seconds": {
28
- "default": 295,
29
- "max": 295,
30
- "type": "float",
31
- "description": "The number of seconds allowed before the optimization times out",
32
- "min": 1
33
- },
34
- "description": {
35
- "type": "str",
36
- "description": "An optional user defined description to describe the scenario and run"
37
- },
38
- "Site": {
39
- "type": "object",
40
- "properties": {
41
- "latitude": {
42
- "max": 90,
43
- "required": true,
44
- "type": "float",
45
- "description": "The approximate latitude of the site in decimal degrees",
46
- "min": -90
47
- },
48
- "longitude": {
49
- "max": 180,
50
- "required": true,
51
- "type": "float",
52
- "description": "The approximate longitude of the site in decimal degrees",
53
- "min": -180
54
- },
55
- "land_acres": {
56
- "max": 1000000.0,
57
- "type": "float",
58
- "description": "Land area in acres available for PV panel siting",
59
- "min": 0
60
- },
61
- "address": {
62
- "type": "str",
63
- "description": "A user defined address as optional metadata (street address, city, state or zip code)"
64
- },
65
- "roof_squarefeet": {
66
- "max": 1000000000.0,
67
- "type": "float",
68
- "description": "Area of roof in square feet available for PV siting",
69
- "min": 0
70
- },
71
- "Financial": {
72
- "type": "object",
73
- "properties": {
74
- "escalation_pct": {
75
- "default": 0.026,
76
- "max": 1,
77
- "type": "float",
78
- "description": "Annual nominal utility electricity cost escalation rate",
79
- "min": -1
80
- },
81
- "offtaker_discount_pct": {
82
- "default": 0.081,
83
- "max": 1,
84
- "type": "float",
85
- "description": "Nominal host discount rate",
86
- "min": 0
87
- },
88
- "value_of_lost_load_us_dollars_per_kwh": {
89
- "default": 100,
90
- "max": 1000000.0,
91
- "type": "float",
92
- "description": "Value placed on unmet site load during grid outages. Units are US dollars per unmet kilowatt-hour. The value of lost load (VoLL) is used to determine the avoided outage costs by multiplying VoLL [$/kWh] with the average number of hours that the critical load can be met by the energy system (determined by simulating outages occuring at every hour of the year), and multiplying by the mean critical load.",
93
- "min": 0
94
- },
95
- "analysis_years": {
96
- "default": 20,
97
- "max": 75,
98
- "type": "int",
99
- "description": "Analysis period",
100
- "min": 1
101
- },
102
- "microgrid_upgrade_cost_pct": {
103
- "default": 0.3,
104
- "max": 1,
105
- "type": "float",
106
- "description": "Additional cost, in percent of non-islandable capital costs, to make a distributed energy system islandable from the grid and able to serve critical loads. Includes all upgrade costs such as additional laber and critical load panels.",
107
- "min": 0
108
- },
109
- "offtaker_tax_pct": {
110
- "default": 0.26,
111
- "max": 1,
112
- "type": "float",
113
- "description": "Host tax rate",
114
- "min": 0
115
- },
116
- "om_cost_escalation_pct": {
117
- "default": 0.025,
118
- "max": 1,
119
- "type": "float",
120
- "description": "Annual nominal O&M cost escalation rate",
121
- "min": -1
122
- }
123
- }
124
- },
125
- "ElectricTariff": {
126
- "type": "object",
127
- "properties": {
128
- "add_blended_rates_to_urdb_rate": {
129
- "default": false,
130
- "type": "bool",
131
- "description": "Set to 'true' to add the monthly blended energy rates and demand charges to the URDB rate schedule. Otherwise, blended rates will only be considered if a URDB rate is not provided. "
132
- },
133
- "wholesale_rate_us_dollars_per_kwh": {
134
- "default": 0,
135
- "type": "float",
136
- "description": "Price of electricity sold back to the grid in absence of net metering or above net metering limit, restricted to total site load",
137
- "min": 0
138
- },
139
- "interconnection_limit_kw": {
140
- "default": 100000000.0,
141
- "max": 1000000000.0,
142
- "type": "float",
143
- "description": "Limit on system capacity size that can be interconnected to the grid",
144
- "min": 0
145
- },
146
- "wholesale_rate_above_site_load_us_dollars_per_kwh": {
147
- "default": 0,
148
- "type": "float",
149
- "description": "Price of electricity sold back to the grid above the site load, regardless of net metering",
150
- "min": 0
151
- },
152
- "urdb_response": {
153
- "replacement_sets": [
154
- ["urdb_response"],
155
- ["blended_monthly_demand_charges_us_dollars_per_kw", "blended_monthly_rates_us_dollars_per_kwh"],
156
- ["blended_annual_demand_charges_us_dollars_per_kw", "blended_annual_rates_us_dollars_per_kwh"],
157
- ["urdb_label"],
158
- ["urdb_utility_name", "urdb_rate_name"]
159
- ],
160
- "type": "dict",
161
- "description": "Utility rate structure from <a href='https: //openei.org/services/doc/rest/util_rates/?version=3' target='blank'>Utility Rate Database API</a>"
162
- },
163
- "blended_annual_demand_charges_us_dollars_per_kw": {
164
- "replacement_sets": [
165
- ["urdb_response"],
166
- ["blended_monthly_demand_charges_us_dollars_per_kw", "blended_monthly_rates_us_dollars_per_kwh"],
167
- ["blended_annual_demand_charges_us_dollars_per_kw", "blended_annual_rates_us_dollars_per_kwh"],
168
- ["urdb_label"],
169
- ["urdb_utility_name", "urdb_rate_name"]
170
- ],
171
- "type": "float",
172
- "description": "Annual blended demand rates (annual demand charge cost in $ divided by annual peak demand in kW)",
173
- "depends_on": ["blended_annual_rates_us_dollars_per_kwh"]
174
- },
175
- "blended_annual_rates_us_dollars_per_kwh": {
176
- "replacement_sets": [
177
- ["urdb_response"],
178
- ["blended_monthly_demand_charges_us_dollars_per_kw", "blended_monthly_rates_us_dollars_per_kwh"],
179
- ["blended_annual_demand_charges_us_dollars_per_kw", "blended_annual_rates_us_dollars_per_kwh"],
180
- ["urdb_label"],
181
- ["urdb_utility_name", "urdb_rate_name"]
182
- ],
183
- "type": "float",
184
- "description": "Annual blended energy rate (total annual energy in kWh divided by annual cost in $)",
185
- "depends_on": ["blended_annual_demand_charges_us_dollars_per_kw"]
186
- },
187
- "net_metering_limit_kw": {
188
- "default": 0,
189
- "max": 1000000000.0,
190
- "type": "float",
191
- "description": "System size above which net metering is not allowed",
192
- "min": 0
193
- },
194
- "blended_monthly_demand_charges_us_dollars_per_kw": {
195
- "replacement_sets": [
196
- ["urdb_response"],
197
- ["blended_monthly_demand_charges_us_dollars_per_kw", "blended_monthly_rates_us_dollars_per_kwh"],
198
- ["blended_annual_demand_charges_us_dollars_per_kw", "blended_annual_rates_us_dollars_per_kwh"],
199
- ["urdb_label"],
200
- ["urdb_utility_name", "urdb_rate_name"]
201
- ],
202
- "type": "list_of_float",
203
- "description": "Array (length of 12) of blended demand charges (demand charge cost in $ divided by monthly peak demand in kW)",
204
- "depends_on": ["blended_monthly_rates_us_dollars_per_kwh"]
205
- },
206
- "urdb_utility_name": {
207
- "replacement_sets": [
208
- ["urdb_response"],
209
- ["blended_monthly_demand_charges_us_dollars_per_kw", "blended_monthly_rates_us_dollars_per_kwh"],
210
- ["blended_annual_demand_charges_us_dollars_per_kw", "blended_annual_rates_us_dollars_per_kwh"],
211
- ["urdb_label"],
212
- ["urdb_utility_name", "urdb_rate_name"]
213
- ],
214
- "type": "str",
215
- "description": "Name of Utility from <a href='https: //openei.org/wiki/Utility_Rate_Database' target='blank'>Utility Rate Database</a>",
216
- "depends_on": ["urdb_rate_name"]
217
- },
218
- "urdb_label": {
219
- "replacement_sets": [
220
- ["urdb_response"],
221
- ["blended_monthly_demand_charges_us_dollars_per_kw", "blended_monthly_rates_us_dollars_per_kwh"],
222
- ["blended_annual_demand_charges_us_dollars_per_kw", "blended_annual_rates_us_dollars_per_kwh"],
223
- ["urdb_label"],
224
- ["urdb_utility_name", "urdb_rate_name"]
225
- ],
226
- "type": "str",
227
- "description": "Label attribute of utility rate structure from <a href='https: //openei.org/services/doc/rest/util_rates/?version=3' target='blank'>Utility Rate Database API</a>"
228
- },
229
- "urdb_rate_name": {
230
- "replacement_sets": [
231
- ["urdb_response"],
232
- ["blended_monthly_demand_charges_us_dollars_per_kw", "blended_monthly_rates_us_dollars_per_kwh"],
233
- ["blended_annual_demand_charges_us_dollars_per_kw", "blended_annual_rates_us_dollars_per_kwh"],
234
- ["urdb_label"],
235
- ["urdb_utility_name", "urdb_rate_name"]
236
- ],
237
- "type": "str",
238
- "description": "Name of utility rate from <a href='https: //openei.org/wiki/Utility_Rate_Database' target='blank'>Utility Rate Database</a>",
239
- "depends_on": ["urdb_utility_name"]
240
- },
241
- "blended_monthly_rates_us_dollars_per_kwh": {
242
- "replacement_sets": [
243
- ["urdb_response"],
244
- ["blended_monthly_demand_charges_us_dollars_per_kw", "blended_monthly_rates_us_dollars_per_kwh"],
245
- ["blended_annual_demand_charges_us_dollars_per_kw", "blended_annual_rates_us_dollars_per_kwh"],
246
- ["urdb_label"],
247
- ["urdb_utility_name", "urdb_rate_name"]
248
- ],
249
- "type": "list_of_float",
250
- "description": "Array (length of 12) of blended energy rates (total monthly energy in kWh divided by monthly cost in $)",
251
- "depends_on": ["blended_monthly_demand_charges_us_dollars_per_kw"]
252
- }
253
- }
254
- },
255
- "LoadProfile": {
256
- "type": "object",
257
- "properties": {
258
- "critical_load_pct": {
259
- "default": 0.5,
260
- "max": 1,
261
- "type": "float",
262
- "description": "Critical load factor is multiplied by the typical load to determine the critical load that must be met during an outage. Value must be between zero and one, inclusive.",
263
- "min": 0
264
- },
265
- "outage_start_hour": {
266
- "max": 8759,
267
- "type": "int",
268
- "description": "Hour of year that grid outage starts. Must be less than outage_end.",
269
- "min": 0
270
- },
271
- "outage_end_hour": {
272
- "max": 8759,
273
- "type": "int",
274
- "description": "Hour of year that grid outage ends. Must be greater than outage_start.",
275
- "min": 0
276
- },
277
- "monthly_totals_kwh": {
278
- "replacement_sets": [
279
- ["loads_kw"],
280
- ["doe_reference_name", "monthly_totals_kwh"],
281
- ["annual_kwh", "doe_reference_name"],
282
- ["doe_reference_name"]
283
- ],
284
- "type": "list_of_float",
285
- "description": "Array (length of 12) of total monthly energy consumption used to scale simulated building load profile.",
286
- "depends_on": ["doe_reference_name"]
287
- },
288
- "year": {
289
- "default": 2018,
290
- "max": 9999,
291
- "type": "int",
292
- "description": "Year of Custom Load Profile. If a custom load profile is uploaded via the loads_kw parameter, it is important that this year correlates with the load profile so that weekdays/weekends are determined correctly for the utility rate tariff. If a DOE Reference Building profile (aka simulated profile) is used, the year is set to 2017 since the DOE profiles start on a Sunday.",
293
- "min": 1
294
- },
295
- "loads_kw": {
296
- "replacement_sets": [
297
- ["loads_kw"],
298
- ["doe_reference_name", "monthly_totals_kwh"],
299
- ["annual_kwh", "doe_reference_name"],
300
- ["doe_reference_name"]
301
- ],
302
- "type": "list_of_float",
303
- "description": "Typical load over all hours in one year. Must be hourly (8,760 samples), 30 minute (17,520 samples), or 15 minute (35,040 samples)."
304
- },
305
- "outage_is_major_event": {
306
- "default": true,
307
- "type": "bool",
308
- "description": "Boolean value for if outage is a major event, which affects the avoided_outage_costs_us_dollars. If True, the avoided outage costs are calculated for a single outage occurring in the first year of the analysis_years. If False, the outage event is assumed to be an average outage event that occurs every year of the analysis period. In the latter case, the avoided outage costs for one year are escalated and discounted using the escalation_pct and offtaker_discount_pct to account for an annually recurring outage. (Average outage durations for certain utility service areas can be estimated using statistics reported on EIA form 861.)"
309
- },
310
- "critical_loads_kw_is_net": {
311
- "default": false,
312
- "type": "bool",
313
- "description": "If there is existing PV, must specify whether provided load is the net load after existing PV or not."
314
- },
315
- "loads_kw_is_net": {
316
- "default": true,
317
- "type": "bool",
318
- "description": "If there is existing PV, must specify whether provided load is the net load after existing PV or not."
319
- },
320
- "annual_kwh": {
321
- "type": "float",
322
- "description": "Annual energy consumption used to scale simulated building load profile, if <b><small>monthly_totals_kwh</b></small> is not provided.",
323
- "min": 1,
324
- "max": 1000000000000.0,
325
- "depends_on": ["doe_reference_name"],
326
- "replacement_sets": [
327
- ["loads_kw"],
328
- ["doe_reference_name", "monthly_totals_kwh"],
329
- ["annual_kwh", "doe_reference_name"],
330
- ["doe_reference_name"]
331
- ]
332
- },
333
- "doe_reference_name": {
334
- "replacement_sets": [
335
- ["loads_kw"],
336
- ["doe_reference_name", "monthly_totals_kwh"],
337
- ["annual_kwh", "doe_reference_name"],
338
- ["doe_reference_name"]
339
- ],
340
- "type": "str",
341
- "description": "Simulated load profile from DOE <a href='https: //energy.gov/eere/buildings/commercial-reference-buildings' target='blank'>Commercial Reference Buildings</a>",
342
- "restrict_to": ["FastFoodRest", "FullServiceRest", "Hospital", "LargeHotel", "LargeOffice", "MediumOffice", "MidriseApartment", "Outpatient", "PrimarySchool", "RetailStore", "SecondarySchool", "SmallHotel", "SmallOffice", "StripMall", "Supermarket", "Warehouse", "FlatLoad"]
343
- },
344
- "critical_loads_kw": {
345
- "type": "list_of_float",
346
- "description": "Critical load during an outage period. Must be hourly (8,760 samples), 30 minute (17,520 samples), or 15 minute (35,040 samples)."
347
- }
348
- }
349
- },
350
- "PV": {
351
- "type": "object",
352
- "properties": {
353
- "pbi_years": {
354
- "default": 1,
355
- "max": 100,
356
- "type": "float",
357
- "description": "Duration of production-based incentives from installation date",
358
- "min": 0
359
- },
360
- "macrs_bonus_pct": {
361
- "default": 0,
362
- "max": 1,
363
- "type": "float",
364
- "description": "Percent of upfront project costs to depreciate in year one in addition to scheduled depreciation",
365
- "min": 0
366
- },
367
- "state_rebate_us_dollars_per_kw": {
368
- "default": 0,
369
- "max": 1000000000.0,
370
- "type": "float",
371
- "description": "State rebate based on installed capacity",
372
- "min": 0
373
- },
374
- "location": {
375
- "default": "roof",
376
- "type": "string",
377
- "description": "Indicates location of PV. Available options are roof and ground."
378
- },
379
- "max_kw": {
380
- "default": 1000000000.0,
381
- "max": 1000000000.0,
382
- "type": "float",
383
- "description": "Maximum PV size constraint for optimization. Set to zero to disable PV",
384
- "min": 0
385
- },
386
- "azimuth": {
387
- "default": 180,
388
- "max": 360,
389
- "type": "float",
390
- "description": "PV azimuth angle",
391
- "min": 0
392
- },
393
- "state_rebate_max_us_dollars": {
394
- "default": 10000000000.0,
395
- "max": 10000000000.0,
396
- "type": "float",
397
- "description": "Maximum state rebate",
398
- "min": 0
399
- },
400
- "gcr": {
401
- "default": 0.4,
402
- "max": 0.99,
403
- "type": "float",
404
- "description": "PV ground cover ratio (photovoltaic array area : total ground area).",
405
- "min": 0.01
406
- },
407
- "federal_itc_pct": {
408
- "default": 0.3,
409
- "max": 1,
410
- "type": "float",
411
- "description": "Percentage of capital costs that are credited towards federal taxes",
412
- "min": 0
413
- },
414
- "pbi_max_us_dollars": {
415
- "default": 1000000000.0,
416
- "max": 1000000000.0,
417
- "type": "float",
418
- "description": "Maximum annual value of production-based incentives",
419
- "min": 0
420
- },
421
- "pbi_us_dollars_per_kwh": {
422
- "default": 0,
423
- "max": 1000000000.0,
424
- "type": "float",
425
- "description": "Production-based incentive value",
426
- "min": 0
427
- },
428
- "module_type": {
429
- "default": 0,
430
- "type": "int",
431
- "description": "PV module type (0: Standard; 1: Premium; 2: Thin Film)",
432
- "restrict_to": [0, 1, 2]
433
- },
434
- "dc_ac_ratio": {
435
- "default": 1.1,
436
- "max": 2,
437
- "type": "float",
438
- "description": "PV DC-AC ratio",
439
- "min": 0
440
- },
441
- "array_type": {
442
- "default": 1,
443
- "type": "int",
444
- "description": "PV Watts array type (0: Ground Mount Fixed (Open Rack); 1: Rooftop, Fixed; 2: Ground Mount 1-Axis Tracking; 3 : 1-Axis Backtracking; 4: Ground Mount, 2-Axis Tracking)",
445
- "restrict_to": [0, 1, 2, 3, 4]
446
- },
447
- "state_ibi_pct": {
448
- "default": 0,
449
- "max": 1,
450
- "type": "float",
451
- "description": "Percentage of capital costs offset by state incentives",
452
- "min": 0
453
- },
454
- "utility_rebate_max_us_dollars": {
455
- "default": 10000000000.0,
456
- "max": 10000000000.0,
457
- "type": "float",
458
- "description": "Maximum utility rebate",
459
- "min": 0
460
- },
461
- "utility_ibi_max_us_dollars": {
462
- "default": 10000000000.0,
463
- "max": 10000000000.0,
464
- "type": "float",
465
- "description": "Maximum dollar value of utility percentage-based capital cost incentive",
466
- "min": 0
467
- },
468
- "installed_cost_us_dollars_per_kw": {
469
- "default": 2000,
470
- "max": 100000.0,
471
- "type": "float",
472
- "description": "Installed PV cost in $/kW",
473
- "min": 0
474
- },
475
- "existing_kw": {
476
- "default": 0,
477
- "max": 100000.0,
478
- "type": "float",
479
- "description": "Existing PV size",
480
- "min": 0
481
- },
482
- "om_cost_us_dollars_per_kw": {
483
- "default": 16,
484
- "max": 1000.0,
485
- "type": "float",
486
- "description": "Annual PV operations and maintenance costs in $/kW",
487
- "min": 0
488
- },
489
- "utility_rebate_us_dollars_per_kw": {
490
- "default": 0,
491
- "max": 1000000000.0,
492
- "type": "float",
493
- "description": "Utility rebate based on installed capacity",
494
- "min": 0
495
- },
496
- "min_kw": {
497
- "default": 0,
498
- "max": 1000000000.0,
499
- "type": "float",
500
- "description": "Minimum PV size constraint for optimization",
501
- "min": 0
502
- },
503
- "tilt": {
504
- "default": 0.537,
505
- "max": 90,
506
- "type": "float",
507
- "description": "PV system tilt",
508
- "min": 0
509
- },
510
- "losses": {
511
- "default": 0.14,
512
- "max": 0.99,
513
- "type": "float",
514
- "description": "PV system performance losses",
515
- "min": 0
516
- },
517
- "macrs_itc_reduction": {
518
- "default": 0.5,
519
- "max": 1,
520
- "type": "float",
521
- "description": "Percent of the ITC value by which depreciable basis is reduced",
522
- "min": 0
523
- },
524
- "degradation_pct": {
525
- "default": 0.005,
526
- "max": 1,
527
- "type": "float",
528
- "description": "Annual rate of degradation in PV energy production",
529
- "min": 0
530
- },
531
- "federal_rebate_us_dollars_per_kw": {
532
- "default": 0,
533
- "max": 1000000000.0,
534
- "type": "float",
535
- "description": "Federal rebates based on installed capacity",
536
- "min": 0
537
- },
538
- "inv_eff": {
539
- "default": 0.96,
540
- "max": 0.995,
541
- "type": "float",
542
- "description": "PV inverter efficiency",
543
- "min": 0.9
544
- },
545
- "pbi_system_max_kw": {
546
- "default": 1000000000.0,
547
- "max": 1000000000.0,
548
- "type": "float",
549
- "description": "Maximum system size eligible for production-based incentive",
550
- "min": 0
551
- },
552
- "macrs_option_years": {
553
- "default": 5,
554
- "type": "int",
555
- "description": "Duration over which accelerated depreciation will occur. Set to zero to disable",
556
- "restrict_to": [0, 5, 7]
557
- },
558
- "radius": {
559
- "default": 0,
560
- "type": "float",
561
- "description": "Radius to use when searching for the closest climate data station. Use zero to use the closest station regardless of the distance",
562
- "min": 0
563
- },
564
- "utility_ibi_pct": {
565
- "default": 0,
566
- "max": 1,
567
- "type": "float",
568
- "description": "Percentage of capital costs offset by utility incentives",
569
- "min": 0
570
- },
571
- "state_ibi_max_us_dollars": {
572
- "default": 10000000000.0,
573
- "max": 10000000000.0,
574
- "type": "float",
575
- "description": "Maximum dollar value of state percentage-based capital cost incentive",
576
- "min": 0
577
- }
578
- }
579
- },
580
- "Storage": {
581
- "type": "object",
582
- "properties": {
583
- "total_rebate_us_dollars_per_kw": {
584
- "default": 0,
585
- "max": 1000000000.0,
586
- "type": "float",
587
- "description": "Rebate based on installed power capacity",
588
- "min": 0
589
- },
590
- "max_kwh": {
591
- "default": 1000000,
592
- "type": "float",
593
- "description": "Maximum battery energy storage capacity constraint for optimization. Set to zero to disable Storage",
594
- "min": 0
595
- },
596
- "rectifier_efficiency_pct": {
597
- "default": 0.96,
598
- "max": 1,
599
- "type": "float",
600
- "description": "Battery rectifier efficiency",
601
- "min": 0
602
- },
603
- "total_itc_pct": {
604
- "default": 0.0,
605
- "max": 1,
606
- "type": "float",
607
- "description": "Total investment tax credit in percent applied toward capital costs",
608
- "min": 0
609
- },
610
- "min_kw": {
611
- "default": 0,
612
- "max": 1000000000.0,
613
- "type": "float",
614
- "description": "Minimum battery power capacity size constraint for optimization",
615
- "min": 0
616
- },
617
- "max_kw": {
618
- "default": 1000000,
619
- "max": 1000000000.0,
620
- "type": "float",
621
- "description": "Maximum battery power capacity size constraint for optimization. Set to zero to disable storage",
622
- "min": 0
623
- },
624
- "replace_cost_us_dollars_per_kw": {
625
- "default": 460,
626
- "max": 10000.0,
627
- "type": "float",
628
- "description": "Battery power capacity replacement cost at time of replacement year",
629
- "min": 0
630
- },
631
- "replace_cost_us_dollars_per_kwh": {
632
- "default": 230,
633
- "max": 10000.0,
634
- "type": "float",
635
- "description": "Battery energy capacity replacement cost at time of replacement year",
636
- "min": 0
637
- },
638
- "min_kwh": {
639
- "default": 0,
640
- "type": "float",
641
- "description": "Minimum battery energy storage capacity constraint for optimization",
642
- "min": 0
643
- },
644
- "installed_cost_us_dollars_per_kw": {
645
- "default": 1000,
646
- "max": 10000.0,
647
- "type": "float",
648
- "description": "Total upfront battery power capacity costs (e.g. inverter and balance of power systems)",
649
- "min": 0
650
- },
651
- "battery_replacement_year": {
652
- "default": 10,
653
- "max": 75,
654
- "type": "float",
655
- "description": "Number of years from start of analysis period to replace battery",
656
- "min": 0
657
- },
658
- "installed_cost_us_dollars_per_kwh": {
659
- "default": 500,
660
- "max": 10000.0,
661
- "type": "float",
662
- "description": "Total upfront battery costs",
663
- "min": 0
664
- },
665
- "inverter_efficiency_pct": {
666
- "default": 0.96,
667
- "max": 1,
668
- "type": "float",
669
- "description": "Battery inverter efficiency",
670
- "min": 0
671
- },
672
- "macrs_itc_reduction": {
673
- "default": 0.5,
674
- "max": 1,
675
- "type": "float",
676
- "description": "Percent of the ITC value by which depreciable basis is reduced",
677
- "min": 0
678
- },
679
- "canGridCharge": {
680
- "default": true,
681
- "type": "bool",
682
- "description": "Flag to set whether the battery can be charged from the grid, or just onsite generation"
683
- },
684
- "macrs_bonus_pct": {
685
- "default": 0,
686
- "max": 1,
687
- "type": "float",
688
- "description": "Percent of upfront project costs to depreciate under MACRS in year one in addtion to scheduled depreciation",
689
- "min": 0
690
- },
691
- "inverter_replacement_year": {
692
- "default": 10,
693
- "max": 75,
694
- "type": "float",
695
- "description": "Number of years from start of analysis period to replace inverter",
696
- "min": 0
697
- },
698
- "macrs_option_years": {
699
- "default": 7,
700
- "type": "int",
701
- "description": "Duration over which accelerated depreciation will occur. Set to zero by default",
702
- "restrict_to": [0, 5, 7]
703
- },
704
- "internal_efficiency_pct": {
705
- "default": 0.975,
706
- "max": 1,
707
- "type": "float",
708
- "description": "Battery inherent efficiency independent of inverter and rectifier",
709
- "min": 0
710
- },
711
- "soc_min_pct": {
712
- "default": 0.2,
713
- "max": 1,
714
- "type": "float",
715
- "description": "Minimum allowable battery state of charge",
716
- "min": 0
717
- },
718
- "soc_init_pct": {
719
- "default": 0.5,
720
- "max": 1,
721
- "type": "float",
722
- "description": "Battery state of charge at first hour of optimization",
723
- "min": 0
724
- }
725
- }
726
- },
727
- "Wind": {
728
- "type": "object",
729
- "properties": {
730
- "pbi_years": {
731
- "default": 1,
732
- "max": 1000000000.0,
733
- "type": "float",
734
- "description": "Duration of production-based incentives from installation date",
735
- "min": 0
736
- },
737
- "macrs_bonus_pct": {
738
- "default": 0,
739
- "max": 1,
740
- "type": "float",
741
- "description": "Percent of upfront project costs to depreciate under MACRS",
742
- "min": 0
743
- },
744
- "max_kw": {
745
- "default": 0,
746
- "max": 1000000000.0,
747
- "type": "float",
748
- "description": "Maximum wind power capacity constraint for optimization. Set to zero to disable Wind. Enabled by default",
749
- "min": 0
750
- },
751
- "pbi_max_us_dollars": {
752
- "default": 1000000000.0,
753
- "max": 1000000000.0,
754
- "type": "float",
755
- "description": "Maximum rebate allowed under utility production-based incentives",
756
- "min": 0
757
- },
758
- "wind_meters_per_sec": {
759
- "type": "list_of_float",
760
- "description": "Data downloaded from Wind ToolKit for modeling wind turbine."
761
- },
762
- "state_ibi_pct": {
763
- "default": 0,
764
- "max": 1,
765
- "type": "float",
766
- "description": "Percent of upfront project costs to discount under state investment based incentives",
767
- "min": 0
768
- },
769
- "utility_rebate_max_us_dollars": {
770
- "default": 10000000000.0,
771
- "max": 10000000000.0,
772
- "type": "float",
773
- "description": "Maximum rebate allowed under utility rebates",
774
- "min": 0
775
- },
776
- "installed_cost_us_dollars_per_kw": {
777
- "default": 3013,
778
- "max": 100000.0,
779
- "type": "float",
780
- "description": "Total upfront installed costs in US dollars per kW. Determined by size_class. For the 'large' (>2MW) size_class the cost is $1,874/kW. For the 'medium commercial' size_class the cost is $4,111 per kW. For the 'small commercial' size_class the cost is $4,989 per kW and for the 'residential' size_class the cost is $10,792 per kW ",
781
- "min": 0
782
- },
783
- "utility_ibi_max_us_dollars": {
784
- "default": 10000000000.0,
785
- "max": 10000000000.0,
786
- "type": "float",
787
- "description": "Maximum rebate allowed under utility investment based incentives",
788
- "min": 0
789
- },
790
- "pressure_atmospheres": {
791
- "type": "list_of_float",
792
- "description": "Data downloaded from Wind ToolKit for modeling wind turbine."
793
- },
794
- "pbi_system_max_kw": {
795
- "default": 1000000000.0,
796
- "max": 1000000000.0,
797
- "type": "float",
798
- "description": "Maximum system size for which production-based incentives apply",
799
- "min": 0
800
- },
801
- "utility_ibi_pct": {
802
- "default": 0,
803
- "max": 1,
804
- "type": "float",
805
- "description": "Percent of upfront project costs to discount under utility investment based incentives",
806
- "min": 0
807
- },
808
- "state_ibi_max_us_dollars": {
809
- "default": 10000000000.0,
810
- "max": 10000000000.0,
811
- "type": "float",
812
- "description": "Maximum rebate allowed under state investment based incentives",
813
- "min": 0
814
- },
815
- "wind_direction_degrees": {
816
- "type": "list_of_float",
817
- "description": "Data downloaded from Wind ToolKit for modeling wind turbine."
818
- },
819
- "size_class": {
820
- "type": "str",
821
- "description": "Turbine size-class. One of [residential, commercial, medium, large]",
822
- "restrict_to": "['residential', 'commercial', 'medium', 'large']"
823
- },
824
- "state_rebate_us_dollars_per_kw": {
825
- "default": 0,
826
- "max": 1000000000.0,
827
- "type": "float",
828
- "description": "State rebates based on installed capacity",
829
- "min": 0
830
- },
831
- "macrs_option_years": {
832
- "default": 5,
833
- "type": "int",
834
- "description": "MACRS schedule for financial analysis. Set to zero to disable",
835
- "restrict_to": [0, 5, 7]
836
- },
837
- "state_rebate_max_us_dollars": {
838
- "default": 10000000000.0,
839
- "max": 10000000000.0,
840
- "type": "float",
841
- "description": "Maximum rebate allowed under state rebates",
842
- "min": 0
843
- },
844
- "federal_itc_pct": {
845
- "default": 0.3,
846
- "max": 1,
847
- "type": "float",
848
- "description": "Percent federal capital cost incentive",
849
- "min": 0
850
- },
851
- "temperature_celsius": {
852
- "type": "list_of_float",
853
- "description": "Data downloaded from Wind ToolKit for modeling wind turbine."
854
- },
855
- "pbi_us_dollars_per_kwh": {
856
- "default": 0,
857
- "max": 1000000000.0,
858
- "type": "float",
859
- "description": "Production-based incentive value",
860
- "min": 0
861
- },
862
- "om_cost_us_dollars_per_kw": {
863
- "default": 35,
864
- "max": 1000.0,
865
- "type": "float",
866
- "description": "Total annual operations and maintenance costs for wind",
867
- "min": 0
868
- },
869
- "utility_rebate_us_dollars_per_kw": {
870
- "default": 0,
871
- "max": 1000000000.0,
872
- "type": "float",
873
- "description": "Utility rebates based on installed capacity",
874
- "min": 0
875
- },
876
- "min_kw": {
877
- "default": 0,
878
- "max": 1000000000.0,
879
- "type": "float",
880
- "description": "Minimum wind power capacity constraint for optimization",
881
- "min": 0
882
- },
883
- "macrs_itc_reduction": {
884
- "default": 0.5,
885
- "max": 1,
886
- "type": "float",
887
- "description": "Percent of the full ITC that depreciable basis is reduced by",
888
- "min": 0
889
- },
890
- "federal_rebate_us_dollars_per_kw": {
891
- "default": 0,
892
- "max": 1000000000.0,
893
- "type": "float",
894
- "description": "Federal rebate based on installed capacity",
895
- "min": 0
896
- }
897
- }
898
- },
899
- "Generator": {
900
- "type": "object",
901
- "properties": {
902
- "pbi_years": {
903
- "default": 0,
904
- "max": 1000000000.0,
905
- "type": "float",
906
- "description": "Duration of production-based incentives from installation date",
907
- "min": 0
908
- },
909
- "macrs_bonus_pct": {
910
- "default": 0,
911
- "max": 1,
912
- "type": "float",
913
- "description": "Percent of upfront project costs to depreciate under MACRS",
914
- "min": 0
915
- },
916
- "om_cost_us_dollars_per_kwh": {
917
- "default": 0.01,
918
- "max": 1000.0,
919
- "type": "float",
920
- "description": "diesel generator per unit production (variable) operations and maintenance costs in $/kWh",
921
- "min": 0
922
- },
923
- "max_kw": {
924
- "default": 1000000000.0,
925
- "max": 1000000000.0,
926
- "type": "float",
927
- "description": "Maximum diesel generator size constraint for optimization. Set to zero to disable gen",
928
- "min": 0
929
- },
930
- "pbi_max_us_dollars": {
931
- "default": 0,
932
- "max": 1000000000.0,
933
- "type": "float",
934
- "description": "Maximum rebate allowed under utility production-based incentives",
935
- "min": 0
936
- },
937
- "state_ibi_pct": {
938
- "default": 0,
939
- "max": 1,
940
- "type": "float",
941
- "description": "Percent of upfront project costs to discount under state investment based incentives",
942
- "min": 0
943
- },
944
- "fuel_intercept_gal_per_hr": {
945
- "default": 0,
946
- "max": 10,
947
- "type": "float",
948
- "description": "Generator fuel consumption curve y-intercept in gallons per hour.",
949
- "min": 0
950
- },
951
- "generator_only_runs_during_grid_outage": {
952
- "default": true,
953
- "type": "bool",
954
- "description": "If there is existing diesel generator, must specify whether it should run only during grid outage or all the time in the bau case."
955
- },
956
- "utility_rebate_max_us_dollars": {
957
- "default": 0,
958
- "max": 10000000000.0,
959
- "type": "float",
960
- "description": "Maximum rebate allowed under utility rebates",
961
- "min": 0
962
- },
963
- "installed_cost_us_dollars_per_kw": {
964
- "default": 600,
965
- "max": 100000.0,
966
- "type": "float",
967
- "description": "Installed diesel generator cost in $/kW",
968
- "min": 0
969
- },
970
- "utility_ibi_max_us_dollars": {
971
- "default": 0,
972
- "max": 10000000000.0,
973
- "type": "float",
974
- "description": "Maximum rebate allowed under utility investment based incentives",
975
- "min": 0
976
- },
977
- "fuel_avail_gal": {
978
- "default": 1000000000.0,
979
- "max": 1000000000.0,
980
- "type": "float",
981
- "description": "On-site generator fuel available in gallons.",
982
- "min": 0
983
- },
984
- "min_turn_down_pct": {
985
- "default": 0,
986
- "max": 1,
987
- "type": "float",
988
- "description": "Minimum generator loading in percent of capacity (size_kw).",
989
- "min": 0
990
- },
991
- "pbi_system_max_kw": {
992
- "default": 0,
993
- "max": 1000000000.0,
994
- "type": "float",
995
- "description": "Maximum system size for which production-based incentives apply",
996
- "min": 0
997
- },
998
- "utility_ibi_pct": {
999
- "default": 0,
1000
- "max": 1,
1001
- "type": "float",
1002
- "description": "Percent of upfront project costs to discount under utility investment based incentives",
1003
- "min": 0
1004
- },
1005
- "state_ibi_max_us_dollars": {
1006
- "default": 0,
1007
- "max": 10000000000.0,
1008
- "type": "float",
1009
- "description": "Maximum rebate allowed under state investment based incentives",
1010
- "min": 0
1011
- },
1012
- "diesel_fuel_cost_us_dollars_per_gallon": {
1013
- "default": 3,
1014
- "max": 100.0,
1015
- "type": "float",
1016
- "description": "diesel cost in $/gallon",
1017
- "min": 0
1018
- },
1019
- "fuel_slope_gal_per_kwh": {
1020
- "default": 0,
1021
- "max": 10,
1022
- "type": "float",
1023
- "description": "Generator fuel burn rate in gallons/kWh.",
1024
- "min": 0
1025
- },
1026
- "state_rebate_us_dollars_per_kw": {
1027
- "default": 0,
1028
- "max": 1000000000.0,
1029
- "type": "float",
1030
- "description": "State rebates based on installed capacity",
1031
- "min": 0
1032
- },
1033
- "macrs_option_years": {
1034
- "default": 0,
1035
- "type": "int",
1036
- "description": "MACRS schedule for financial analysis. Set to zero to disable",
1037
- "restrict_to": [0, 5, 7]
1038
- },
1039
- "state_rebate_max_us_dollars": {
1040
- "default": 0,
1041
- "max": 10000000000.0,
1042
- "type": "float",
1043
- "description": "Maximum rebate allowed under state rebates",
1044
- "min": 0
1045
- },
1046
- "federal_itc_pct": {
1047
- "default": 0,
1048
- "max": 1,
1049
- "type": "float",
1050
- "description": "Percent federal capital cost incentive",
1051
- "min": 0
1052
- },
1053
- "pbi_us_dollars_per_kwh": {
1054
- "default": 0,
1055
- "max": 1000000000.0,
1056
- "type": "float",
1057
- "description": "Production-based incentive value",
1058
- "min": 0
1059
- },
1060
- "existing_kw": {
1061
- "default": 0,
1062
- "max": 100000.0,
1063
- "type": "float",
1064
- "description": "Existing diesel generator size",
1065
- "min": 0
1066
- },
1067
- "om_cost_us_dollars_per_kw": {
1068
- "default": 10,
1069
- "max": 1000.0,
1070
- "type": "float",
1071
- "description": "Annual diesel generator fixed operations and maintenance costs in $/kW",
1072
- "min": 0
1073
- },
1074
- "utility_rebate_us_dollars_per_kw": {
1075
- "default": 0,
1076
- "max": 1000000000.0,
1077
- "type": "float",
1078
- "description": "Utility rebates based on installed capacity",
1079
- "min": 0
1080
- },
1081
- "min_kw": {
1082
- "default": 0,
1083
- "max": 1000000000.0,
1084
- "type": "float",
1085
- "description": "Minimum diesel generator size constraint for optimization",
1086
- "min": 0
1087
- },
1088
- "macrs_itc_reduction": {
1089
- "default": 0,
1090
- "max": 1,
1091
- "type": "float",
1092
- "description": "Percent of the full ITC that depreciable basis is reduced by",
1093
- "min": 0
1094
- },
1095
- "federal_rebate_us_dollars_per_kw": {
1096
- "default": 0,
1097
- "max": 1000000000.0,
1098
- "type": "float",
1099
- "description": "Federal rebate based on installed capacity",
1100
- "min": 0
1101
- },
1102
- "generator_sells_energy_back_to_grid": {
1103
- "default": false,
1104
- "type": "bool",
1105
- "description": "If there is existing diesel generator, must specify whether it should run only during grid outage or all the time in the bau case."
1106
- }
1107
- }
1108
- }
1109
- }
1110
- }
6
+ "user_uuid": {
7
+ "type": "string",
8
+ "description": "The assigned unique ID of a signed in REOpt user"
9
+ },
10
+ "Meta": {
11
+ "type": "object",
12
+ "properties": {
13
+ "description": {
14
+ "type": "string",
15
+ "description": "An optional user defined description to describe the scenario and run"
16
+ },
17
+ "address": {
18
+ "type": "string",
19
+ "description": "A user defined address as optional metadata (street address, city, state or zip code)"
20
+ }
21
+ }
22
+ },
23
+ "Settings": {
24
+ "type": "object",
25
+ "properties": {
26
+ "time_steps_per_hour": {
27
+ "default": 1,
28
+ "min": 1,
29
+ "max": 4,
30
+ "type": "integer",
31
+ "description": "The number of time steps per hour in the REopt simulation"
32
+ },
33
+ "timeout_seconds": {
34
+ "default": 295,
35
+ "min": 1,
36
+ "max": 295,
37
+ "type": "number",
38
+ "description": "The number of seconds allowed before the optimization times out"
39
+ },
40
+ "optimality_tolerance": {
41
+ "default": 0.001,
42
+ "min": 0.000005,
43
+ "max": 0.2,
44
+ "type": "number",
45
+ "description": "The threshold for the difference between the solution's objective value and the best possible value at which the solver terminates"
46
+ }
47
+ }
48
+ },
49
+ "Site": {
50
+ "type": "object",
51
+ "properties": {
52
+ "latitude": {
53
+ "min": -90,
54
+ "max": 90,
55
+ "type": "number",
56
+ "description": "The approximate latitude of the site in decimal degrees"
57
+ },
58
+ "longitude": {
59
+ "min": -180,
60
+ "max": 180,
61
+ "type": "number",
62
+ "description": "The approximate longitude of the site in decimal degrees"
63
+ },
64
+ "land_acres": {
65
+ "min": 0,
66
+ "max": 1000000.0,
67
+ "type": "number",
68
+ "description": "Land area in acres available for PV panel siting"
69
+ },
70
+ "roof_squarefeet": {
71
+ "min": 0,
72
+ "max": 1000000000.0,
73
+ "type": "number",
74
+ "description": "Area of roof in square feet available for PV siting"
75
+ }
76
+ },
77
+ "required": [
78
+ "latitude",
79
+ "longitude"
80
+ ]
81
+ },
82
+ "Financial": {
83
+ "type": "object",
84
+ "properties": {
85
+ "elec_cost_escalation_rate_fraction": {
86
+ "default": 0.026,
87
+ "min": -1,
88
+ "max": 1,
89
+ "type": "number",
90
+ "description": "Annual nominal utility electricity cost escalation rate"
91
+ },
92
+ "offtaker_discount_rate_fraction": {
93
+ "default": 0.081,
94
+ "min": 0,
95
+ "max": 1,
96
+ "type": "number",
97
+ "description": "Nominal host discount rate"
98
+ },
99
+ "value_of_lost_load_per_kwh": {
100
+ "default": 100,
101
+ "min": 0,
102
+ "max": 1000000.0,
103
+ "type": "number",
104
+ "description": "Value placed on unmet site load during grid outages. Units are US dollars per unmet kilowatt-hour. The value of lost load (VoLL) is used to determine the avoided outage costs by multiplying VoLL [$/kWh] with the average number of hours that the critical load can be met by the energy system (determined by simulating outages occuring at every hour of the year), and multiplying by the mean critical load."
105
+ },
106
+ "analysis_years": {
107
+ "default": 20,
108
+ "max": 75,
109
+ "type": "integer",
110
+ "description": "Analysis period"
111
+ },
112
+ "microgrid_upgrade_cost_fraction": {
113
+ "default": 0.3,
114
+ "min": 0,
115
+ "max": 1,
116
+ "type": "number",
117
+ "description": "Additional cost, in fraction of non-islandable capital costs, to make a distributed energy system islandable from the grid and able to serve critical loads. Includes all upgrade costs such as additional laber and critical load panels."
118
+ },
119
+ "offtaker_tax_rate_fraction": {
120
+ "default": 0.26,
121
+ "min": 0,
122
+ "max": 1,
123
+ "type": "number",
124
+ "description": "Host tax rate"
125
+ },
126
+ "om_cost_escalation_rate_fraction": {
127
+ "default": 0.025,
128
+ "min": -1,
129
+ "max": 1,
130
+ "type": "number",
131
+ "description": "Annual nominal O&M cost escalation rate"
132
+ }
133
+ }
134
+ },
135
+ "ElectricTariff": {
136
+ "type": "object",
137
+ "properties": {
138
+ "add_monthly_rates_to_urdb_rate": {
139
+ "default": false,
140
+ "type": "boolean",
141
+ "description": "Set to 'true' to add the monthly blended energy rates and demand charges to the URDB rate schedule. Otherwise, blended rates will only be considered if a URDB rate is not provided. "
142
+ },
143
+ "coincident_peak_load_active_time_steps": {
144
+ "default": 0,
145
+ "min": 0,
146
+ "max": 1000000000.0,
147
+ "type": "integer",
148
+ "description": "The optional coincident_peak_load_charge_per_kw will apply to the max grid-purchased power during these time steps. Note time steps are indexed to a base of 1 not 0."
149
+ },
150
+ "coincident_peak_load_charge_per_kw": {
151
+ "default": 0,
152
+ "min": 0,
153
+ "max": 1000000000.0,
154
+ "type": "integer",
155
+ "description": "Optional coincident peak demand charge that is applied to the max load during the time_steps specified in coincident_peak_load_active_time_steps"
156
+ },
157
+ "wholesale_rate": {
158
+ "default": 0,
159
+ "min": 0,
160
+ "type": "number",
161
+ "description": "Price of electricity sold back to the grid in absence of net metering or above net metering limit, restricted to total site load"
162
+ },
163
+ "export_rate_beyond_net_metering_limit": {
164
+ "default": 0,
165
+ "min": 0,
166
+ "type": "number",
167
+ "description": "Price of electricity sold back to the grid above the site load, regardless of net metering"
168
+ },
169
+ "urdb_response": {
170
+ "replacement_sets": [
171
+ ["urdb_response"],
172
+ ["monthly_demand_rates", "monthly_energy_rates"],
173
+ ["blended_annual_demand_rate", "blended_annual_energy_rate"],
174
+ ["urdb_label"],
175
+ ["urdb_utility_name", "urdb_rate_name"]
176
+ ],
177
+ "type": "object",
178
+ "description": "Utility rate structure from <a href='https: //openei.org/services/doc/rest/util_rates/?version=3' target='blank'>Utility Rate Database API</a>"
179
+ },
180
+ "blended_annual_demand_rate": {
181
+ "replacement_sets": [
182
+ ["urdb_response"],
183
+ ["monthly_demand_rates", "monthly_energy_rates"],
184
+ ["blended_annual_demand_rate", "blended_annual_energy_rate"],
185
+ ["urdb_label"],
186
+ ["urdb_utility_name", "urdb_rate_name"]
187
+ ],
188
+ "type": "number",
189
+ "description": "Annual blended demand rates (annual demand charge cost in $ divided by annual peak demand in kW)",
190
+ "depends_on": ["blended_annual_energy_rate"]
191
+ },
192
+ "blended_annual_energy_rate": {
193
+ "replacement_sets": [
194
+ ["urdb_response"],
195
+ ["monthly_demand_rates", "monthly_energy_rates"],
196
+ ["blended_annual_demand_rate", "blended_annual_energy_rate"],
197
+ ["urdb_label"],
198
+ ["urdb_utility_name", "urdb_rate_name"]
199
+ ],
200
+ "type": "number",
201
+ "description": "Annual blended energy rate (total annual energy in kWh divided by annual cost in $)",
202
+ "depends_on": ["blended_annual_demand_rate"]
203
+ },
204
+ "monthly_demand_rates": {
205
+ "replacement_sets": [
206
+ ["urdb_response"],
207
+ ["monthly_demand_rates", "monthly_energy_rates"],
208
+ ["blended_annual_demand_rate", "blended_annual_energy_rate"],
209
+ ["urdb_label"],
210
+ ["urdb_utility_name", "urdb_rate_name"]
211
+ ],
212
+ "type": "array",
213
+ "description": "Array (length of 12) of blended demand charges (demand charge cost in $ divided by monthly peak demand in kW)",
214
+ "depends_on": ["monthly_energy_rates"]
215
+ },
216
+ "urdb_utility_name": {
217
+ "replacement_sets": [
218
+ ["urdb_response"],
219
+ ["monthly_demand_rates", "monthly_energy_rates"],
220
+ ["blended_annual_demand_rate", "blended_annual_energy_rate"],
221
+ ["urdb_label"],
222
+ ["urdb_utility_name", "urdb_rate_name"]
223
+ ],
224
+ "type": "string",
225
+ "description": "Name of Utility from <a href='https: //openei.org/wiki/Utility_Rate_Database' target='blank'>Utility Rate Database</a>",
226
+ "depends_on": ["urdb_rate_name"]
227
+ },
228
+ "urdb_label": {
229
+ "replacement_sets": [
230
+ ["urdb_response"],
231
+ ["monthly_demand_rates", "monthly_energy_rates"],
232
+ ["blended_annual_demand_rate", "blended_annual_energy_rate"],
233
+ ["urdb_label"],
234
+ ["urdb_utility_name", "urdb_rate_name"]
235
+ ],
236
+ "type": "string",
237
+ "description": "Label attribute of utility rate structure from <a href='https: //openei.org/services/doc/rest/util_rates/?version=3' target='blank'>Utility Rate Database API</a>"
238
+ },
239
+ "urdb_rate_name": {
240
+ "replacement_sets": [
241
+ ["urdb_response"],
242
+ ["monthly_demand_rates", "monthly_energy_rates"],
243
+ ["blended_annual_demand_rate", "blended_annual_energy_rate"],
244
+ ["urdb_label"],
245
+ ["urdb_utility_name", "urdb_rate_name"]
246
+ ],
247
+ "type": "string",
248
+ "description": "Name of utility rate from <a href='https: //openei.org/wiki/Utility_Rate_Database' target='blank'>Utility Rate Database</a>",
249
+ "depends_on": ["urdb_utility_name"]
250
+ },
251
+ "monthly_energy_rates": {
252
+ "replacement_sets": [
253
+ ["urdb_response"],
254
+ ["monthly_demand_rates", "monthly_energy_rates"],
255
+ ["blended_annual_demand_rate", "blended_annual_energy_rate"],
256
+ ["urdb_label"],
257
+ ["urdb_utility_name", "urdb_rate_name"]
258
+ ],
259
+ "type": "array",
260
+ "description": "Array (length of 12) of blended energy rates (total monthly energy in kWh divided by monthly cost in $)",
261
+ "depends_on": ["monthly_demand_rates"]
262
+ }
263
+ }
264
+ },
265
+ "ElectricUtility": {
266
+ "type": "object",
267
+ "properties": {
268
+ "interconnection_limit_kw": {
269
+ "default": 100000000.0,
270
+ "min": 0,
271
+ "max": 1000000000.0,
272
+ "type": "number",
273
+ "description": "Limit on system capacity size that can be interconnected to the grid"
274
+ },
275
+ "net_metering_limit_kw": {
276
+ "default": 0,
277
+ "min": 0,
278
+ "max": 1000000000.0,
279
+ "type": "number",
280
+ "description": "System size above which net metering is not allowed"
281
+ }
282
+ }
283
+ },
284
+ "ElectricLoad": {
285
+ "type": "object",
286
+ "properties": {
287
+ "critical_load_fraction": {
288
+ "default": 0.5,
289
+ "min": 0,
290
+ "max": 1,
291
+ "type": "number",
292
+ "description": "Critical load factor is multiplied by the typical load to determine the critical load that must be met during an outage. Value must be between zero and one, inclusive."
293
+ },
294
+ "outage_start_hour": {
295
+ "min": 0,
296
+ "max": 8759,
297
+ "type": "integer",
298
+ "description": "Hour of year that grid outage starts. Must be less than outage_end."
299
+ },
300
+ "outage_end_hour": {
301
+ "min": 0,
302
+ "max": 8759,
303
+ "type": "integer",
304
+ "description": "Hour of year that grid outage ends. Must be greater than outage_start."
305
+ },
306
+ "monthly_totals_kwh": {
307
+ "replacement_sets": [
308
+ ["loads_kw"],
309
+ ["doe_reference_name", "monthly_totals_kwh"],
310
+ ["annual_kwh", "doe_reference_name"],
311
+ ["doe_reference_name"]
312
+ ],
313
+ "type": "array",
314
+ "description": "Array (length of 12) of total monthly energy consumption used to scale simulated building load profile.",
315
+ "depends_on": ["doe_reference_name"]
316
+ },
317
+ "year": {
318
+ "default": 2018,
319
+ "min": 1,
320
+ "max": 9999,
321
+ "type": "integer",
322
+ "description": "Year of Custom Load Profile. If a custom load profile is uploaded via the loads_kw parameter, it is important that this year correlates with the load profile so that weekdays/weekends are determined correctly for the utility rate tariff. If a DOE Reference Building profile (aka simulated profile) is used, the year is set to 2017 since the DOE profiles start on a Sunday."
323
+ },
324
+ "loads_kw": {
325
+ "replacement_sets": [
326
+ ["loads_kw"],
327
+ ["doe_reference_name", "monthly_totals_kwh"],
328
+ ["annual_kwh", "doe_reference_name"],
329
+ ["doe_reference_name"]
330
+ ],
331
+ "type": "array",
332
+ "description": "Typical load over all hours in one year. Must be hourly (8,760 samples), 30 minute (17,520 samples), or 15 minute (35,040 samples)."
333
+ },
334
+ "critical_loads_kw_is_net": {
335
+ "default": false,
336
+ "type": "boolean",
337
+ "description": "If there is existing PV, must specify whether provided load is the net load after existing PV or not."
338
+ },
339
+ "loads_kw_is_net": {
340
+ "default": true,
341
+ "type": "boolean",
342
+ "description": "If there is existing PV, must specify whether provided load is the net load after existing PV or not."
343
+ },
344
+ "annual_kwh": {
345
+ "type": "number",
346
+ "description": "Annual energy consumption used to scale simulated building load profile, if <b><small>monthly_totals_kwh</b></small> is not provided.",
347
+ "min": 1,
348
+ "max": 1000000000000.0,
349
+ "depends_on": ["doe_reference_name"],
350
+ "replacement_sets": [
351
+ ["loads_kw"],
352
+ ["doe_reference_name", "monthly_totals_kwh"],
353
+ ["annual_kwh", "doe_reference_name"],
354
+ ["doe_reference_name"]
355
+ ]
356
+ },
357
+ "doe_reference_name": {
358
+ "replacement_sets": [
359
+ ["loads_kw"],
360
+ ["doe_reference_name", "monthly_totals_kwh"],
361
+ ["annual_kwh", "doe_reference_name"],
362
+ ["doe_reference_name"]
363
+ ],
364
+ "type": "string",
365
+ "description": "Simulated load profile from DOE <a href='https: //energy.gov/eere/buildings/commercial-reference-buildings' target='blank'>Commercial Reference Buildings</a>",
366
+ "restrict_to": ["FastFoodRest", "FullServiceRest", "Hospital", "LargeHotel", "LargeOffice", "MediumOffice", "MidriseApartment", "Outpatient", "PrimarySchool", "RetailStore", "SecondarySchool", "SmallHotel", "SmallOffice", "StripMall", "Supermarket", "Warehouse", "FlatLoad"]
367
+ },
368
+ "critical_loads_kw": {
369
+ "type": "array",
370
+ "description": "Critical load during an outage period. Must be hourly (8,760 samples), 30 minute (17,520 samples), or 15 minute (35,040 samples)."
371
+ }
372
+ }
373
+ },
374
+ "PV": {
375
+ "type": "object",
376
+ "properties": {
377
+ "pbi_years": {
378
+ "default": 1,
379
+ "min": 0,
380
+ "max": 100,
381
+ "type": "number",
382
+ "description": "Duration of production-based incentives from installation date"
383
+ },
384
+ "macrs_bonus_fraction": {
385
+ "default": 0,
386
+ "min": 0,
387
+ "max": 1,
388
+ "type": "number",
389
+ "description": "Fraction of upfront project costs to depreciate in year one in addition to scheduled depreciation"
390
+
391
+ },
392
+ "state_rebate_per_kw": {
393
+ "default": 0,
394
+ "min": 0,
395
+ "max": 1000000000.0,
396
+ "type": "number",
397
+ "description": "State rebate based on installed capacity"
398
+ },
399
+ "location": {
400
+ "default": "roof",
401
+ "type": "string",
402
+ "description": "Indicates location of PV. Available options are roof and ground."
403
+ },
404
+ "max_kw": {
405
+ "default": 1000000000.0,
406
+ "min": 0,
407
+ "max": 1000000000.0,
408
+ "type": "number",
409
+ "description": "Maximum PV size constraint for optimization. Set to zero to disable PV"
410
+ },
411
+ "azimuth": {
412
+ "default": 180,
413
+ "min": 0,
414
+ "max": 360,
415
+ "type": "number",
416
+ "description": "PV azimuth angle"
417
+ },
418
+ "state_rebate_max": {
419
+ "default": 10000000000.0,
420
+ "min": 0,
421
+ "max": 10000000000.0,
422
+ "type": "number",
423
+ "description": "Maximum state rebate"
424
+ },
425
+ "gcr": {
426
+ "default": 0.4,
427
+ "min": 0.01,
428
+ "max": 0.99,
429
+ "type": "number",
430
+ "description": "PV ground cover ratio (photovoltaic array area : total ground area)."
431
+ },
432
+ "federal_itc_fraction": {
433
+ "default": 0.3,
434
+ "min": 0,
435
+ "max": 1,
436
+ "type": "number",
437
+ "description": "Fraction of capital costs that are credited towards federal taxes"
438
+ },
439
+ "production_incentive_max_benefit": {
440
+ "default": 1000000000.0,
441
+ "min": 0,
442
+ "max": 1000000000.0,
443
+ "type": "number",
444
+ "description": "Maximum annual value of production-based incentives"
445
+ },
446
+ "production_incentive_per_kwh": {
447
+ "default": 0,
448
+ "min": 0,
449
+ "max": 1000000000.0,
450
+ "type": "number",
451
+ "description": "Production-based incentive value"
452
+ },
453
+ "module_type": {
454
+ "default": 0,
455
+ "type": "integer",
456
+ "description": "PV module type (0: Standard; 1: Premium; 2: Thin Film)",
457
+ "restrict_to": [0, 1, 2]
458
+ },
459
+ "dc_ac_ratio": {
460
+ "default": 1.1,
461
+ "min": 0,
462
+ "max": 2,
463
+ "type": "number",
464
+ "description": "PV DC-AC ratio"
465
+ },
466
+ "array_type": {
467
+ "default": 1,
468
+ "type": "integer",
469
+ "description": "PV Watts array type (0: Ground Mount Fixed (Open Rack); 1: Rooftop, Fixed; 2: Ground Mount 1-Axis Tracking; 3 : 1-Axis Backtracking; 4: Ground Mount, 2-Axis Tracking)",
470
+ "restrict_to": [0, 1, 2, 3, 4]
471
+ },
472
+ "state_ibi_fraction": {
473
+ "default": 0,
474
+ "min": 0,
475
+ "max": 1,
476
+ "type": "number",
477
+ "description": "Fraction of capital costs offset by state incentives"
478
+ },
479
+ "utility_rebate_max": {
480
+ "default": 10000000000.0,
481
+ "min": 0,
482
+ "max": 10000000000.0,
483
+ "type": "number",
484
+ "description": "Maximum utility rebate"
485
+ },
486
+ "utility_ibi_max": {
487
+ "default": 10000000000.0,
488
+ "min": 0,
489
+ "max": 10000000000.0,
490
+ "type": "number",
491
+ "description": "Maximum dollar value of utility percentage-based capital cost incentive"
492
+ },
493
+ "installed_cost_per_kw": {
494
+ "default": 2000,
495
+ "min": 0,
496
+ "max": 100000.0,
497
+ "type": "number",
498
+ "description": "Installed PV cost in $/kW"
499
+ },
500
+ "existing_kw": {
501
+ "default": 0,
502
+ "min": 0,
503
+ "max": 100000.0,
504
+ "type": "number",
505
+ "description": "Existing PV size"
506
+ },
507
+ "om_cost_per_kw": {
508
+ "default": 16,
509
+ "min": 0,
510
+ "max": 1000.0,
511
+ "type": "number",
512
+ "description": "Annual PV operations and maintenance costs in $/kW"
513
+ },
514
+ "utility_rebate_per_kw": {
515
+ "default": 0,
516
+ "min": 0,
517
+ "max": 1000000000.0,
518
+ "type": "number",
519
+ "description": "Utility rebate based on installed capacity"
520
+ },
521
+ "min_kw": {
522
+ "default": 0,
523
+ "min": 0,
524
+ "max": 1000000000.0,
525
+ "type": "number",
526
+ "description": "Minimum PV size constraint for optimization"
527
+ },
528
+ "tilt": {
529
+ "default": 0.537,
530
+ "min": 0,
531
+ "max": 90,
532
+ "type": "number",
533
+ "description": "PV system tilt"
534
+ },
535
+ "losses": {
536
+ "default": 0.14,
537
+ "min": 0,
538
+ "max": 0.99,
539
+ "type": "number",
540
+ "description": "PV system performance losses"
541
+ },
542
+ "macrs_itc_reduction": {
543
+ "default": 0.5,
544
+ "min": 0,
545
+ "max": 1,
546
+ "type": "number",
547
+ "description": "Fraction of the ITC value by which depreciable basis is reduced"
548
+ },
549
+ "degradation_fraction": {
550
+ "default": 0.005,
551
+ "min": 0,
552
+ "max": 1,
553
+ "type": "number",
554
+ "description": "Annual rate of degradation in PV energy production"
555
+ },
556
+ "federal_rebate_per_kw": {
557
+ "default": 0,
558
+ "min": 0,
559
+ "max": 1000000000.0,
560
+ "type": "number",
561
+ "description": "Federal rebates based on installed capacity"
562
+ },
563
+ "inv_eff": {
564
+ "default": 0.96,
565
+ "min": 0.9,
566
+ "max": 0.995,
567
+ "type": "number",
568
+ "description": "PV inverter efficiency"
569
+ },
570
+ "pbi_system_max_kw": {
571
+ "default": 1000000000.0,
572
+ "min": 0,
573
+ "max": 1000000000.0,
574
+ "type": "number",
575
+ "description": "Maximum system size eligible for production-based incentive"
576
+ },
577
+ "macrs_option_years": {
578
+ "default": 5,
579
+ "type": "integer",
580
+ "description": "Duration over which accelerated depreciation will occur. Set to zero to disable",
581
+ "restrict_to": [0, 5, 7]
582
+ },
583
+ "radius": {
584
+ "default": 0,
585
+ "min": 0,
586
+ "type": "number",
587
+ "description": "Radius to use when searching for the closest climate data station. Use zero to use the closest station regardless of the distance"
588
+ },
589
+ "utility_ibi_fraction": {
590
+ "default": 0,
591
+ "min": 0,
592
+ "max": 1,
593
+ "type": "number",
594
+ "description": "Fraction of capital costs offset by utility incentives"
595
+ },
596
+ "state_ibi_max": {
597
+ "default": 10000000000.0,
598
+ "min": 0,
599
+ "max": 10000000000.0,
600
+ "type": "number",
601
+ "description": "Maximum dollar value of state percentage-based capital cost incentive"
602
+ }
603
+ }
604
+ },
605
+ "ElectricStorage": {
606
+ "type": "object",
607
+ "properties": {
608
+ "total_rebate_per_kw": {
609
+ "default": 0,
610
+ "min": 0,
611
+ "max": 1000000000.0,
612
+ "type": "number",
613
+ "description": "Rebate based on installed power capacity"
614
+ },
615
+ "max_kwh": {
616
+ "default": 1000000,
617
+ "min": 0,
618
+ "type": "number",
619
+ "description": "Maximum battery energy storage capacity constraint for optimization. Set to zero to disable Storage"
620
+ },
621
+ "rectifier_efficiency_fraction": {
622
+ "default": 0.96,
623
+ "min": 0,
624
+ "max": 1,
625
+ "type": "number",
626
+ "description": "Battery rectifier efficiency"
627
+ },
628
+ "total_itc_fraction": {
629
+ "default": 0.0,
630
+ "min": 0,
631
+ "max": 1,
632
+ "type": "number",
633
+ "description": "Total investment tax credit in fraction applied toward capital costs"
634
+ },
635
+ "min_kw": {
636
+ "default": 0,
637
+ "min": 0,
638
+ "max": 1000000000.0,
639
+ "type": "number",
640
+ "description": "Minimum battery power capacity size constraint for optimization"
641
+ },
642
+ "max_kw": {
643
+ "default": 1000000,
644
+ "min": 0,
645
+ "max": 1000000000.0,
646
+ "type": "number",
647
+ "description": "Maximum battery power capacity size constraint for optimization. Set to zero to disable storage"
648
+ },
649
+ "replace_cost_per_kw": {
650
+ "default": 460,
651
+ "min": 0,
652
+ "max": 10000.0,
653
+ "type": "number",
654
+ "description": "Battery power capacity replacement cost at time of replacement year"
655
+ },
656
+ "replace_cost_per_kwh": {
657
+ "default": 230,
658
+ "min": 0,
659
+ "max": 10000.0,
660
+ "type": "number",
661
+ "description": "Battery energy capacity replacement cost at time of replacement year"
662
+ },
663
+ "min_kwh": {
664
+ "default": 0,
665
+ "min": 0,
666
+ "type": "number",
667
+ "description": "Minimum battery energy storage capacity constraint for optimization"
668
+ },
669
+ "installed_cost_per_kw": {
670
+ "default": 1000,
671
+ "min": 0,
672
+ "max": 10000.0,
673
+ "type": "number",
674
+ "description": "Total upfront battery power capacity costs (e.g. inverter and balance of power systems)"
675
+ },
676
+ "battery_replacement_year": {
677
+ "default": 10,
678
+ "min": 0,
679
+ "max": 75,
680
+ "type": "number",
681
+ "description": "Number of years from start of analysis period to replace battery"
682
+ },
683
+ "installed_cost_per_kwh": {
684
+ "default": 500,
685
+ "min": 0,
686
+ "max": 10000.0,
687
+ "type": "number",
688
+ "description": "Total upfront battery costs"
689
+ },
690
+ "inverter_efficiency_fraction": {
691
+ "default": 0.96,
692
+ "min": 0,
693
+ "max": 1,
694
+ "type": "number",
695
+ "description": "Battery inverter efficiency"
696
+ },
697
+ "macrs_itc_reduction": {
698
+ "default": 0.5,
699
+ "min": 0,
700
+ "max": 1,
701
+ "type": "number",
702
+ "description": "Fraction of the ITC value by which depreciable basis is reduced"
703
+ },
704
+ "canGridCharge": {
705
+ "default": true,
706
+ "type": "boolean",
707
+ "description": "Flag to set whether the battery can be charged from the grid, or just onsite generation"
708
+ },
709
+ "macrs_bonus_fraction": {
710
+ "default": 0,
711
+ "min": 0,
712
+ "max": 1,
713
+ "type": "number",
714
+ "description": "Fraction of upfront project costs to depreciate under MACRS in year one in addtion to scheduled depreciation"
715
+ },
716
+ "inverter_replacement_year": {
717
+ "default": 10,
718
+ "min": 0,
719
+ "max": 75,
720
+ "type": "number",
721
+ "description": "Number of years from start of analysis period to replace inverter"
722
+ },
723
+ "macrs_option_years": {
724
+ "default": 7,
725
+ "type": "integer",
726
+ "description": "Duration over which accelerated depreciation will occur. Set to zero to disable",
727
+ "restrict_to": [0, 5, 7]
728
+ },
729
+ "internal_efficiency_fraction": {
730
+ "default": 0.975,
731
+ "min": 0,
732
+ "max": 1,
733
+ "type": "number",
734
+ "description": "Battery inherent efficiency independent of inverter and rectifier"
735
+ },
736
+ "soc_min_fraction": {
737
+ "default": 0.2,
738
+ "min": 0,
739
+ "max": 1,
740
+ "type": "number",
741
+ "description": "Minimum allowable battery state of charge"
742
+ },
743
+ "soc_init_fraction": {
744
+ "default": 0.5,
745
+ "min": 0,
746
+ "max": 1,
747
+ "type": "number",
748
+ "description": "Battery state of charge at first hour of optimization"
749
+ }
750
+ }
751
+ },
752
+ "Wind": {
753
+ "type": "object",
754
+ "properties": {
755
+ "pbi_years": {
756
+ "default": 1,
757
+ "min": 0,
758
+ "max": 1000000000.0,
759
+ "type": "number",
760
+ "description": "Duration of production-based incentives from installation date"
761
+ },
762
+ "macrs_bonus_fraction": {
763
+ "default": 0,
764
+ "min": 0,
765
+ "max": 1,
766
+ "type": "number",
767
+ "description": "Fraction of upfront project costs to depreciate under MACRS"
768
+ },
769
+ "max_kw": {
770
+ "default": 0,
771
+ "min": 0,
772
+ "max": 1000000000.0,
773
+ "type": "number",
774
+ "description": "Maximum wind power capacity constraint for optimization. Set to zero to disable Wind. Enabled by default"
775
+ },
776
+ "production_incentive_max_benefit": {
777
+ "default": 1000000000.0,
778
+ "min": 0,
779
+ "max": 1000000000.0,
780
+ "type": "number",
781
+ "description": "Maximum rebate allowed under utility production-based incentives"
782
+ },
783
+ "wind_meters_per_sec": {
784
+ "type": "array",
785
+ "description": "Data downloaded from Wind ToolKit for modeling wind turbine."
786
+ },
787
+ "state_ibi_fraction": {
788
+ "default": 0,
789
+ "min": 0,
790
+ "max": 1,
791
+ "type": "number",
792
+ "description": "Fraction of upfront project costs to discount under state investment based incentives"
793
+ },
794
+ "utility_rebate_max": {
795
+ "default": 10000000000.0,
796
+ "min": 0,
797
+ "max": 10000000000.0,
798
+ "type": "number",
799
+ "description": "Maximum rebate allowed under utility rebates"
800
+ },
801
+ "installed_cost_per_kw": {
802
+ "default": 3013,
803
+ "min": 0,
804
+ "max": 100000.0,
805
+ "type": "number",
806
+ "description": "Total upfront installed costs in US dollars per kW. Determined by size_class. For the 'large' (>2MW) size_class the cost is $1,874/kW. For the 'medium commercial' size_class the cost is $4,111 per kW. For the 'small commercial' size_class the cost is $4,989 per kW and for the 'residential' size_class the cost is $10,792 per kW "
807
+ },
808
+ "utility_ibi_max": {
809
+ "default": 10000000000.0,
810
+ "min": 0,
811
+ "max": 10000000000.0,
812
+ "type": "number",
813
+ "description": "Maximum rebate allowed under utility investment based incentives"
814
+ },
815
+ "pressure_atmospheres": {
816
+ "type": "array",
817
+ "description": "Data downloaded from Wind ToolKit for modeling wind turbine."
818
+ },
819
+ "pbi_system_max_kw": {
820
+ "default": 1000000000.0,
821
+ "min": 0,
822
+ "max": 1000000000.0,
823
+ "type": "number",
824
+ "description": "Maximum system size for which production-based incentives apply"
825
+ },
826
+ "utility_ibi_fraction": {
827
+ "default": 0,
828
+ "min": 0,
829
+ "max": 1,
830
+ "type": "number",
831
+ "description": "Fraction of upfront project costs to discount under utility investment based incentives"
832
+ },
833
+ "state_ibi_max": {
834
+ "default": 10000000000.0,
835
+ "min": 0,
836
+ "max": 10000000000.0,
837
+ "type": "number",
838
+ "description": "Maximum rebate allowed under state investment based incentives"
839
+ },
840
+ "wind_direction_degrees": {
841
+ "type": "array",
842
+ "description": "Data downloaded from Wind ToolKit for modeling wind turbine."
843
+ },
844
+ "size_class": {
845
+ "type": "string",
846
+ "description": "Turbine size-class. One of [residential, commercial, medium, large]",
847
+ "restrict_to": ["residential", "commercial", "medium", "large"]
848
+ },
849
+ "state_rebate_per_kw": {
850
+ "default": 0,
851
+ "min": 0,
852
+ "max": 1000000000.0,
853
+ "type": "number",
854
+ "description": "State rebates based on installed capacity"
855
+ },
856
+ "macrs_option_years": {
857
+ "default": 5,
858
+ "type": "integer",
859
+ "description": "MACRS schedule for financial analysis. Set to zero to disable",
860
+ "restrict_to": [0, 5, 7]
861
+ },
862
+ "state_rebate_max": {
863
+ "default": 10000000000.0,
864
+ "min": 0,
865
+ "max": 10000000000.0,
866
+ "type": "number",
867
+ "description": "Maximum rebate allowed under state rebates"
868
+ },
869
+ "federal_itc_fraction": {
870
+ "default": 0.3,
871
+ "min": 0,
872
+ "max": 1,
873
+ "type": "number",
874
+ "description": "Fraction federal capital cost incentive"
875
+ },
876
+ "temperature_celsius": {
877
+ "type": "array",
878
+ "description": "Data downloaded from Wind ToolKit for modeling wind turbine."
879
+ },
880
+ "production_incentive_per_kwh": {
881
+ "default": 0,
882
+ "min": 0,
883
+ "max": 1000000000.0,
884
+ "type": "number",
885
+ "description": "Production-based incentive value"
886
+ },
887
+ "om_cost_per_kw": {
888
+ "default": 35,
889
+ "min": 0,
890
+ "max": 1000.0,
891
+ "type": "number",
892
+ "description": "Total annual operations and maintenance costs for wind"
893
+ },
894
+ "utility_rebate_per_kw": {
895
+ "default": 0,
896
+ "min": 0,
897
+ "max": 1000000000.0,
898
+ "type": "number",
899
+ "description": "Utility rebates based on installed capacity"
900
+ },
901
+ "min_kw": {
902
+ "default": 0,
903
+ "min": 0,
904
+ "max": 1000000000.0,
905
+ "type": "number",
906
+ "description": "Minimum wind power capacity constraint for optimization"
907
+ },
908
+ "macrs_itc_reduction": {
909
+ "default": 0.5,
910
+ "min": 0,
911
+ "max": 1,
912
+ "type": "number",
913
+ "description": "Fraction of the full ITC that depreciable basis is reduced by"
914
+ },
915
+ "federal_rebate_per_kw": {
916
+ "default": 0,
917
+ "min": 0,
918
+ "max": 1000000000.0,
919
+ "type": "number",
920
+ "description": "Federal rebate based on installed capacity"
921
+ }
922
+ }
923
+ },
924
+ "Generator": {
925
+ "type": "object",
926
+ "properties": {
927
+ "pbi_years": {
928
+ "default": 0,
929
+ "min": 0,
930
+ "max": 1000000000.0,
931
+ "type": "number",
932
+ "description": "Duration of production-based incentives from installation date"
933
+ },
934
+ "macrs_bonus_fraction": {
935
+ "default": 0,
936
+ "min": 0,
937
+ "max": 1,
938
+ "type": "number",
939
+ "description": "Fraction of upfront project costs to depreciate under MACRS"
940
+ },
941
+ "om_cost_per_kwh": {
942
+ "default": 0.01,
943
+ "min": 0,
944
+ "max": 1000.0,
945
+ "type": "number",
946
+ "description": "diesel generator per unit production (variable) operations and maintenance costs in $/kWh"
947
+ },
948
+ "max_kw": {
949
+ "default": 1000000000.0,
950
+ "min": 0,
951
+ "max": 1000000000.0,
952
+ "type": "number",
953
+ "description": "Maximum diesel generator size constraint for optimization. Set to zero to disable gen"
954
+ },
955
+ "production_incentive_max_benefit": {
956
+ "default": 0,
957
+ "min": 0,
958
+ "max": 1000000000.0,
959
+ "type": "number",
960
+ "description": "Maximum rebate allowed under utility production-based incentives"
961
+ },
962
+ "state_ibi_fraction": {
963
+ "default": 0,
964
+ "min": 0,
965
+ "max": 1,
966
+ "type": "number",
967
+ "description": "Fraction of upfront project costs to discount under state investment based incentives"
968
+ },
969
+ "fuel_intercept_gal_per_hr": {
970
+ "default": 0,
971
+ "min": 0,
972
+ "max": 10,
973
+ "type": "number",
974
+ "description": "Generator fuel consumption curve y-intercept in gallons per hour."
975
+ },
976
+ "generator_only_runs_during_grid_outage": {
977
+ "default": true,
978
+ "type": "boolean",
979
+ "description": "If there is existing diesel generator, must specify whether it should run only during grid outage or all the time in the bau case."
980
+ },
981
+ "utility_rebate_max": {
982
+ "default": 0,
983
+ "min": 0,
984
+ "max": 10000000000.0,
985
+ "type": "number",
986
+ "description": "Maximum rebate allowed under utility rebates"
987
+ },
988
+ "installed_cost_per_kw": {
989
+ "default": 600,
990
+ "min": 0,
991
+ "max": 100000.0,
992
+ "type": "number",
993
+ "description": "Installed diesel generator cost in $/kW"
994
+ },
995
+ "utility_ibi_max": {
996
+ "default": 0,
997
+ "min": 0,
998
+ "max": 10000000000.0,
999
+ "type": "number",
1000
+ "description": "Maximum rebate allowed under utility investment based incentives"
1001
+ },
1002
+ "fuel_avail_gal": {
1003
+ "default": 1000000000.0,
1004
+ "min": 0,
1005
+ "max": 1000000000.0,
1006
+ "type": "number",
1007
+ "description": "On-site generator fuel available in gallons."
1008
+ },
1009
+ "min_turn_down_fraction": {
1010
+ "default": 0,
1011
+ "min": 0,
1012
+ "max": 1,
1013
+ "type": "number",
1014
+ "description": "Minimum generator loading in fraction of capacity (size_kw)."
1015
+ },
1016
+ "pbi_system_max_kw": {
1017
+ "default": 0,
1018
+ "min": 0,
1019
+ "max": 1000000000.0,
1020
+ "type": "number",
1021
+ "description": "Maximum system size for which production-based incentives apply"
1022
+ },
1023
+ "utility_ibi_fraction": {
1024
+ "default": 0,
1025
+ "min": 0,
1026
+ "max": 1,
1027
+ "type": "number",
1028
+ "description": "Fraction of upfront project costs to discount under utility investment based incentives"
1029
+ },
1030
+ "state_ibi_max": {
1031
+ "default": 0,
1032
+ "min": 0,
1033
+ "max": 10000000000.0,
1034
+ "type": "number",
1035
+ "description": "Maximum rebate allowed under state investment based incentives"
1036
+ },
1037
+ "fuel_cost_per_gallon": {
1038
+ "default": 3,
1039
+ "min": 0,
1040
+ "max": 100.0,
1041
+ "type": "number",
1042
+ "description": "diesel cost in $/gallon"
1043
+ },
1044
+ "fuel_slope_gal_per_kwh": {
1045
+ "default": 0,
1046
+ "min": 0,
1047
+ "max": 10,
1048
+ "type": "number",
1049
+ "description": "Generator fuel burn rate in gallons/kWh."
1050
+ },
1051
+ "state_rebate_per_kw": {
1052
+ "default": 0,
1053
+ "min": 0,
1054
+ "max": 1000000000.0,
1055
+ "type": "number",
1056
+ "description": "State rebates based on installed capacity"
1057
+ },
1058
+ "macrs_option_years": {
1059
+ "default": 0,
1060
+ "type": "integer",
1061
+ "description": "MACRS schedule for financial analysis. Set to zero to disable",
1062
+ "restrict_to": [0, 5, 7]
1063
+ },
1064
+ "state_rebate_max": {
1065
+ "default": 0,
1066
+ "min": 0,
1067
+ "max": 10000000000.0,
1068
+ "type": "number",
1069
+ "description": "Maximum rebate allowed under state rebates"
1070
+ },
1071
+ "federal_itc_fraction": {
1072
+ "default": 0,
1073
+ "min": 0,
1074
+ "max": 1,
1075
+ "type": "number",
1076
+ "description": "Fraction federal capital cost incentive"
1077
+ },
1078
+ "production_incentive_per_kwh": {
1079
+ "default": 0,
1080
+ "min": 0,
1081
+ "max": 1000000000.0,
1082
+ "type": "number",
1083
+ "description": "Production-based incentive value"
1084
+ },
1085
+ "existing_kw": {
1086
+ "default": 0,
1087
+ "min": 0,
1088
+ "max": 100000.0,
1089
+ "type": "number",
1090
+ "description": "Existing diesel generator size"
1091
+ },
1092
+ "om_cost_per_kw": {
1093
+ "default": 10,
1094
+ "min": 0,
1095
+ "max": 1000.0,
1096
+ "type": "number",
1097
+ "description": "Annual diesel generator fixed operations and maintenance costs in $/kW"
1098
+ },
1099
+ "utility_rebate_per_kw": {
1100
+ "default": 0,
1101
+ "min": 0,
1102
+ "max": 1000000000.0,
1103
+ "type": "number",
1104
+ "description": "Utility rebates based on installed capacity"
1105
+ },
1106
+ "min_kw": {
1107
+ "default": 0,
1108
+ "min": 0,
1109
+ "max": 1000000000.0,
1110
+ "type": "number",
1111
+ "description": "Minimum diesel generator size constraint for optimization"
1112
+ },
1113
+ "macrs_itc_reduction": {
1114
+ "default": 0,
1115
+ "min": 0,
1116
+ "max": 1,
1117
+ "type": "number",
1118
+ "description": "Fraction of the full ITC that depreciable basis is reduced by"
1119
+ },
1120
+ "federal_rebate_per_kw": {
1121
+ "default": 0,
1122
+ "min": 0,
1123
+ "max": 1000000000.0,
1124
+ "type": "number",
1125
+ "description": "Federal rebate based on installed capacity"
1126
+ },
1127
+ "generator_sells_energy_back_to_grid": {
1128
+ "default": false,
1129
+ "type": "boolean",
1130
+ "description": "If there is existing diesel generator, must specify whether it should run only during grid outage or all the time in the bau case."
1111
1131
  }
1112
1132
  }
1113
1133
  }