urbanopt-scenario 0.2.0.pre1 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (71) hide show
  1. checksums.yaml +5 -5
  2. data/.github/pull_request_template.md +2 -2
  3. data/.gitignore +2 -0
  4. data/.rubocop.yml +1 -1
  5. data/CHANGELOG.md +77 -1
  6. data/CONTRIBUTING.md +1 -1
  7. data/Gemfile +28 -18
  8. data/Jenkinsfile +1 -1
  9. data/LICENSE.md +1 -1
  10. data/RDOC_MAIN.md +1 -1
  11. data/README.md +1 -1
  12. data/Rakefile +2 -2
  13. data/docs/README.md +1 -1
  14. data/docs/package-lock.json +2499 -2322
  15. data/docs/package.json +13 -9
  16. data/lib/urbanopt-scenario.rb +1 -1
  17. data/lib/urbanopt/scenario.rb +3 -1
  18. data/lib/urbanopt/scenario/default_reports.rb +3 -8
  19. data/lib/urbanopt/scenario/extension.rb +1 -1
  20. data/lib/urbanopt/scenario/logger.rb +1 -1
  21. data/lib/urbanopt/scenario/scenario_base.rb +1 -1
  22. data/lib/urbanopt/scenario/scenario_csv.rb +22 -9
  23. data/lib/urbanopt/scenario/scenario_datapoint_base.rb +8 -1
  24. data/lib/urbanopt/scenario/scenario_post_processor_base.rb +1 -1
  25. data/lib/urbanopt/scenario/scenario_post_processor_default.rb +81 -8
  26. data/lib/urbanopt/scenario/scenario_post_processor_opendss.rb +275 -0
  27. data/lib/urbanopt/scenario/scenario_runner_base.rb +2 -2
  28. data/lib/urbanopt/scenario/scenario_runner_osw.rb +23 -9
  29. data/lib/urbanopt/scenario/scenario_visualization.rb +236 -0
  30. data/lib/urbanopt/scenario/simulation_dir_base.rb +1 -1
  31. data/lib/urbanopt/scenario/simulation_dir_osw.rb +2 -9
  32. data/lib/urbanopt/scenario/simulation_mapper_base.rb +1 -1
  33. data/lib/urbanopt/scenario/version.rb +2 -2
  34. data/package-lock.json +3 -0
  35. data/urbanopt-scenario-gem.gemspec +15 -15
  36. metadata +78 -82
  37. data/doc_templates/LICENSE.md +0 -27
  38. data/doc_templates/README.md.erb +0 -42
  39. data/doc_templates/copyright_erb.txt +0 -31
  40. data/doc_templates/copyright_js.txt +0 -4
  41. data/doc_templates/copyright_ruby.txt +0 -29
  42. data/lib/change_log.rb +0 -147
  43. data/lib/measures/.rubocop.yml +0 -5
  44. data/lib/measures/default_feature_reports/LICENSE.md +0 -27
  45. data/lib/measures/default_feature_reports/README.md +0 -56
  46. data/lib/measures/default_feature_reports/README.md.erb +0 -42
  47. data/lib/measures/default_feature_reports/measure.rb +0 -957
  48. data/lib/measures/default_feature_reports/measure.xml +0 -143
  49. data/lib/measures/default_feature_reports/tests/USA_CO_Golden-NREL.724666_TMY3.epw +0 -8768
  50. data/lib/measures/default_feature_reports/tests/default_feature_reports_test.rb +0 -238
  51. data/lib/measures/default_feature_reports/tests/example_model.osm +0 -4378
  52. data/lib/urbanopt/scenario/default_reports/construction_cost.rb +0 -169
  53. data/lib/urbanopt/scenario/default_reports/date.rb +0 -97
  54. data/lib/urbanopt/scenario/default_reports/distributed_generation.rb +0 -374
  55. data/lib/urbanopt/scenario/default_reports/end_use.rb +0 -159
  56. data/lib/urbanopt/scenario/default_reports/end_uses.rb +0 -140
  57. data/lib/urbanopt/scenario/default_reports/feature_report.rb +0 -260
  58. data/lib/urbanopt/scenario/default_reports/generator.rb +0 -92
  59. data/lib/urbanopt/scenario/default_reports/location.rb +0 -99
  60. data/lib/urbanopt/scenario/default_reports/logger.rb +0 -44
  61. data/lib/urbanopt/scenario/default_reports/program.rb +0 -266
  62. data/lib/urbanopt/scenario/default_reports/reporting_period.rb +0 -301
  63. data/lib/urbanopt/scenario/default_reports/scenario_report.rb +0 -311
  64. data/lib/urbanopt/scenario/default_reports/schema/README.md +0 -33
  65. data/lib/urbanopt/scenario/default_reports/schema/scenario_csv_columns.txt +0 -21
  66. data/lib/urbanopt/scenario/default_reports/schema/scenario_schema.json +0 -839
  67. data/lib/urbanopt/scenario/default_reports/solar_pv.rb +0 -93
  68. data/lib/urbanopt/scenario/default_reports/storage.rb +0 -105
  69. data/lib/urbanopt/scenario/default_reports/timeseries_csv.rb +0 -284
  70. data/lib/urbanopt/scenario/default_reports/validator.rb +0 -97
  71. data/lib/urbanopt/scenario/default_reports/wind.rb +0 -92
@@ -1,33 +0,0 @@
1
- # URBANopt Scenario Schema
2
-
3
- The URBANopt Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results. An URBANopt Scenario describes a specific set of options to apply to each Feature in a FeatureFile (e.g. each GeoJSON Feature in an URBANopt GeoJSON File). User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files. A ScenarioRunner is used to perform simulations for each SimulationDir. Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results. The [URBANopt Scenario Gem Design Document](https://docs.google.com/document/d/1ExcGuHliaSvPlrYevAJTSV8XAtTQXz_KQqH3p4iQDwg/edit) describes the gem in more detail. The [URBANopt Example Project](https://github.com/urbanopt/urbanopt-example-project) demonstrates how to use the URBANopt Scenario Gem to perform a scenario analysis.
4
-
5
- ## Reporting output units
6
-
7
- **JSON Output Units**
8
-
9
- - energy outputs: kbtu
10
- - water rate outputs : GPM (gallon per minute)
11
- - mass flow rate outputs : lbs/min
12
- - Temperature outputs : °F
13
- - area output: sf
14
- - measured distance output: ft
15
- - cost outputs: $
16
-
17
- **CSV Output Units**
18
-
19
- | output | unit |
20
- | -----------------------------------------| ------- |
21
- | Electricity:Facility | kWh |
22
- | ElectricityProduced:Facility | kWh |
23
- | Gas:Facility | kBtu |
24
- | DistrictCooling:Facility | kWh |
25
- | DistrictHeating:Facility | kWh |
26
- | District Cooling Chilled Water Rate | GPM |
27
- | District Cooling Mass Flow Rate | kg/s |
28
- | District Cooling Inlet Temperature | °C |
29
- | District Cooling Outlet Temperature | °C |
30
- | District Heating Hot Water Rate | GPM |
31
- | District Heating Mass Flow Rate | kg/s |
32
- | District Heating Inlet Temperature | °C |
33
- | District Heating Outlet Temperature | °C |
@@ -1,21 +0,0 @@
1
- Datetime
2
- Electricity:Facility
3
- ElectricityProduced:Facility
4
- Gas:Facility
5
- DistrictCooling:Facility
6
- DistrictHeating:Facility
7
- District Cooling Chilled Water Rate
8
- District Cooling Mass Flow Rate
9
- District Cooling Inlet Temperature
10
- District Cooling Outlet Temperature
11
- District Heating Hot Water Rate
12
- District Heating Mass Flow Rate
13
- District Heating Inlet Temperature
14
- District Heating Outlet Temperature
15
- Net Electric Energy
16
- Electricity:Facility Power
17
- ElectricityProduced:Facility Power
18
- Electricity:Facility Apparent Power
19
- ElectricityProduced:Facility Apparent Power
20
- Net Power
21
- Net Apparent Power
@@ -1,839 +0,0 @@
1
- {
2
- "$schema": "http://json-schema.org/draft-04/schema#",
3
- "description": "Comment describing your JSON Schema",
4
- "type": "object",
5
- "properties": {
6
- "scenario_report": {
7
- "$ref": "#/definitions/ScenarioReport"
8
- },
9
- "feature_reports": {
10
- "description": "features of each data point in the scenario",
11
- "type": "array",
12
- "items": {
13
- "$ref": "#/definitions/FeatureReport"
14
- }
15
- }
16
- },
17
- "required": [
18
- "scenario_report"
19
- ],
20
- "additionalProperties": false,
21
- "definitions": {
22
- "ScenarioReport": {
23
- "type": "object",
24
- "properties": {
25
- "id": {
26
- "type": "string"
27
- },
28
- "name": {
29
- "type": "string"
30
- },
31
- "directory_name": {
32
- "type": "string"
33
- },
34
- "timesteps_per_hour": {
35
- "$ref": "#/definitions/TimestepsPerHour"
36
- },
37
- "number_of_not_started_simulations": {
38
- "type": "number"
39
- },
40
- "number_of_started_simulations": {
41
- "type": "number"
42
- },
43
- "number_of_complete_simulations": {
44
- "type": "number"
45
- },
46
- "number_of_failed_simulations": {
47
- "type": "number"
48
- },
49
- "location": {
50
- "$ref": "#/definitions/Location"
51
- },
52
- "timeseries_csv": {
53
- "$ref": "#/definitions/TimeseriesCSV"
54
- },
55
- "program": {
56
- "$ref": "#/definitions/Program"
57
- },
58
- "construction_costs": {
59
- "$ref": "#/definitions/ConstructionCosts"
60
- },
61
- "reporting_periods": {
62
- "$ref": "#/definitions/ReportingPeriods"
63
- },
64
- "distributed_generation": {
65
- "$ref": "#/definitions/DistributedGeneration"
66
- }
67
- },
68
- "required": [
69
- "id",
70
- "name",
71
- "directory_name",
72
- "timesteps_per_hour",
73
- "number_of_not_started_simulations",
74
- "number_of_started_simulations",
75
- "number_of_complete_simulations",
76
- "number_of_failed_simulations",
77
- "program"
78
- ],
79
- "additionalProperties": false
80
- },
81
- "DistributedGeneration": {
82
- "type": "object",
83
- "properties": {
84
- "lcc_us_dollars": {
85
- "description": "Optimal lifecycle cost",
86
- "type": "number"
87
- },
88
- "npv_us_dollars": {
89
- "description": "Net present value of savings realized by the project",
90
- "type": "number"
91
- },
92
- "year_one_energy_cost_us_dollars": {
93
- "description": "Optimal year one utility energy cost",
94
- "type": "number"
95
- },
96
- "year_one_demand_cost_us_dollars": {
97
- "description": "Optimal year one utility demand cost",
98
- "type": "number"
99
- },
100
- "year_one_bill_us_dollars": {
101
- "description": "Optimal year one utility bill",
102
- "type": "number"
103
- },
104
- "total_energy_cost_us_dollars": {
105
- "description": "Total utility energy cost over the lifecycle, after-tax",
106
- "type": "number"
107
- },
108
- "SolarPV": {
109
- "$ref": "#/definitions/SolarPV"
110
- },
111
- "Wind": {
112
- "$ref": "#/definitions/Wind"
113
- },
114
- "Generator": {
115
- "$ref": "#/definitions/Generator"
116
- },
117
- "Storage": {
118
- "$ref": "#/definitions/Storage"
119
- }
120
- }
121
- },
122
- "SolarPV": {
123
- "type": "object",
124
- "properties": {
125
- "size_kw": {
126
- "description": "rated power in kW",
127
- "type": "string"
128
- }
129
- }
130
- },
131
- "Wind": {
132
- "type": "object",
133
- "properties": {
134
- "size_kw": {
135
- "description": "rated power in kW",
136
- "type": "string"
137
- }
138
- }
139
- },
140
- "Generator": {
141
- "type": "object",
142
- "properties": {
143
- "size_kw": {
144
- "description": "rated power in kW",
145
- "type": "string"
146
- }
147
- }
148
- },
149
- "Storage": {
150
- "type": "object",
151
- "properties": {
152
- "size_kw": {
153
- "description": "rated power in kW",
154
- "type": "string"
155
- },
156
- "size_kw": {
157
- "description": "rated capacity in kWh",
158
- "type": "string"
159
- }
160
- }
161
- },
162
- "FeatureReport": {
163
- "type": "object",
164
- "properties": {
165
- "id": {
166
- "description": "Id refers to the id of a building/feature",
167
- "type": "string"
168
- },
169
- "name": {
170
- "description": "name refers to the name of the feature (eg. Building 1, tranformer 5)",
171
- "type": "string"
172
- },
173
- "directory_name": {
174
- "type": "string"
175
- },
176
- "feature_type": {
177
- "type": "string",
178
- "enum": [
179
- "Building",
180
- "District System",
181
- "Transformer"
182
- ]
183
- },
184
- "timesteps_per_hour": {
185
- "$ref": "#/definitions/TimestepsPerHour"
186
- },
187
- "simulation_status": {
188
- "type": "string",
189
- "enum": [
190
- "Not Started",
191
- "Started",
192
- "Complete",
193
- "Failed"
194
- ]
195
- },
196
- "timeseries_csv": {
197
- "$ref": "#/definitions/TimeseriesCSV"
198
- },
199
- "location": {
200
- "$ref": "#/definitions/Location"
201
- },
202
- "program": {
203
- "$ref": "#/definitions/Program"
204
- },
205
- "design_parameters": {
206
- "$ref": "#/definitions/DesignParameters"
207
- },
208
- "construction_costs": {
209
- "$ref": "#/definitions/ConstructionCosts"
210
- },
211
- "reporting_periods": {
212
- "$ref": "#/definitions/ReportingPeriods"
213
- },
214
- "distributed_generation": {
215
- "$ref": "#/definitions/DistributedGeneration"
216
- }
217
- },
218
- "required": [
219
- "id",
220
- "name",
221
- "directory_name",
222
- "feature_type",
223
- "timesteps_per_hour",
224
- "simulation_status"
225
- ],
226
- "additionalProperties": false
227
- },
228
- "ReportingPeriods": {
229
- "type": "array",
230
- "items": {
231
- "$ref": "#/definitions/ReportingPeriod"
232
- }
233
- },
234
- "ReportingPeriod": {
235
- "description": "Non-overlapping reporting periods",
236
- "type": "object",
237
- "properties": {
238
- "id": {
239
- "description": "Id refers to the id of the reporting period. Ids of reporting periods are matched across simulations, so the same period of time gets the same id for all simulations.",
240
- "type": "number"
241
- },
242
- "name": {
243
- "description": "name refers to the name of the reporting period(eg. Annual, January)",
244
- "type": "string"
245
- },
246
- "multiplier": {
247
- "description": "Multiplier used if this reporting period is representative of mulitple periods. For example one week simulation that represents entire month.",
248
- "type": "number",
249
- "default": 1
250
- },
251
- "start_date": {
252
- "$ref": "#/definitions/Date"
253
- },
254
- "end_date": {
255
- "$ref": "#/definitions/Date"
256
- },
257
- "total_site_energy": {
258
- "description": "Total energy used on site, does not include generation (kBtu)",
259
- "type": "number"
260
- },
261
- "total_source_energy": {
262
- "description": "Total source energy used, does not include generation (kBtu)",
263
- "type": "number"
264
- },
265
- "net_site_energy": {
266
- "description": "Net site energy (kBtu)",
267
- "type": "number"
268
- },
269
- "net_source_energy": {
270
- "description": "Net source energy (kBtu)",
271
- "type": "number"
272
- },
273
- "net_utility_cost": {
274
- "description": "Total utility cost for reporting period includes generation",
275
- "type": "number"
276
- },
277
- "electricity": {
278
- "description": "Sum of all electricity used, does not include electricity produced (kWh)",
279
- "type": "number"
280
- },
281
- "natural_gas": {
282
- "description": "Sum of all natural gas end uses consumption (kBtu)",
283
- "type": "number"
284
- },
285
- "additional_fuel": {
286
- "description": "Sum of all additional fuel end uses consumption (kBtu)",
287
- "type": "number"
288
- },
289
- "district_cooling": {
290
- "description": "Sum of all distric cooling end uses consumption (kBtu)",
291
- "type": "number"
292
- },
293
- "district_heating": {
294
- "description": "Sum of all distric heating end uses consumption (kBtu)",
295
- "type": "number"
296
- },
297
- "water": {
298
- "description": "Sum of all water end uses consumption (ft^3)",
299
- "type": "number"
300
- },
301
- "electricity_produced": {
302
- "description": "Sum of all electricity produced (kWh)",
303
- "type": "number"
304
- },
305
- "end_uses": {
306
- "$ref": "#/definitions/EndUses"
307
- },
308
- "energy_production": {
309
- "description": "Energy produced for reporting period. Electricity reported in kWh, water in m^3, all others in kBtu.",
310
- "type": "object",
311
- "properties": {
312
- "electricity_produced": {
313
- "type": "object",
314
- "properties": {
315
- "photovoltaic": {
316
- "type": "number"
317
- }
318
- },
319
- "additionalProperties": false
320
- }
321
- },
322
- "additionalProperties": false
323
- },
324
- "utility_costs": {
325
- "type": "array",
326
- "items": {
327
- "$ref": "#/definitions/UtilityCost"
328
- }
329
- },
330
- "comfort_result": {
331
- "$ref": "#/definitions/ComfortResult"
332
- }
333
- },
334
- "additionalProperties": false
335
- },
336
- "Date": {
337
- "type": "object",
338
- "properties": {
339
- "month": {
340
- "type": "integer"
341
- },
342
- "day_of_month": {
343
- "type": "integer"
344
- },
345
- "year": {
346
- "type": "integer"
347
- }
348
- },
349
- "additionalProperties": false
350
- },
351
- "EndUses": {
352
- "description": "End uses for reporting period. Does not include energy produced. Electricity reported in kWh, water in m^3, all others in kBtu.",
353
- "type": "object",
354
- "properties": {
355
- "electricity": {
356
- "$ref": "#/definitions/EndUse"
357
- },
358
- "natural_gas": {
359
- "$ref": "#/definitions/EndUse"
360
- },
361
- "additional_fuel": {
362
- "$ref": "#/definitions/EndUse"
363
- },
364
- "district_cooling": {
365
- "$ref": "#/definitions/EndUse"
366
- },
367
- "district_heating": {
368
- "$ref": "#/definitions/EndUse"
369
- },
370
- "water": {
371
- "$ref": "#/definitions/EndUse"
372
- }
373
- },
374
- "additionalProperties": false
375
- },
376
- "EndUse": {
377
- "type": "object",
378
- "properties": {
379
- "heating": {
380
- "type": "number"
381
- },
382
- "cooling": {
383
- "type": "number"
384
- },
385
- "interior_lighting": {
386
- "type": "number"
387
- },
388
- "exterior_lighting": {
389
- "type": "number"
390
- },
391
- "interior_equipment": {
392
- "type": "number"
393
- },
394
- "exterior_equipment": {
395
- "type": "number"
396
- },
397
- "fans": {
398
- "type": "number"
399
- },
400
- "pumps": {
401
- "type": "number"
402
- },
403
- "heat_rejection": {
404
- "type": "number"
405
- },
406
- "humidification": {
407
- "type": "number"
408
- },
409
- "heat_recovery": {
410
- "type": "number"
411
- },
412
- "water_systems": {
413
- "type": "number"
414
- },
415
- "refrigeration": {
416
- "type": "number"
417
- },
418
- "generators": {
419
- "type": "number"
420
- }
421
- },
422
- "additionalProperties": false
423
- },
424
- "ComfortResult": {
425
- "type": "object",
426
- "properties": {
427
- "time_setpoint_not_met_during_occupied_cooling": {
428
- "description": "(hrs)",
429
- "type": "number"
430
- },
431
- "time_setpoint_not_met_during_occupied_heating": {
432
- "description": "(hrs)",
433
- "type": "number"
434
- },
435
- "time_setpoint_not_met_during_occupied_hours": {
436
- "description": "(hrs)",
437
- "type": "number"
438
- },
439
- "hours_out_of_comfort_bounds_PMV": {
440
- "type": "number"
441
- },
442
- "hours_out_of_comfort_bounds_PPD": {
443
- "type": "number"
444
- }
445
- },
446
- "additionalProperties": false
447
- },
448
- "ConstructionCosts": {
449
- "type": "array",
450
- "items": {
451
- "$ref": "#/definitions/ConstructionCost"
452
- }
453
- },
454
- "ConstructionCost": {
455
- "description": "Program related information, does not change in time",
456
- "type": "object",
457
- "properties": {
458
- "category": {
459
- "type": "string",
460
- "enum": [
461
- "Construction",
462
- "Building",
463
- "Space",
464
- "ThermalZone",
465
- "AirLoop",
466
- "PlantLoop",
467
- "ZoneHVAC",
468
- "Lights",
469
- "Luminaire",
470
- "Equipment",
471
- "HVACComponent",
472
- "ZoneHVACComponent"
473
- ]
474
- },
475
- "item_name": {
476
- "description": "Name of the item being costed, e.g. the name of the exterior wall construction",
477
- "type": "string"
478
- },
479
- "unit_cost": {
480
- "description": "Cost per unit of item, e.g. cost per area of construction. This can be adjusted in post processing.",
481
- "type": "number"
482
- },
483
- "cost_units": {
484
- "description": "Unit of cost for this item",
485
- "type": "string",
486
- "enum": [
487
- "CostPerEach",
488
- "CostPerFt2",
489
- "CostPerKW",
490
- "CostPerCFM"
491
- ]
492
- },
493
- "item_quantity": {
494
- "description": "Amount of the item in units corresponding to cost_units",
495
- "type": "number"
496
- },
497
- "total_cost": {
498
- "description": "Total cost is unit_cost multiplied by item_quantity. Can be updated if unit_cost is changed.",
499
- "type": "number"
500
- }
501
- },
502
- "additionalProperties": false
503
- },
504
- "UtilityCost": {
505
- "type": "object",
506
- "properties": {
507
- "fuel_type": {
508
- "type": "string",
509
- "enum": [
510
- "Electricity",
511
- "Natural Gas",
512
- "District Cooling",
513
- "District Heating",
514
- "Additional Fuel",
515
- "Water"
516
- ]
517
- },
518
- "total_cost": {
519
- "description": "($)",
520
- "type": "number"
521
- },
522
- "usage_cost": {
523
- "description": "($)",
524
- "type": "number"
525
- },
526
- "demand_cost": {
527
- "description": "($)",
528
- "type": "number"
529
- }
530
- },
531
- "additionalProperties": false
532
- },
533
- "Location": {
534
- "type": "object",
535
- "properties": {
536
- "latitude": {
537
- "description": "(deg)",
538
- "type": "number"
539
- },
540
- "longitude": {
541
- "description": "(deg)",
542
- "type": "number"
543
- },
544
- "surface_elevation": {
545
- "description": "The surface elevation (above NAVD88 datum) (ft).",
546
- "type": "number"
547
- },
548
- "weather_filename": {
549
- "description": "Name of EPW weather file.",
550
- "type": "string"
551
- }
552
- },
553
- "additionalProperties": false
554
- },
555
- "TimestepsPerHour": {
556
- "type": "integer",
557
- "minimum": 1,
558
- "maximum": 60
559
- },
560
- "Program": {
561
- "type": "object",
562
- "properties": {
563
- "site_area": {
564
- "description": "Area of the entire site or lot (ft^2)",
565
- "type": "number"
566
- },
567
- "floor_area": {
568
- "description": "Building gross floor area (ft^2)",
569
- "type": "number"
570
- },
571
- "conditioned_area": {
572
- "description": "Building conditioned floor area (ft^2)",
573
- "type": "number"
574
- },
575
- "unconditioned_area": {
576
- "description": "Building unconditioned floor area (ft^2)",
577
- "type": "number"
578
- },
579
- "footprint_area": {
580
- "description": "Building floorprint area (ft^2)",
581
- "type": "number"
582
- },
583
- "maximum_roof_height": {
584
- "description": "Maximum height of the roof relative to surface elevation (ft)",
585
- "type": "number"
586
- },
587
- "maximum_number_of_stories": {
588
- "description": "The maximum number of building stories, sum of number of above and below ground stories.",
589
- "type": "number"
590
- },
591
- "maximum_number_of_stories_above_ground": {
592
- "description": "The maximum number of building stories above ground",
593
- "type": "number"
594
- },
595
- "parking_area": {
596
- "description": "Parking gross area (ft^2)",
597
- "type": "number"
598
- },
599
- "number_of_parking_spaces": {
600
- "description": "Number of parking spaces",
601
- "type": "number"
602
- },
603
- "number_of_parking_spaces_charging": {
604
- "description": "Number of parking spaces with electric vehicle charging",
605
- "type": "number"
606
- },
607
- "parking_footprint_area": {
608
- "description": "Parking floorprint area (ft^2)",
609
- "type": "number"
610
- },
611
- "maximum_parking_height": {
612
- "description": "Maximum height of the parking structure relative to surface elevation (ft)",
613
- "type": "number"
614
- },
615
- "maximum_number_of_parking_stories": {
616
- "description": "The maximum number of parking stories, sum of number of above and below ground stories.",
617
- "type": "number"
618
- },
619
- "maximum_number_of_parking_stories_above_ground": {
620
- "description": "The maximum number of parking stories above ground",
621
- "type": "number"
622
- },
623
- "number_of_residential_units": {
624
- "description": "Total number of residential units.",
625
- "type": "integer"
626
- },
627
- "building_types": {
628
- "type": "array",
629
- "items": {
630
- "$ref": "#/definitions/BuildingType"
631
- }
632
- },
633
- "window_area": {
634
- "description": "Exterior windows gross area (ft^2)",
635
- "type": "object",
636
- "properties": {
637
- "north_window_area": {
638
- "type": "number"
639
- },
640
- "south_window_area": {
641
- "type": "number"
642
- },
643
- "east_window_area": {
644
- "type": "number"
645
- },
646
- "west_window_area": {
647
- "type": "number"
648
- },
649
- "total_window_area": {
650
- "type": "number"
651
- }
652
- },
653
- "required": [
654
- "total_window_area"
655
- ],
656
- "additionalProperties": false
657
- },
658
- "wall_area": {
659
- "description": "exterior walls gross area (ft^2)",
660
- "type": "object",
661
- "properties": {
662
- "north_wall_area": {
663
- "type": "number"
664
- },
665
- "south_wall_area": {
666
- "type": "number"
667
- },
668
- "east_wall_area": {
669
- "type": "number"
670
- },
671
- "west_wall_area": {
672
- "type": "number"
673
- },
674
- "total_wall_area": {
675
- "type": "number"
676
- }
677
- },
678
- "required": [
679
- "north_wall_area",
680
- "south_wall_area",
681
- "east_wall_area",
682
- "west_wall_area",
683
- "total_wall_area"
684
- ],
685
- "additionalProperties": false
686
- },
687
- "roof_area": {
688
- "type": "object",
689
- "properties": {
690
- "equipment_roof_area": {
691
- "type": "number"
692
- },
693
- "photovoltaic_roof_area": {
694
- "type": "number"
695
- },
696
- "available_roof_area": {
697
- "description": "gross roof area (ft^2)",
698
- "type": "number"
699
- },
700
- "total_roof_area": {
701
- "description": "Exterior roofs gross area (ft^2)",
702
- "type": "number"
703
- }
704
- },
705
- "required": [
706
- "total_roof_area"
707
- ],
708
- "additionalProperties": false
709
- },
710
- "orientation": {
711
- "description": "Rotation of longest axis from East-West,about up axis (deg)",
712
- "type": "number"
713
- },
714
- "aspect_ratio": {
715
- "description": "Ratio of longest to shortest axis",
716
- "type": "number"
717
- },
718
- "total_construction_cost": {
719
- "description": "total construction cost calculated from the defined cost per floor area ($)",
720
- "type": "number"
721
- }
722
- },
723
- "required": [
724
- "floor_area",
725
- "conditioned_area",
726
- "unconditioned_area",
727
- "footprint_area",
728
- "maximum_roof_height",
729
- "number_of_residential_units",
730
- "building_types",
731
- "window_area",
732
- "wall_area",
733
- "roof_area"
734
- ],
735
- "additionalProperties": false
736
- },
737
- "BuildingType": {
738
- "type": "object",
739
- "properties": {
740
- "building_type": {
741
- "description": "Primary building space type",
742
- "type": "string",
743
- "enum": [
744
- "Single-Family",
745
- "Multifamily (2 to 4 units)",
746
- "Multifamily (5 or more units)",
747
- "Mobile Home",
748
- "Vacant",
749
- "Office",
750
- "Laboratory",
751
- "Nonrefrigerated warehouse",
752
- "Food sales",
753
- "Public order and safety",
754
- "Outpatient health care",
755
- "Refrigerated warehouse",
756
- "Religious worship",
757
- "Public assembly",
758
- "Education",
759
- "Food service",
760
- "Inpatient health care",
761
- "Nursing",
762
- "Lodging",
763
- "Strip shopping mall",
764
- "Enclosed mall",
765
- "Retail other than mall",
766
- "Service"
767
- ]
768
- },
769
- "maximum_occupancy": {
770
- "description": "Maximum number of occupants ",
771
- "type": "number"
772
- },
773
- "floor_area": {
774
- "description": "Building gross floor area of this type (ft^2)",
775
- "type": "number"
776
- }
777
- },
778
- "required": [
779
- "building_type",
780
- "maximum_occupancy",
781
- "floor_area"
782
- ],
783
- "additionalProperties": false
784
- },
785
- "DesignParameters": {
786
- "type": "object",
787
- "properties": {
788
- "district_cooling_chilled_water_rate": {
789
- "type": "number"
790
- },
791
- "district_cooling_mass_flow_rate": {
792
- "type": "number"
793
- },
794
- "district_cooling_inlet_temperature": {
795
- "type": "number"
796
- },
797
- "district_cooling_outlet_temperature": {
798
- "type": "number"
799
- },
800
- "district_heating_hot_water_rate": {
801
- "type": "number"
802
- },
803
- "district_heating_mass_flow_rate": {
804
- "type": "number"
805
- },
806
- "district_heating_inlet_temperature": {
807
- "type": "number"
808
- },
809
- "district_heating_outlet_temperature": {
810
- "type": "number"
811
- }
812
- },
813
- "additionalProperties": false
814
- },
815
- "TimeseriesCSV": {
816
- "type": "object",
817
- "properties": {
818
- "path": {
819
- "type": "string"
820
- },
821
- "first_report_datetime": {
822
- "type": "string"
823
- },
824
- "column_names": {
825
- "type": "array",
826
- "items": {
827
- "type": "string"
828
- }
829
- }
830
- },
831
- "required": [
832
- "path",
833
- "first_report_datetime",
834
- "column_names"
835
- ],
836
- "additionalProperties": false
837
- }
838
- }
839
- }