urbanopt-geojson 0.4.0 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (51) hide show
  1. checksums.yaml +4 -4
  2. data/.github/pull_request_template.md +2 -2
  3. data/CHANGELOG.md +39 -5
  4. data/CONTRIBUTING.md +1 -1
  5. data/Gemfile +1 -1
  6. data/LICENSE.md +29 -17
  7. data/RDOC_MAIN.md +26 -22
  8. data/README.md +2 -2
  9. data/Rakefile +16 -6
  10. data/doc_templates/LICENSE.md +27 -17
  11. data/doc_templates/copyright_erb.txt +40 -30
  12. data/doc_templates/copyright_js.txt +1 -1
  13. data/doc_templates/copyright_ruby.txt +17 -7
  14. data/docs/.vuepress/components/InnerJsonSchema.vue +7 -11
  15. data/docs/.vuepress/config.js +11 -1
  16. data/docs/.vuepress/highlight.js +1 -1
  17. data/docs/.vuepress/json-schema-deref-loader.js +22 -0
  18. data/docs/README.md +3 -4
  19. data/docs/package-lock.json +2526 -1587
  20. data/docs/package.json +9 -3
  21. data/lib/measures/urban_geometry_creation/LICENSE.md +27 -17
  22. data/lib/measures/urban_geometry_creation/README.md +9 -1
  23. data/lib/measures/urban_geometry_creation/measure.rb +16 -6
  24. data/lib/measures/urban_geometry_creation/measure.xml +33 -14
  25. data/lib/measures/urban_geometry_creation_zoning/LICENSE.md +27 -17
  26. data/lib/measures/urban_geometry_creation_zoning/README.md +1 -1
  27. data/lib/measures/urban_geometry_creation_zoning/measure.rb +16 -6
  28. data/lib/measures/urban_geometry_creation_zoning/measure.xml +11 -11
  29. data/lib/urbanopt-geojson.rb +16 -6
  30. data/lib/urbanopt/geojson.rb +16 -6
  31. data/lib/urbanopt/geojson/building.rb +25 -9
  32. data/lib/urbanopt/geojson/derived_extension.rb +16 -6
  33. data/lib/urbanopt/geojson/district_system.rb +16 -6
  34. data/lib/urbanopt/geojson/feature.rb +23 -8
  35. data/lib/urbanopt/geojson/geo_file.rb +17 -7
  36. data/lib/urbanopt/geojson/helper.rb +24 -7
  37. data/lib/urbanopt/geojson/logging.rb +16 -6
  38. data/lib/urbanopt/geojson/mapper_classes.rb +16 -6
  39. data/lib/urbanopt/geojson/model.rb +11 -1
  40. data/lib/urbanopt/geojson/region.rb +11 -1
  41. data/lib/urbanopt/geojson/scale_area.rb +17 -3
  42. data/lib/urbanopt/geojson/schema/building_properties.json +45 -6
  43. data/lib/urbanopt/geojson/schema/electrical_connector_properties.json +23 -14
  44. data/lib/urbanopt/geojson/schema/thermal_connector_properties.json +1 -1
  45. data/lib/urbanopt/geojson/schema/thermal_junction_properties.json +1 -1
  46. data/lib/urbanopt/geojson/update_areas.rb +11 -1
  47. data/lib/urbanopt/geojson/validate_geojson.rb +11 -1
  48. data/lib/urbanopt/geojson/version.rb +12 -2
  49. data/lib/urbanopt/geojson/zoning.rb +11 -1
  50. data/urbanopt-geojson-gem.gemspec +3 -4
  51. metadata +11 -24
@@ -142,7 +142,7 @@
142
142
  "$ref": "#/definitions/heatingSystemFuelType"
143
143
  },
144
144
  "weekday_start_time": {
145
- "description": "Weekday operating hours start time in 08:30 format, using 24-hr clock. Leave blank to use default. Should this be part of a mixed type struct?",
145
+ "description": "Weekday operating hours start time in 08:30 format, using 24-hr clock. Leave blank to use default.",
146
146
  "type": "string"
147
147
  },
148
148
  "weekday_duration": {
@@ -150,7 +150,7 @@
150
150
  "type": "string"
151
151
  },
152
152
  "weekend_start_time": {
153
- "description": "Weekend operating hours start time in 08:30 format, using 24-hr clock. Leave blank to use default. Should this be part of a mixed type struct?",
153
+ "description": "Weekend operating hours start time in 08:30 format, using 24-hr clock. Leave blank to use default.",
154
154
  "type": "string"
155
155
  },
156
156
  "weekend_duration": {
@@ -225,6 +225,45 @@
225
225
  },
226
226
  "user_data": {
227
227
  "description": "Arbitrary user data"
228
+ },
229
+ "ev_charging": {
230
+ "description": "Should be set to true if EV charging is associated with the building.",
231
+ "type": "boolean"
232
+ },
233
+ "ev_charging_station_type": {
234
+ "description": "Indicates whether EV charging associated with the building is for Typical Home, Public or Work charging station",
235
+ "type": "string",
236
+ "enum": [
237
+ "Typical Home",
238
+ "Typical Public",
239
+ "Typical Work"
240
+ ]
241
+ },
242
+ "delay_type": {
243
+ "description": "Adds workplace charging flexibility for different scenarios. Min delay scenario indicates EV charging immediately upon arriving to work, Max delay indicates not charging until necessary thereby shifting EV charging load to later in the day and Min power indicates charging EVs at a minimum rate over the parking event.",
244
+ "type": "string",
245
+ "enum": [
246
+ "Min Delay",
247
+ "Max Delay",
248
+ "Min Power"
249
+ ]
250
+ },
251
+ "ev_charging_behavior": {
252
+ "description": "Describes scenarios for EV charging behavior, Business as Usual implies home dominant charging behavior, Free Workplace Charging at Project Site implies peak power draw from EV charging during morning hours due to EV charging at workplaces and Free Workplace Charging Across Metro Area scenario reduces Home EV charging relative to Free Workplace Charging at Project Site for residents who work elsewhere and can charge their vehicles for free at those workplaces.",
253
+ "type": "string",
254
+ "enum": [
255
+ "Business as Usual",
256
+ "Free Workplace Charging at Project Site",
257
+ "Free Workplace Charging Across Metro Area"
258
+ ]
259
+ },
260
+ "ev_percent": {
261
+ "description": "Denotes the % of vehicles parked at the building that are EVs.",
262
+ "type": "number"
263
+ },
264
+ "ev_curtailment_frac": {
265
+ "description": "Fraction between 0 and 1 that denotes curtailment of EV charging load to better align EV charging with expected energy production from a solar PV system",
266
+ "type": "number"
228
267
  }
229
268
  },
230
269
  "oneOf": [
@@ -254,7 +293,7 @@
254
293
  "building_type": {
255
294
  "enum": [
256
295
  "Single-Family Attached"
257
- ]
296
+ ]
258
297
  }
259
298
  },
260
299
  "required": [
@@ -276,7 +315,7 @@
276
315
  "building_type": {
277
316
  "enum": [
278
317
  "Multifamily"
279
- ]
318
+ ]
280
319
  }
281
320
  },
282
321
  "required": [
@@ -373,7 +412,7 @@
373
412
  ]
374
413
  },
375
414
  "systemType": {
376
- "description": "Building HVAC system type. Should this be part of a mixed type struct?",
415
+ "description": "Building HVAC system type.",
377
416
  "type": "string",
378
417
  "enum": [
379
418
  "PTAC with baseboard electric",
@@ -437,7 +476,7 @@
437
476
  "Direct evap coolers with baseboard electric",
438
477
  "Direct evap coolers with baseboard gas boiler",
439
478
  "Direct evap coolers with baseboard central air source heat pump",
440
- "Direct evap coolers with no heat",
479
+ "Direct evap coolers with no heat",
441
480
  "Direct evap coolers with gas unit heaters",
442
481
  "Direct evap coolers with forced air furnace",
443
482
  "Gas unit heaters",
@@ -50,22 +50,31 @@
50
50
  "description": "Id of the junction that this line starts at.",
51
51
  "type": "string"
52
52
  },
53
- "line_properties":{
54
- "description": "A sub-element containing all the attributes that can be assigned to a line, including wires",
55
- "type":"object",
56
- "properties":{
57
- "is_switch":{"type":"boolean","description":"Flag indicating if the line is a switch or not"},
58
- "is_fuse":{"type":"boolean","description":"Flag indicating if the line is a fuse or not"},
59
- "is_open":{"type":"boolean","description":"Flag indicating if the switch/fuse is a open or not"}
53
+ "line_properties": {
54
+ "description": "A sub-element containing all the attributes that can be assigned to a line, including wires",
55
+ "type": "object",
56
+ "properties": {
57
+ "is_switch": {
58
+ "type": "boolean",
59
+ "description": "Flag indicating if the line is a switch or not"
60
+ },
61
+ "is_fuse": {
62
+ "type": "boolean",
63
+ "description": "Flag indicating if the line is a fuse or not"
64
+ },
65
+ "is_open": {
66
+ "type": "boolean",
67
+ "description": "Flag indicating if the switch/fuse is a open or not"
60
68
  }
69
+ }
61
70
  },
62
71
  "wires": {
63
- "description": "Array of wires that are on the line",
64
- "type": "array",
65
- "items": {
66
- "$ref": "#/definitions/WireType",
67
- "type": "string"
68
- }
72
+ "description": "Array of wires that are on the line",
73
+ "type": "array",
74
+ "items": {
75
+ "$ref": "#/definitions/WireType",
76
+ "type": "string"
77
+ }
69
78
  },
70
79
  "endJunctionId": {
71
80
  "description": "Id of the junction that this line ends at.",
@@ -214,4 +223,4 @@
214
223
  ]
215
224
  }
216
225
  }
217
- }
226
+ }
@@ -105,4 +105,4 @@
105
105
  ]
106
106
  }
107
107
  }
108
- }
108
+ }
@@ -80,4 +80,4 @@
80
80
  ]
81
81
  }
82
82
  }
83
- }
83
+ }
@@ -1,5 +1,5 @@
1
1
  # *********************************************************************************
2
- # URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
2
+ # URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
3
3
  # contributors. All rights reserved.
4
4
  #
5
5
  # Redistribution and use in source and binary forms, with or without modification,
@@ -16,6 +16,16 @@
16
16
  # used to endorse or promote products derived from this software without specific
17
17
  # prior written permission.
18
18
  #
19
+ # Redistribution of this software, without modification, must refer to the software
20
+ # by the same designation. Redistribution of a modified version of this software
21
+ # (i) may not refer to the modified version by the same designation, or by any
22
+ # confusingly similar designation, and (ii) must refer to the underlying software
23
+ # originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
24
+ # the term “URBANopt”, or any confusingly similar designation may not be used to
25
+ # refer to any modified version of this software or any modified version of the
26
+ # underlying software originally provided by Alliance without the prior written
27
+ # consent of Alliance.
28
+ #
19
29
  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20
30
  # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21
31
  # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
@@ -1,5 +1,5 @@
1
1
  # *********************************************************************************
2
- # URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
2
+ # URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
3
3
  # contributors. All rights reserved.
4
4
  #
5
5
  # Redistribution and use in source and binary forms, with or without modification,
@@ -16,6 +16,16 @@
16
16
  # used to endorse or promote products derived from this software without specific
17
17
  # prior written permission.
18
18
  #
19
+ # Redistribution of this software, without modification, must refer to the software
20
+ # by the same designation. Redistribution of a modified version of this software
21
+ # (i) may not refer to the modified version by the same designation, or by any
22
+ # confusingly similar designation, and (ii) must refer to the underlying software
23
+ # originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
24
+ # the term “URBANopt”, or any confusingly similar designation may not be used to
25
+ # refer to any modified version of this software or any modified version of the
26
+ # underlying software originally provided by Alliance without the prior written
27
+ # consent of Alliance.
28
+ #
19
29
  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20
30
  # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21
31
  # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
@@ -1,5 +1,5 @@
1
1
  # *********************************************************************************
2
- # URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
2
+ # URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
3
3
  # contributors. All rights reserved.
4
4
  #
5
5
  # Redistribution and use in source and binary forms, with or without modification,
@@ -16,6 +16,16 @@
16
16
  # used to endorse or promote products derived from this software without specific
17
17
  # prior written permission.
18
18
  #
19
+ # Redistribution of this software, without modification, must refer to the software
20
+ # by the same designation. Redistribution of a modified version of this software
21
+ # (i) may not refer to the modified version by the same designation, or by any
22
+ # confusingly similar designation, and (ii) must refer to the underlying software
23
+ # originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
24
+ # the term “URBANopt”, or any confusingly similar designation may not be used to
25
+ # refer to any modified version of this software or any modified version of the
26
+ # underlying software originally provided by Alliance without the prior written
27
+ # consent of Alliance.
28
+ #
19
29
  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20
30
  # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21
31
  # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
@@ -30,6 +40,6 @@
30
40
 
31
41
  module URBANopt
32
42
  module GeoJSON
33
- VERSION = '0.4.0'.freeze
43
+ VERSION = '0.6.0'.freeze
34
44
  end
35
45
  end
@@ -1,5 +1,5 @@
1
1
  # *********************************************************************************
2
- # URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
2
+ # URBANopt (tm), Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
3
3
  # contributors. All rights reserved.
4
4
  #
5
5
  # Redistribution and use in source and binary forms, with or without modification,
@@ -16,6 +16,16 @@
16
16
  # used to endorse or promote products derived from this software without specific
17
17
  # prior written permission.
18
18
  #
19
+ # Redistribution of this software, without modification, must refer to the software
20
+ # by the same designation. Redistribution of a modified version of this software
21
+ # (i) may not refer to the modified version by the same designation, or by any
22
+ # confusingly similar designation, and (ii) must refer to the underlying software
23
+ # originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
24
+ # the term “URBANopt”, or any confusingly similar designation may not be used to
25
+ # refer to any modified version of this software or any modified version of the
26
+ # underlying software originally provided by Alliance without the prior written
27
+ # consent of Alliance.
28
+ #
19
29
  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20
30
  # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21
31
  # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
@@ -23,13 +23,12 @@ Gem::Specification.new do |spec|
23
23
  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
24
24
  spec.require_paths = ['lib']
25
25
 
26
- spec.required_ruby_version = '~> 2.5.0'
26
+ spec.required_ruby_version = '~> 2.7.0'
27
27
 
28
- spec.add_development_dependency 'bundler', '~> 2.1'
28
+ spec.add_development_dependency 'bundler', '>= 2.1.0'
29
29
  spec.add_development_dependency 'rake', '~> 13.0'
30
30
  spec.add_development_dependency 'rspec', '~> 3.7'
31
31
 
32
32
  spec.add_runtime_dependency 'json-schema', '~> 2.8'
33
- spec.add_runtime_dependency 'openstudio-extension', '~> 0.2.5'
34
- spec.add_runtime_dependency 'urbanopt-core', '~> 0.4.0'
33
+ spec.add_runtime_dependency 'urbanopt-core', '~> 0.6.0'
35
34
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: urbanopt-geojson
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tanushree Charan
@@ -10,22 +10,22 @@ authors:
10
10
  autorequire:
11
11
  bindir: exe
12
12
  cert_chain: []
13
- date: 2020-09-25 00:00:00.000000000 Z
13
+ date: 2021-04-27 00:00:00.000000000 Z
14
14
  dependencies:
15
15
  - !ruby/object:Gem::Dependency
16
16
  name: bundler
17
17
  requirement: !ruby/object:Gem::Requirement
18
18
  requirements:
19
- - - "~>"
19
+ - - ">="
20
20
  - !ruby/object:Gem::Version
21
- version: '2.1'
21
+ version: 2.1.0
22
22
  type: :development
23
23
  prerelease: false
24
24
  version_requirements: !ruby/object:Gem::Requirement
25
25
  requirements:
26
- - - "~>"
26
+ - - ">="
27
27
  - !ruby/object:Gem::Version
28
- version: '2.1'
28
+ version: 2.1.0
29
29
  - !ruby/object:Gem::Dependency
30
30
  name: rake
31
31
  requirement: !ruby/object:Gem::Requirement
@@ -68,34 +68,20 @@ dependencies:
68
68
  - - "~>"
69
69
  - !ruby/object:Gem::Version
70
70
  version: '2.8'
71
- - !ruby/object:Gem::Dependency
72
- name: openstudio-extension
73
- requirement: !ruby/object:Gem::Requirement
74
- requirements:
75
- - - "~>"
76
- - !ruby/object:Gem::Version
77
- version: 0.2.5
78
- type: :runtime
79
- prerelease: false
80
- version_requirements: !ruby/object:Gem::Requirement
81
- requirements:
82
- - - "~>"
83
- - !ruby/object:Gem::Version
84
- version: 0.2.5
85
71
  - !ruby/object:Gem::Dependency
86
72
  name: urbanopt-core
87
73
  requirement: !ruby/object:Gem::Requirement
88
74
  requirements:
89
75
  - - "~>"
90
76
  - !ruby/object:Gem::Version
91
- version: 0.4.0
77
+ version: 0.6.0
92
78
  type: :runtime
93
79
  prerelease: false
94
80
  version_requirements: !ruby/object:Gem::Requirement
95
81
  requirements:
96
82
  - - "~>"
97
83
  - !ruby/object:Gem::Version
98
- version: 0.4.0
84
+ version: 0.6.0
99
85
  description: Library and measures to translate URBANopt GeoJSON format to OpenStudio
100
86
  email:
101
87
  - tanushree.charan@nrel.gov
@@ -141,6 +127,7 @@ files:
141
127
  - docs/.vuepress/components/ThermalJunctionProperties.vue
142
128
  - docs/.vuepress/config.js
143
129
  - docs/.vuepress/highlight.js
130
+ - docs/.vuepress/json-schema-deref-loader.js
144
131
  - docs/.vuepress/public/custom_rdoc_styles.css
145
132
  - docs/.vuepress/utils.js
146
133
  - docs/README.md
@@ -211,14 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
211
198
  requirements:
212
199
  - - "~>"
213
200
  - !ruby/object:Gem::Version
214
- version: 2.5.0
201
+ version: 2.7.0
215
202
  required_rubygems_version: !ruby/object:Gem::Requirement
216
203
  requirements:
217
204
  - - ">="
218
205
  - !ruby/object:Gem::Version
219
206
  version: '0'
220
207
  requirements: []
221
- rubygems_version: 3.1.4
208
+ rubygems_version: 3.1.2
222
209
  signing_key:
223
210
  specification_version: 4
224
211
  summary: Translate URBANopt GeoJSON format to OpenStudio