-
Notifications
You must be signed in to change notification settings - Fork 47
/
nested_inputs.py
2717 lines (2684 loc) · 111 KB
/
nested_inputs.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# REopt®, Copyright (c) Alliance for Sustainable Energy, LLC. See also https://github.com/NREL/REopt_API/blob/master/LICENSE.
import copy
max_big_number = 1.0e8
max_incentive = 1.0e10
max_years = 75
macrs_schedules = [0, 5, 7]
analysis_years = 25
providers = ['federal', 'state', 'utility']
default_buildings = ['FastFoodRest',
'FullServiceRest',
'Hospital',
'LargeHotel',
'LargeOffice',
'MediumOffice',
'MidriseApartment',
'Outpatient',
'PrimarySchool',
'RetailStore',
'SecondarySchool',
'SmallHotel',
'SmallOffice',
'StripMall',
'Supermarket',
'Warehouse',
'FlatLoad',
'FlatLoad_24_5',
'FlatLoad_16_7',
'FlatLoad_16_5',
'FlatLoad_8_7',
'FlatLoad_8_5'
]
macrs_five_year = [0.2, 0.32, 0.192, 0.1152, 0.1152, 0.0576] # IRS pub 946
macrs_seven_year = [0.1429, 0.2449, 0.1749, 0.1249, 0.0893, 0.0892, 0.0893, 0.0446]
#the user needs to supply valid data for all the attributes in at least one of these sets for load_profile_possible_sets and electric_tariff_possible_sets
load_profile_possible_sets = [["loads_kw"],
["doe_reference_name", "monthly_totals_kwh"],
["annual_kwh", "doe_reference_name"],
["doe_reference_name"]
]
electric_tariff_possible_sets = [
["urdb_response"],
["blended_monthly_demand_charges_us_dollars_per_kw", "blended_monthly_rates_us_dollars_per_kwh"],
["blended_annual_demand_charges_us_dollars_per_kw", "blended_annual_rates_us_dollars_per_kwh"],
["urdb_label"],
["urdb_utility_name", "urdb_rate_name"],
["tou_energy_rates_us_dollars_per_kwh"]
]
def list_of_float(input):
return [float(i) for i in input]
def list_of_str(input):
return [str(i) for i in input]
def list_of_list(input, inner_list_conversion_function=list):
return [inner_list_conversion_function(i) for i in input]
def list_of_int(input):
result = []
for i in input:
if i%1>0:
raise Exception('Not all values in the list_of_int input are whole numbers')
result.append(int(i))
return result
def list_of_dict(input):
result = []
for i in input:
result.append(dict(i))
return result
off_grid_defaults = {
"Scenario": {
"optimality_tolerance_techs": {
"type": "float",
"min": 1.0e-5,
"max": 10.0,
"default": 0.05,
"description": "The threshold for the difference between the solution's objective value and the best possible value at which the solver terminates"
},
"Site": {
"Financial": {
"microgrid_upgrade_cost_pct": {
"type": "float",
"min": 0.0,
"max": 0.0,
"default": 0.0,
"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. For off-grid analyses, this should instead be provided as other_capital_costs_us_dollars or other_annual_costs_us_dollars_per_year"
},
},
"LoadProfile": {
"critical_load_pct": {
"type": "float",
"min": 1.0,
"max": 1.0,
"default": 1.0,
"description": "In off-grid scenarios, 100 percent of the typical load is assumed to be critical from a modeling standpoint (a 8760 hour outage is modeled). To adjust the 'critical load', change the typical load or the min_load_met_pct inputs."
},
"outage_is_major_event": {
"type": "bool",
"default": False,
"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.)"
},
"sr_required_pct": {
"type": "float",
"min": 0.0,
"max": 1.0,
"default": 0.1,
"description": "Applies to off-grid scenarios only. Spinning reserve requirement for changes in load in off-grid analyses. Value must be between zero and one, inclusive."
},
"min_load_met_pct": {
"type": "float",
"min": 0.0,
"max": 1.0,
"default": 0.999,
"description": "Applies to off-grid scenarios only. Fraction of the load that must be met on an annual energy basis. Value must be between zero and one, inclusive."
}
},
"PV": {
"sr_required_pct": {
"type": "float",
"min": 0.0,
"max": 1.0,
"default": 0.25,
"description": "Applies to off-grid scenarios only. Spinning reserve requirement for PV serving load in off-grid analyses. Value must be between zero and one, inclusive."
}
},
"Storage": {
"soc_init_pct": {
"type": "float", "min": 0.0, "max": 1.0, "default": 1.0,
"description": "Battery state of charge at first hour of optimization"
}
},
"Generator": {
"om_cost_us_dollars_per_kw": {
"type": "float",
"min": 0.0,
"max": 1.0e3,
"default": 20.0,
"description": "Annual diesel generator fixed operations and maintenance costs in $/kW"
},
"fuel_avail_gal": {
"type": "float",
"min": 0.0,
"max": 1.0e9,
"default": 1.0e9,
"description": "Annual on-site generator fuel available in gallons."
},
"min_turn_down_pct": {
"type": "float",
"min": 0.0,
"max": 1.0,
"default": 0.15,
"description": "Minimum generator loading in percent of capacity (size_kw)."
},
"generator_only_runs_during_grid_outage": {
"default": False,
"type": "bool",
"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."
},
"useful_life_years": {
"type": "float", "min": 0.0, "max": max_years, "default": 10,
"description": "Applies to off-grid scenarios only. Number of years asset can be used for before replacement. A single replacement is considered for off-grid generators."
}
}
}
}
}
nested_input_definitions = {
"Scenario": {
"timeout_seconds": {
"type": "int",
"min": 1,
"max": 420,
"default": 420,
"description": "The number of seconds allowed before the optimization times out"
},
"user_uuid": {
"type": "str",
"description": "The assigned unique ID of a signed in REopt user"
},
"description": {
"type": "str",
"description": "An optional user defined description to describe the scenario and run"
},
"time_steps_per_hour": {
"type": "int",
"restrict_to": [1, 2, 4],
"default": 1,
"description": "The number of time steps per hour in the REopt simulation"
},
"webtool_uuid": {
"type": "str",
"description": "The unique ID of a scenario created by the REopt Webtool. Note that this ID can be shared by several REopt API Scenarios (for example when users select a 'Resilience' analysis more than one REopt API Scenario is created)."
},
"optimality_tolerance_bau": {
"type": "float",
"min": 0.0001,
"max": 0.05,
"default": 0.001,
"description": "The threshold for the difference between the solution's objective value and the best possible value at which the solver terminates"
},
"optimality_tolerance_techs": {
"type": "float",
"min": 0.0001,
"max": 0.05,
"default": 0.001,
"description": "The threshold for the difference between the solution's objective value and the best possible value at which the solver terminates"
},
"add_soc_incentive": {
"type": "bool",
"default": True,
"description": "If True, then a small incentive to keep the battery's state of charge high is added to the objective of the optimization."
},
"off_grid_flag": {
"type": "bool",
"default": False,
"description": "Set to True to enable off-grid analyses."
},
"include_climate_in_objective": {
"type": "bool",
"default": False,
"description": "If True, then the lifecycle cost of CO2 emissions will be included in the objective function. Lifecycle CO2 impacts will be calculated regardless."
},
"include_health_in_objective": {
"type": "bool",
"default": False,
"description": "If True, then the lifecycle cost of SO2, NOx, and PM2.5 emissions will be included in the objective function. Lifecycle health impacts will be calculated regardless, but you must provide marginal health costs for each pollutant."
},
"Site": {
"latitude": {
"type": "float",
"min": -90.0,
"max": 90.0,
"required": True,
"description": "The approximate latitude of the site in decimal degrees"
},
"longitude": {
"type": "float",
"min": -180.0,
"max": 180.0,
"required": True,
"description": "The approximate longitude of the site in decimal degrees"
},
"address": {
"type": "str",
"description": "A user defined address as optional metadata (street address, city, state or zip code)"
},
"land_acres": {
"type": "float",
"min": 0.0,
"max": 1.0e6,
"description": "Land area in acres available for PV panel and wind turbine siting"
},
"roof_squarefeet": {
"type": "float",
"min": 0.0,
"max": 1.0e9,
"description": "Area of roof in square feet available for PV siting"
},
"outdoor_air_temp_degF": {
"type": "list_of_float",
"default": [],
"description": "Hourly outdoor air temperature (dry-bulb)."
},
"elevation_ft": {
"type": "float",
"min": 0.0,
"max": 15000.0,
"default": 0.0,
"description": "Site elevation (above sea sevel), units of feet"
},
"renewable_electricity_min_pct": {
"type": "float",
"min": 0,
"description": "Minumum acceptable percent of total energy consumption provided by renewable energy annually."
},
"renewable_electricity_max_pct": {
"type": "float",
"min": 0,
"description": "Maximum acceptable percent of total energy consumption provided by renewable energy annually."
},
"co2_emissions_reduction_min_pct": {
"type": "float",
"description": "Minumum acceptable percent of carbon emissions reduction relative to the business-as-usual case, over the financial lifecycle of the project."
},
"co2_emissions_reduction_max_pct": {
"type": "float",
"description": "Maximum acceptable percent of carbon emissions reduction relative to the business-as-usual case, over the financial lifecycle of the project."
},
"include_exported_elec_emissions_in_total": {
"type": "bool",
"default": True,
"description": "Include the emissions reductions (or increases) in grid emissions associated with exported onsite electrical generation in the calculation of Year 1 emissions."
},
"include_exported_renewable_electricity_in_total": {
"type": "bool",
"default": True,
"description": "True indicates site retains credits for exported electricity derived from renewable resources."
},
"Financial": {
"om_cost_escalation_pct": {
"type": "float",
"min": -1.0,
"max": 1.0,
"default": 0.025,
"description": "Annual nominal O&M cost escalation rate"
},
"escalation_pct": {
"type": "float",
"min": -1.0,
"max": 1.0,
"default": 0.023,
"description": "Annual nominal utility electricity cost escalation rate"
},
"generator_fuel_escalation_pct": {
"type": "float",
"min": -1.0,
"max": 1.0,
"default": 0.027,
"description": "Annual nominal diesel generator fuel cost escalation rate"
},
"boiler_fuel_escalation_pct": {
"type": "float",
"min": -1.0,
"max": 1.0,
"default": 0.034,
"description": "Annual nominal boiler fuel cost escalation rate"
},
"chp_fuel_escalation_pct": {
"type": "float",
"min": -1,
"max": 1,
"default": 0.034,
"description": "Annual nominal chp fuel cost escalation rate"
},
"newboiler_fuel_escalation_pct": {
"type": "float",
"min": -1.0,
"max": 1.0,
"default": 0.034,
"description": "Annual nominal boiler fuel cost escalation rate"
},
"offtaker_tax_pct": {
"type": "float",
"min": 0.0,
"max": 0.999,
"default": 0.26,
"description": "Host tax rate"
},
"offtaker_discount_pct": {
"type": "float",
"min": 0.0,
"max": 1.0,
"default": 0.083,
"description": "Nominal energy offtaker discount rate. In single ownership model the offtaker is also the generation owner."
},
"third_party_ownership": {
"default": False,
"type": "bool",
"description": "Specify if ownership model is direct ownership or two party. In two party model the offtaker does not purcharse the generation technologies, but pays the generation owner for energy from the generator(s)."
},
"owner_tax_pct": {
"type": "float",
"min": 0,
"max": 0.999,
"default": 0.26,
"description": "Generation owner tax rate. Used for two party financing model. In two party ownership model the offtaker does not own the generator(s)."
},
"owner_discount_pct": {
"type": "float",
"min": 0.0,
"max": 1.0,
"default": 0.083,
"description": "Nominal generation owner discount rate. Used for two party financing model. In two party ownership model the offtaker does not own the generator(s)."
},
"analysis_years": {
"type": "int",
"min": 1,
"max": max_years,
"default": analysis_years,
"description": "Analysis period"
},
"value_of_lost_load_us_dollars_per_kwh": {
"type": "float",
"min": 0.0,
"max": 1.0e6,
"default": 100.0,
"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."
},
"microgrid_upgrade_cost_pct": {
"type": "float",
"min": 0.0,
"max": 1.0,
"default": 0.3,
"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 labor and critical load panels."
},
"other_capital_costs_us_dollars": {
"type": "float",
"min": 0.0,
"max": 1.0e10,
"default": 0,
"description": "Other capital costs associated with the distributed energy system project. These can include land purchase costs, distribution network costs, powerhouse or battery container structure costs, and pre-operating expenses. These costs will be incorporated in the life cycle cost and levelized cost of electricity calculations."
},
"other_annual_costs_us_dollars_per_year": {
"type": "float",
"min": 0.0,
"max": max_big_number,
"default": 0,
"description": "Other annual costs associated with the distributed energy system project. These can include labor costs, land lease costs, software costs, and any other ongoing expenses not included in other cost inputs. These costs will be incorporated in the life cycle cost and levelized cost of electricity calculations."
},
"co2_cost_us_dollars_per_tonne": {
"type": "float",
"min": 0.0,
"max": 1.0e5,
"default": 51.0,
"description": "Social Cost of CO2 in the first year of the analysis. Units are US dollars per metric ton of CO2. The default of $51/t is the 2020 value (using a 3 pct discount rate) estimated by the U.S. Interagency Working Group on Social Cost of Greenhouse Gases."
},
"nox_cost_us_dollars_per_tonne_grid": {
"type": "float",
"min": 0.0,
"max": 1.0e8,
"description": "Public health cost of NOx emissions from grid electricity in the first year of the analysis. Units are US dollars per metric ton. Default values for the U.S. obtained from the EASIUR model."
},
"so2_cost_us_dollars_per_tonne_grid": {
"type": "float",
"min": 0.0,
"max": 1.0e8,
"description": "Public health cost of SO2 emissions from grid electricity in the first year of the analysis. Units are US dollars per metric ton. Default values for the U.S. obtained from the EASIUR model."
},
"pm25_cost_us_dollars_per_tonne_grid": {
"type": "float",
"min": 0.0,
"max": 1.0e8,
"description": "Public health cost of PM2.5 emissions from grid electricity in the first year of the analysis. Units are US dollars per metric ton. Default values for the U.S. obtained from the EASIUR model."
},
"nox_cost_us_dollars_per_tonne_onsite_fuelburn": {
"type": "float",
"min": 0.0,
"max": 1.0e8,
"description": "Public health cost of NOx from onsite fuelburn in the first year of the analysis. Units are US dollars per metric ton. Default values for the U.S. obtained from the EASIUR model."
},
"so2_cost_us_dollars_per_tonne_onsite_fuelburn": {
"type": "float",
"min": 0.0,
"max": 1.0e8,
"description": "Public health cost of SO2 from onsite fuelburn in the first year of the analysis. Units are US dollars per metric ton. Default values for the U.S. obtained from the EASIUR model."
},
"pm25_cost_us_dollars_per_tonne_onsite_fuelburn": {
"type": "float",
"min": 0.0,
"max": 1.0e8,
"description": "Public health cost of PM2.5 from onsite fuelburn in the first year of the analysis. Units are US dollars per metric ton. Default values for the U.S. obtained from the EASIUR model."
},
"co2_cost_escalation_pct": {
"type": "float",
"min": -1.0,
"max": 1.0,
"default": 0.042173,
"description": "Annual nominal Social Cost of CO2 escalation rate (as a decimal)."
},
"nox_cost_escalation_pct": {
"type": "float",
"min": -1.0,
"max": 1.0,
"description": "Annual nominal escalation rate of the public health cost of 1 tonne of NOx emissions (as a decimal). The default value is calculated from the EASIUR model for a height of 150m."
},
"so2_cost_escalation_pct": {
"type": "float",
"min": -1.0,
"max": 1.0,
"description": "Annual nominal escalation rate of the public health cost of 1 tonne of SO2 emissions (as a decimal). The default value is calculated from the EASIUR model for a height of 150m."
},
"pm25_cost_escalation_pct": {
"type": "float",
"min": -1.0,
"max": 1.0,
"description": "Annual nominal escalation rate of the public health cost of 1 tonne of PM2.5 emissions (as a decimal). The default value is calculated from the EASIUR model for a height of 150m."
},
},
"LoadProfile": {
"doe_reference_name": {
"type": ["str", "list_of_str"],
"restrict_to": default_buildings,
"replacement_sets": load_profile_possible_sets,
"description": "Simulated load profile from DOE <a href='https: //energy.gov/eere/buildings/commercial-reference-buildings' target='blank'>Commercial Reference Buildings</a>"
},
"annual_kwh": {
"type": "float",
"min": 1.0,
"max": 1.0E10,
"replacement_sets": load_profile_possible_sets,
"depends_on": ["doe_reference_name"],
"description": "Annual site energy consumption from electricity, in kWh, used to scale simulated default building load profile for the site's climate zone"
},
"percent_share": {
"type": ["float", "list_of_float"],
"min": 1.0,
"max": 100.0,
"default": 100.0,
"description": "Percentage share of the types of building for creating hybrid simulated building and campus profiles."
},
"year": {
"type": "int",
"min": 1,
"max": 9999,
"default": 2020,
"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."
},
"monthly_totals_kwh": {
"type": "list_of_float",
"min": 0.0,
"max": max_big_number,
"replacement_sets": load_profile_possible_sets,
"depends_on": ["doe_reference_name"],
"description": "Monthly site energy consumption from electricity series (an array 12 entries long), in kWh, used to scale simulated default building load profile for the site's climate zone"
},
"loads_kw": {
"type": "list_of_float",
"replacement_sets": load_profile_possible_sets,
"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). All non-net load values must be greater than or equal to zero."
},
"critical_loads_kw": {
"type": "list_of_float",
"description": "Critical load during an outage period. Must be hourly (8,760 samples), 30 minute (17,520 samples), or 15 minute (35,040 samples). All non-net load values must be greater than or equal to zero."
},
"loads_kw_is_net": {
"default": True,
"type": "bool",
"description": "If there is existing PV, must specify whether provided load is the net load after existing PV or not."
},
"critical_loads_kw_is_net": {
"default": False,
"type": "bool",
"description": "If there is existing PV, must specify whether provided load is the net load after existing PV or not."
},
"outage_start_hour": {
"type": "int",
"min": 0,
"max": 8759,
"depends_on": ["outage_end_hour"],
"description": "Hour of year that grid outage starts. Must be less than or equal to outage_end_hour."
},
"outage_end_hour": {
"type": "int",
"min": 0,
"max": 8759,
"depends_on": ["outage_start_hour"],
"description": "Hour of year that grid outage ends. Must be greater than or equal to outage_start_hour."
},
"outage_start_time_step": {
"type": "int",
"min": 1,
"max": 35040,
"depends_on": ["outage_end_time_step"],
"description": "Time step that grid outage starts. Must be less than or equal to outage_end_time_step."
},
"outage_end_time_step": {
"type": "int",
"min": 1,
"max": 35040,
"depends_on": ["outage_start_time_step"],
"description": "Time step that grid outage ends. Must be greater than or equal to outage_start_time_step."
},
"critical_load_pct": {
"type": "float",
"min": 0.0,
"max": 2.0,
"default": 0.5,
"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."
},
"outage_is_major_event": {
"type": "bool",
"default": True,
"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.)"
},
"min_load_met_pct": {
"type": "float",
"min": 0.0,
"max": 1.0,
"default": 1.0,
"description": "Applies to off-grid scenarios only. Fraction of the load that must be met on an annual energy basis. Value must be between zero and one, inclusive."
},
"sr_required_pct": {
"type": "float",
"min": 0.0,
"max": 1.0,
"default": 0.0,
"description": "Applies to off-grid scenarios only. Spinning reserve requirement for changes in load in off-grid analyses. Value must be between zero and one, inclusive."
}
},
"LoadProfileBoilerFuel": {
"doe_reference_name": {
"type": ["str", "list_of_str"],
"restrict_to": default_buildings,
"description": "Building type to use in selecting a simulated load profile from DOE <a href='https: //energy.gov/eere/buildings/commercial-reference-buildings' target='blank'>Commercial Reference Buildings</a>. By default, the doe_reference_name of the LoadProfile is used."
},
"annual_mmbtu": {
"type": "float",
"min": 0.0,
"max": max_big_number,
"description": "Annual electric chiller electric consumption, in mmbtu, used to scale simulated default boiler load profile for the site's climate zone",
},
"monthly_mmbtu": {
"type": "list_of_float",
"min": 0.0,
"max": max_big_number,
"description": "Monthly boiler energy consumption series (an array 12 entries long), in mmbtu, used to scale simulated default electric boiler load profile for the site's climate zone"
},
"loads_mmbtu_per_hour": {
"type": "list_of_float",
"description": "Typical boiler fuel load for all hours in one year."
},
"percent_share": {
"type": ["float", "list_of_float"],
"min": 1.0,
"max": 100.0,
"description": "Percentage share of the types of building for creating hybrid simulated building and campus profiles."
},
"addressable_load_fraction": {
"type": ["float", "list_of_float"],
"min": 0.0,
"max": 1.0,
"default": 1.0,
"description": "Fraction of the boiler fuel load be served by heating technologies."
},
"space_heating_fraction_of_heating_load": {
"type": ["float", "list_of_float"],
"min": 0.0,
"max": 1.0,
"description": "Fraction of the total heating load (domestic hot water (DHW) plus space heating) for space heating."
},
},
"LoadProfileChillerThermal": {
"doe_reference_name": {
"type": ["str", "list_of_str"],
"restrict_to": default_buildings,
"description": "Building type to use in selecting a simulated load profile from DOE <a href='https: //energy.gov/eere/buildings/commercial-reference-buildings' target='blank'>Commercial Reference Buildings</a>. By default, the doe_reference_name of the LoadProfile is used."
},
"loads_ton": {
"type": "list_of_float",
"description": "Typical electric chiller load for all hours in one year."
},
"annual_tonhour": {
"type": "float",
"min": 0.0,
"max": max_big_number,
"description": "Annual electric chiller energy consumption, in ton-hours, used to scale simulated default electric chiller load profile for the site's climate zone",
},
"monthly_tonhour": {
"type": "list_of_float",
"min": 0.0,
"max": max_big_number,
"description": "Monthly electric chiller energy consumption series (an array 12 entries long), in ton-hours, used to scale simulated default electric chiller load profile for the site's climate zone"
},
"annual_fraction": {
"type": "float",
"min": 0.0,
"max": 1.0,
"description": "Annual electric chiller energy consumption scalar (i.e. fraction of total electric load, used to scale simulated default electric chiller load profile for the site's climate zone",
},
"monthly_fraction": {
"type": "list_of_float",
"min": 0.0,
"max": max_big_number,
"description": "Monthly electric chiller energy consumption scalar series (i.e. 12 fractions of total electric load by month), used to scale simulated default electric chiller load profile for the site's climate zone."
},
"loads_fraction": {
"type": "list_of_float",
"min": 0.0,
"max": max_big_number,
"description": "Typical electric chiller load proporion of electric load series (unit is a percent) for all time steps in one year."
},
"percent_share": {
"type": ["float", "list_of_float"],
"min": 1.0,
"max": 100.0,
"description": "Percentage share of the types of building for creating hybrid simulated building and campus profiles."
},
"chiller_cop": {
"type": "float",
"min:": 0.01,
"max:": 20.0,
"description": "Existing electric chiller system coefficient of performance - conversion of electricity to "
"usable cooling thermal energy"
},
},
"ElectricTariff": {
"urdb_utility_name": {
"type": "str",
"replacement_sets": electric_tariff_possible_sets,
"depends_on": ["urdb_rate_name"],
"description": "Name of Utility from <a href='https: //openei.org/wiki/Utility_Rate_Database' target='blank'>Utility Rate Database</a>"
},
"urdb_rate_name": {
"type": "str",
"replacement_sets": electric_tariff_possible_sets,
"depends_on": ["urdb_utility_name"],
"description": "Name of utility rate from <a href='https: //openei.org/wiki/Utility_Rate_Database' target='blank'>Utility Rate Database</a>"
},
"add_blended_rates_to_urdb_rate": {
"type": "bool",
"default": False,
"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. "
},
"blended_monthly_rates_us_dollars_per_kwh": {
"type": "list_of_float",
"replacement_sets": electric_tariff_possible_sets,
"depends_on": ["blended_monthly_demand_charges_us_dollars_per_kw"],
"description": "Array (length of 12) of blended energy rates (total monthly energy in kWh divided by monthly cost in $)"
},
"blended_monthly_demand_charges_us_dollars_per_kw": {
"type": "list_of_float",
"replacement_sets": electric_tariff_possible_sets,
"depends_on": ["blended_monthly_rates_us_dollars_per_kwh"],
"description": "Array (length of 12) of blended demand charges (demand charge cost in $ divided by monthly peak demand in kW)"
},
"blended_annual_rates_us_dollars_per_kwh": {
"type": "float",
"replacement_sets": electric_tariff_possible_sets,
"depends_on": ["blended_annual_demand_charges_us_dollars_per_kw"],
"description": "Annual blended energy rate (total annual energy in kWh divided by annual cost in $)"
},
"blended_annual_demand_charges_us_dollars_per_kw": {
"type": "float",
"replacement_sets": electric_tariff_possible_sets,
"depends_on": ["blended_annual_rates_us_dollars_per_kwh"],
"description": "Annual blended demand rates (annual demand charge cost in $ divided by annual peak demand in kW)"
},
"add_tou_energy_rates_to_urdb_rate": {
"type": "bool",
"default": False,
"description": "Set to 'true' to add the tou energy rates to the URDB rate schedule. Otherwise, tou energy rates will only be considered if a URDB rate is not provided. "
},
"tou_energy_rates_us_dollars_per_kwh": {
"type": "list_of_float",
"replacement_sets": electric_tariff_possible_sets,
"description": "Time-of-use energy rates, provided by user. Must be an array with length equal to number of timesteps per year. Hourly or 15 minute rates allowed."
},
"net_metering_limit_kw": {
"type": "float",
"min": 0.0,
"max": 1.0e9,
"default": 0.0,
"description": "Upper limit on the total capacity of technologies that can participate in net metering agreement."
},
"interconnection_limit_kw": {
"type": "float",
"min": 0.0,
"max": 1.0e9,
"default": max_big_number,
"description": "Limit on system capacity size that can be interconnected to the grid"
},
"wholesale_rate_us_dollars_per_kwh": {
"type": ["float", "list_of_float"],
"min": 0.0,
"default": 0.0,
"description": "Price of electricity sold back to the grid in absence of net metering or above net metering limit. The total annual kWh that can be compensated under this rate is restricted to the total annual site-load in kWh. Can be a scalar value, which applies for all-time, or an array with time-sensitive values. If an array is input then it must have a length of 8760, 17520, or 35040. The inputed array values are up/down-sampled using mean values to match the Scenario time_steps_per_hour."
},
"wholesale_rate_above_site_load_us_dollars_per_kwh": {
"type": ["float", "list_of_float"],
"min": 0.0,
"default": 0.0,
"description": "Price of electricity sold back to the grid above the site load, regardless of net metering. Can be a scalar value, which applies for all-time, or an array with time-sensitive values. If an array is input then it must have a length of 8760, 17520, or 35040. The inputed array values are up/down-sampled using mean values to match the Scenario time_steps_per_hour."
},
"urdb_response": {
"type": "dict",
"replacement_sets": electric_tariff_possible_sets,
"description": "Utility rate structure from <a href='https: //openei.org/services/doc/rest/util_rates/?version=3' target='blank'>Utility Rate Database API</a>"
},
"urdb_label": {
"type": "str",
"replacement_sets": electric_tariff_possible_sets,
"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>"
},
"emissions_factor_series_lb_CO2_per_kwh": {
"type": ["float", "list_of_float"],
"description": "Carbon Dioxide emissions factor over all hours in one year. Can be provided as either a single constant fraction that will be applied across all timesteps, or an annual timeseries array at an hourly (8,760 samples), 30 minute (17,520 samples), or 15 minute (35,040 samples) resolution.",
},
"emissions_factor_CO2_pct_decrease": {
"type": "float",
"min": -1.0,
"max": 1.0,
"default": 0.01174,
"description": "Annual percent decrease in the total annual CO2 marginal emissions rate of the grid. A negative value indicates an annual increase.",
},
"emissions_factor_series_lb_NOx_per_kwh": {
"type": ["list_of_float", "float"],
"description": "NOx emissions factor over all hours in one year. Can be provided as either a single constant fraction that will be applied across all timesteps, or an annual timeseries array at an hourly (8,760 samples), 30 minute (17,520 samples), or 15 minute (35,040 samples) resolution.",
},
"emissions_factor_NOx_pct_decrease": {
"type": "float",
"min": -1.0,
"max": 1.0,
"default": 0.01174,
"description": "Annual percent decrease in the total annual NOx marginal emissions rate of the grid. A negative value indicates an annual increase.",
},
"emissions_factor_series_lb_SO2_per_kwh": {
"type": ["list_of_float", "float"],
"description": "SO2 emissions factor over all hours in one year. Can be provided as either a single constant fraction that will be applied across all timesteps, or an annual timeseries array at an hourly (8,760 samples), 30 minute (17,520 samples), or 15 minute (35,040 samples) resolution.",
},
"emissions_factor_SO2_pct_decrease": {
"type": "float",
"min": -1.0,
"max": 1.0,
"default": 0.01174,
"description": "Annual percent decrease in the total annual SO2 marginal emissions rate of the grid. A negative value indicates an annual increase.",
},
"emissions_factor_series_lb_PM25_per_kwh": {
"type": ["list_of_float", "float"],
"description": "PM2.5 emissions factor over all hours in one year. Can be provided as either a single constant fraction that will be applied across all timesteps, or an annual timeseries array at an hourly (8,760 samples), 30 minute (17,520 samples), or 15 minute (35,040 samples) resolution.",
},
"emissions_factor_PM25_pct_decrease": {
"type": "float",
"min": -1.0,
"max": 1.0,
"default": 0.01174,
"description": "Annual percent decrease in the total annual PM2.5 marginal emissions rate of the grid. A negative value indicates an annual increase.",
},
"chp_standby_rate_us_dollars_per_kw_per_month": {
"type": "float",
"min": 0.0,
"max": 1000.0,
"default": 0.0,
"description": "Standby rate charged to CHP based on CHP electric power size"
},
"chp_does_not_reduce_demand_charges": {
"type": "bool",
"default": False,
"description": "Boolean indicator if CHP does not reduce demand charges"
},
"coincident_peak_load_active_timesteps": {
"type": ["int", "list_of_int", "list_of_list"],
"depends_on": ["coincident_peak_load_charge_us_dollars_per_kw"],
"description": "The optional coincident_peak_load_charge_us_dollars_per_kw will apply at the max grid-purchased power during these timesteps. Note timesteps are indexed to a base of 1 not 0."
},
"coincident_peak_load_charge_us_dollars_per_kw": {
"type": ["float", "list_of_float"],
"min": 0,
"max": max_big_number,
"depends_on":["coincident_peak_load_active_timesteps"],
"description": "Optional coincident peak demand charge that is applied to the max load during the timesteps specified in coincident_peak_load_active_timesteps"
},
},
"FuelTariff": {
"existing_boiler_fuel_type": {
"type": "str",
"default": 'natural_gas',
"restrict_to": ["natural_gas", "landfill_bio_gas", "propane", "diesel_oil"],
"description": "Boiler fuel type one of (natural_gas, landfill_bio_gas, propane, diesel_oil)"
},
"boiler_fuel_blended_annual_rates_us_dollars_per_mmbtu": {
"type": "float",
"default": 0.0,
"description": "Single/scalar blended fuel rate for the entire year"
},
"boiler_fuel_blended_monthly_rates_us_dollars_per_mmbtu": {
"type": "list_of_float",
"default": [0.0]*12,
"description": "Array (length of 12) of blended fuel rates (total monthly energy in mmbtu divided by monthly cost in $)"
},
"boiler_fuel_percent_RE": {
"type": "float",
"default": 0.0,
"min": 0.0,
"max": 1.0,
"description": "Fraction of boiler fuel, on an energy basis, that is classified as renewable; used for RE accounting purposes."
},
"chp_fuel_type": {
"type": "str",
"default": 'natural_gas',
"restrict_to": ["natural_gas", "landfill_bio_gas", "propane", "diesel_oil"],
"description": "Boiler fuel type (natural_gas, landfill_bio_gas, propane, diesel_oil)"
},
"chp_fuel_blended_annual_rates_us_dollars_per_mmbtu": {
"type": "float",
"default": 0.0,
"description": "Single/scalar blended fuel rate for the entire year"
},
"chp_fuel_blended_monthly_rates_us_dollars_per_mmbtu": {
"type": "list_of_float",
"default": [0.0] * 12,
"description": "Array (length of 12) of blended fuel rates (total monthly energy in mmbtu divided by monthly cost in $)"
},
"newboiler_fuel_type": {
"type": "str",
"default": 'natural_gas',
"restrict_to": ["natural_gas", "landfill_bio_gas", "propane", "diesel_oil", "uranium"],
"description": "Boiler fuel type one of (natural_gas, landfill_bio_gas, propane, diesel_oil)"
},
"newboiler_fuel_percent_RE": {
"type": "float",
"default": 0.0,
"min": 0.0,
"max": 1.0,
"description": "Fraction of boiler fuel, on an energy basis, that is classified as renewable; used for RE accounting purposes."
},
"newboiler_fuel_blended_annual_rates_us_dollars_per_mmbtu": {
"type": "float",
"default": 0.0,
"description": "Single/scalar blended fuel rate for the entire year"
},
"newboiler_fuel_blended_monthly_rates_us_dollars_per_mmbtu": {
"type": "list_of_float",
"default": [0.0]*12,
"description": "Array (length of 12) of blended fuel rates (total monthly energy in mmbtu divided by monthly cost in $)"
},
"chp_fuel_percent_RE": {
"type": "float",
"default": 0.0,
"min": 0.0,
"max": 1.0,
"description": "Fraction of CHP fuel, on an energy basis, that is classified as renewable; used for RE accounting purposes."
},
},
"Wind": {
"size_class": {
"type": "str",
"restrict_to": ['residential', 'commercial', 'medium', 'large', None],
"description": "Turbine size-class. One of [residential, commercial, medium, large]"
},
"wind_meters_per_sec": {
"type": "list_of_float",
"description": "Data downloaded from Wind ToolKit for modeling wind turbine."
},
"wind_direction_degrees": {
"type": "list_of_float",
"description": "Data downloaded from Wind ToolKit for modeling wind turbine."
},
"temperature_celsius": {
"type": "list_of_float",
"description": "Data downloaded from Wind ToolKit for modeling wind turbine."
},
"pressure_atmospheres": {
"type": "list_of_float",
"description": "Data downloaded from Wind ToolKit for modeling wind turbine."
},
"min_kw": {
"type": "float",
"min": 0.0,
"max": 1.0e9,
"default": 0.0,
"description": "Minimum wind power capacity constraint for optimization"
},
"max_kw": {
"type": "float",
"min": 0.0,
"max": 1.0e9,
"default": 0.0,
"description": "Maximum wind power capacity constraint for optimization. Set to zero to disable Wind. Enabled by default"
},
"installed_cost_us_dollars_per_kw": {
"type": "float",
"min": 0.0,
"max": 1.0e5,
"default": 3013.0, # if the default value of 3013 goes in techs.py, there is a logic to assign actual default cost based on 'size_class' and api_version
"description": "Total upfront installed costs in US dollars/kW. Determined by size_class. For the 'large' (>2MW) size_class the cost is $2,239/kW. For the 'medium commercial' size_class the cost is $2,766/kW. For the 'small commercial' size_class the cost is $4,300/kW and for the 'residential' size_class the cost is $5,675/kW "
},
"om_cost_us_dollars_per_kw": {
"type": "float",
"min": 0.0,
"max": 1.0e3,
"default": 40.0,
"description": "Total annual operations and maintenance costs for wind"
},
"macrs_option_years": {
"type": "int",
"restrict_to": macrs_schedules,
"default": 5,
"description": "MACRS schedule for financial analysis. Set to zero to disable"
},
"macrs_bonus_pct": {
"type": "float",
"min": 0.0,
"max": 1.0,
"default": 0.0,
"description": "Percent of upfront project costs to depreciate under MACRS"
},
"macrs_itc_reduction": {
"type": "float",
"min": 0.0,
"max": 1.0,
"default": 0.5,
"description": "Percent of the full ITC that depreciable basis is reduced by"
},
"federal_itc_pct": {