urbanopt-geojson 0.7.0 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (44) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/CHANGELOG.md +22 -0
  4. data/LICENSE.md +1 -1
  5. data/doc_templates/LICENSE.md +1 -1
  6. data/doc_templates/copyright_erb.txt +1 -1
  7. data/doc_templates/copyright_js.txt +2 -2
  8. data/doc_templates/copyright_ruby.txt +1 -1
  9. data/docs/package-lock.json +15961 -1719
  10. data/lib/measures/urban_geometry_creation/measure.rb +1 -1
  11. data/lib/measures/urban_geometry_creation_zoning/measure.rb +1 -1
  12. data/lib/urbanopt/geojson/building.rb +1 -1
  13. data/lib/urbanopt/geojson/derived_extension.rb +1 -1
  14. data/lib/urbanopt/geojson/district_system.rb +1 -1
  15. data/lib/urbanopt/geojson/feature.rb +2 -2
  16. data/lib/urbanopt/geojson/geo_file.rb +18 -3
  17. data/lib/urbanopt/geojson/helper.rb +1 -1
  18. data/lib/urbanopt/geojson/logging.rb +1 -1
  19. data/lib/urbanopt/geojson/mapper_classes.rb +1 -1
  20. data/lib/urbanopt/geojson/model.rb +1 -1
  21. data/lib/urbanopt/geojson/region.rb +1 -1
  22. data/lib/urbanopt/geojson/scale_area.rb +1 -1
  23. data/lib/urbanopt/geojson/schema/breaker_properties.json +33 -0
  24. data/lib/urbanopt/geojson/schema/building_properties.json +641 -591
  25. data/lib/urbanopt/geojson/schema/capacitor_properties.json +38 -0
  26. data/lib/urbanopt/geojson/schema/consumer_properties.json +58 -0
  27. data/lib/urbanopt/geojson/schema/distribution_generator.json +45 -0
  28. data/lib/urbanopt/geojson/schema/distribution_transformer.json +54 -0
  29. data/lib/urbanopt/geojson/schema/district_system_properties.json +10 -15
  30. data/lib/urbanopt/geojson/schema/dummy_node_properties.json +21 -0
  31. data/lib/urbanopt/geojson/schema/electrical_connector_properties.json +6 -135
  32. data/lib/urbanopt/geojson/schema/hvmv_substation_properties.json +54 -0
  33. data/lib/urbanopt/geojson/schema/line_properties.json +69 -0
  34. data/lib/urbanopt/geojson/schema/region_properties.json +1 -1
  35. data/lib/urbanopt/geojson/schema/site_properties.json +126 -98
  36. data/lib/urbanopt/geojson/schema/switch_properties.json +33 -0
  37. data/lib/urbanopt/geojson/update_areas.rb +1 -1
  38. data/lib/urbanopt/geojson/validate_geojson.rb +1 -1
  39. data/lib/urbanopt/geojson/version.rb +2 -2
  40. data/lib/urbanopt/geojson/zoning.rb +1 -1
  41. data/lib/urbanopt/geojson.rb +1 -1
  42. data/lib/urbanopt-geojson.rb +1 -1
  43. data/urbanopt-geojson-gem.gemspec +1 -1
  44. metadata +13 -4
@@ -0,0 +1,38 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "id": "http://json-schema.org/openstudio-urban-modeling/capacitor_properties.json#",
4
+ "title": "URBANopt Capacitor",
5
+ "description": "Schema for an URBANopt RNM Capacitor object",
6
+ "type": "object",
7
+ "properties": {
8
+ "Code": {
9
+ "description": "Unique name/ID of the feature in the RNM analysis.",
10
+ "type": "string"
11
+ },
12
+ "Node": {
13
+ "description": "Name/ID of the RNM analysis feature it is associated with.",
14
+ "type": "string"
15
+ },
16
+ "Phases": {
17
+ "description": "Phase",
18
+ "type": "string",
19
+ "enum": ["1", "3"]
20
+ },
21
+ "NomV_kV": {
22
+ "description": "Nominal Voltage in kV.",
23
+ "type": "string"
24
+ },
25
+ "Size_kVAr": {
26
+ "description": "Size in kVAr.",
27
+ "type": "string"
28
+ },
29
+ "Subest": {
30
+ "description": "Substation the capacitor is connected to.",
31
+ "type": "string"
32
+ },
33
+ "Feeder": {
34
+ "description": "Feeder the capacitor is connected to.",
35
+ "type": "string"
36
+ }
37
+ }
38
+ }
@@ -0,0 +1,58 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "id": "http://json-schema.org/openstudio-urban-modeling/consumer_properties.json#",
4
+ "title": "URBANopt Consumer",
5
+ "description": "Schema for an URBANopt RNM Consumer object",
6
+ "type": "object",
7
+ "properties": {
8
+ "Code": {
9
+ "description": "Unique name/ID of the feature in the RNM analysis.",
10
+ "type": "string"
11
+ },
12
+ "Node": {
13
+ "description": "Name/ID of the RNM analysis feature it is associated with.",
14
+ "type": "string"
15
+ },
16
+ "Phases": {
17
+ "description": "Phase",
18
+ "type": "string",
19
+ "enum": ["1", "3"]
20
+ },
21
+ "Nvolt_kV": {
22
+ "description": "Voltage level in kV. Low voltage is represented as 0.42kV, medium voltage as 12.47kV.",
23
+ "type": "string"
24
+ },
25
+ "DemP_kW": {
26
+ "description": "Demand active power, in kW.",
27
+ "type": "string"
28
+ },
29
+ "DemQ_kVAr": {
30
+ "description": "Demand reactive power, in kVAr.",
31
+ "type": "string"
32
+ },
33
+ "Subest": {
34
+ "description": "Substation the consumer is connected to.",
35
+ "type": "string"
36
+ },
37
+ "Feeder": {
38
+ "description": "Feeder the consumer is connected to.",
39
+ "type": "string"
40
+ },
41
+ "Pinst_kW": {
42
+ "description": "Installed active power in kW. Consumers are modeled in RNM so that installed power equals demand power.",
43
+ "type": "string"
44
+ },
45
+ "Qinst_kVAr": {
46
+ "description": "Installed reactive power in KVAr.",
47
+ "type": "string"
48
+ },
49
+ "Yearly_kWh": {
50
+ "description": "Annual energy consumption in kWh, extracted from URBANopt reports.",
51
+ "type": "string"
52
+ },
53
+ "NumCust": {
54
+ "description": "Number of customers, extracted from URBANopt default feature reports.",
55
+ "type": "string"
56
+ }
57
+ }
58
+ }
@@ -0,0 +1,45 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "id": "http://json-schema.org/openstudio-urban-modeling/distribution_generator_properties.json#",
4
+ "title": "URBANopt Distribution Generator",
5
+ "description": "Schema for an URBANopt RNM Distribution Generator object",
6
+ "type": "object",
7
+ "properties": {
8
+ "Capac_kW": {
9
+ "description": "Capacity / installed power in kW.",
10
+ "type": "string"
11
+ },
12
+ "GenP_kW": {
13
+ "description": "Peak active power kW. Used to model the network.",
14
+ "type": "string"
15
+ },
16
+ "GenQ_kVAr": {
17
+ "description": "Peak reactive power in kVAr. Used to model the network.",
18
+ "type": "string"
19
+ },
20
+ "Pinst_kW": {
21
+ "description": "Installed active power in kW.",
22
+ "type": "string"
23
+ },
24
+ "Code": {
25
+ "description": "Unique name/ID of the feature in the RNM analysis.",
26
+ "type": "string"
27
+ },
28
+ "Node": {
29
+ "description": "Name/ID of the RNM analysis feature it is associated with.",
30
+ "type": "string"
31
+ },
32
+ "NomV_kV": {
33
+ "description": "Nominal Voltage in kV.",
34
+ "type": "string"
35
+ },
36
+ "Subest": {
37
+ "description": "Substation the generator is connected to.",
38
+ "type": "string"
39
+ },
40
+ "Feeder": {
41
+ "description": "Feeder the generator is connected to.",
42
+ "type": "string"
43
+ }
44
+ }
45
+ }
@@ -0,0 +1,54 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "id": "http://json-schema.org/openstudio-urban-modeling/distribution_transformer_properties.json#",
4
+ "title": "URBANopt Distribution Transformer",
5
+ "description": "Schema for an URBANopt RNM Distribution Transformer object",
6
+ "type": "object",
7
+ "properties": {
8
+ "Code": {
9
+ "description": "Unique name/ID of the feature in the RNM analysis.",
10
+ "type": "string"
11
+ },
12
+ "NodeA": {
13
+ "description": "Name/ID of the RNM 'From' Node it is associated with.",
14
+ "type": "string"
15
+ },
16
+ "NodeB": {
17
+ "description": "Name/ID of the RNM 'To' Node it is associated with.",
18
+ "type": "string"
19
+ },
20
+ "Vnom1": {
21
+ "description": "Nominal high voltage in kV.",
22
+ "type": "string"
23
+ },
24
+ "Vnom2": {
25
+ "description": "Nominal low voltage in kV.",
26
+ "type": "string"
27
+ },
28
+ "Phases": {
29
+ "description": "Phase",
30
+ "type": "string",
31
+ "enum": ["3-phase", "single phase"]
32
+ },
33
+ "Xsc(pu)": {
34
+ "description": "Reactance short-circuit (per unit). How much deviation per unit (multiplier).",
35
+ "type": "string"
36
+ },
37
+ "TapMin": {
38
+ "description": "Tap minimum. How much the voltage value can be decreased (multiplier).",
39
+ "type": "string"
40
+ },
41
+ "TapMax": {
42
+ "description": "Tap maximum. How much the voltage value can be increased (multiplier).",
43
+ "type": "string"
44
+ },
45
+ "Subest": {
46
+ "description": "Substation the transformer is connected to.",
47
+ "type": "string"
48
+ },
49
+ "Feeder": {
50
+ "description": "Feeder the transformer is connected to.",
51
+ "type": "string"
52
+ }
53
+ }
54
+ }
@@ -60,7 +60,7 @@
60
60
  "type": "string"
61
61
  },
62
62
  "equipment": {
63
- "description": "List of equipment in this plant",
63
+ "description": "List of equipment in this plant. This is no longer used for Electrical workflow; use electrical_catalog_name field istead.",
64
64
  "type": "array",
65
65
  "items": {
66
66
  "$ref": "#/definitions/equipmentType",
@@ -71,6 +71,14 @@
71
71
  "description": "ID of the building associated with the Ground-Mount PV System",
72
72
  "type": "string"
73
73
  },
74
+ "electrical_catalog_name": {
75
+ "description": "Name of the equipment as specified in the OpenDSS/RNM electrical catalog (extended_catalog.json)",
76
+ "type": "string"
77
+ },
78
+ "phases": {
79
+ "description": "Equipment Phases information. Required by the OpenDSS workflow. Example: ['A', 'B', 'C']",
80
+ "type": "array"
81
+ },
74
82
  "user_data": {
75
83
  "description": "Arbitrary user data"
76
84
  }
@@ -99,15 +107,13 @@
99
107
  ]
100
108
  },
101
109
  "equipmentType": {
102
- "description": "Type of equipment, listed in order of load served.",
110
+ "description": "Type of districct energy system equipment, listed in order of load served.",
103
111
  "type": "string",
104
112
  "enum": [
105
113
  "Air-Cooled Chiller--Cold Water",
106
114
  "Air-Cooled Chiller--Ambient Water",
107
115
  "Water-Cooled Chiller--Cold Water",
108
116
  "Water-Cooled Chiller---Ambient Water",
109
- "Capacitor--150KVAR",
110
- "Capacitor--450KVAR",
111
117
  "Cooling Tower--Heat Rejection from Chiller, Cold Water",
112
118
  "Cooling Tower--Heat Rejection from Chiller, Ambient Water",
113
119
  "Cooling Tower--Direct--Chilled Water",
@@ -130,17 +136,6 @@
130
136
  "Storage--Hot Water",
131
137
  "Storage--Cold Water",
132
138
  "Storage--Ambient Water",
133
- "Transformer--25KVA CT",
134
- "Transformer--50KVA CT",
135
- "Transformer--75KVA CT",
136
- "Transformer--25KVA PM",
137
- "Transformer--50KVA PM",
138
- "Transformer--75KVA PM",
139
- "Transformer--100KVA PM",
140
- "Transformer--150KVA PM",
141
- "Transformer--300KVA PM",
142
- "Transformer--500KVA PM",
143
- "Transformer--750KVA PM",
144
139
  "Waste Heat Source--Hot Water",
145
140
  "Waste Heat Source--Ambient Water"
146
141
  ]
@@ -0,0 +1,21 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "id": "http://json-schema.org/openstudio-urban-modeling/dummy_node_properties.json#",
4
+ "title": "URBANopt Dummy Node",
5
+ "description": "Schema for an URBANopt RNM Dummy Node object",
6
+ "type": "object",
7
+ "properties": {
8
+ "Node": {
9
+ "description": "Unique name/id of the feature in the RNM analysis.",
10
+ "type": "string"
11
+ },
12
+ "Subest": {
13
+ "description": "Substation the node is connected to",
14
+ "type": "string"
15
+ },
16
+ "Feeder": {
17
+ "description": "Feeder the node is connected to",
18
+ "type": "string"
19
+ }
20
+ }
21
+ }
@@ -50,6 +50,10 @@
50
50
  "description": "Id of the junction that this line starts at.",
51
51
  "type": "string"
52
52
  },
53
+ "endJunctionId": {
54
+ "description": "Id of the junction that this line ends at.",
55
+ "type": "string"
56
+ },
53
57
  "line_properties": {
54
58
  "description": "A sub-element containing all the attributes that can be assigned to a line, including wires",
55
59
  "type": "object",
@@ -68,16 +72,8 @@
68
72
  }
69
73
  }
70
74
  },
71
- "wires": {
72
- "description": "Array of wires that are on the line",
73
- "type": "array",
74
- "items": {
75
- "$ref": "#/definitions/WireType",
76
- "type": "string"
77
- }
78
- },
79
- "endJunctionId": {
80
- "description": "Id of the junction that this line ends at.",
75
+ "electrical_catalog_name": {
76
+ "description": "Name of the equipment as specified in the OpenDSS/RNM electrical catalog (extended_catalog.json)",
81
77
  "type": "string"
82
78
  },
83
79
  "user_data": {
@@ -99,131 +95,6 @@
99
95
  "enum": [
100
96
  "Wire"
101
97
  ]
102
- },
103
- "WireType": {
104
- "description": "Type of wire used",
105
- "type": "string",
106
- "enum": [
107
- "OH TPLX #4 S1",
108
- "OH TPLX #4 S2",
109
- "OH TPLX #4 A",
110
- "OH TPLX #4 B",
111
- "OH TPLX #4 C",
112
- "OH TPLX #4 N",
113
- "OH TPLX 1/0 S1",
114
- "OH TPLX 1/0 S2",
115
- "OH TPLX 1/0 A",
116
- "OH TPLX 1/0 B",
117
- "OH TPLX 1/0 C",
118
- "OH TPLX 1/0 N",
119
- "OH TPLX 2/0 S1",
120
- "OH TPLX 2/0 S2",
121
- "OH TPLX 2/0 A",
122
- "OH TPLX 2/0 B",
123
- "OH TPLX 2/0 C",
124
- "OH TPLX 2/0 N",
125
- "OH TPLX 4/0 S1",
126
- "OH TPLX 4/0 S2",
127
- "OH TPLX 4/0 A",
128
- "OH TPLX 4/0 B",
129
- "OH TPLX 4/0 C",
130
- "OH TPLX 4/0 N",
131
- "OH AL #2 A",
132
- "OH AL #2 B",
133
- "OH AL #2 C",
134
- "OH AL #2 N",
135
- "OH AL #4 A",
136
- "OH AL #4 B",
137
- "OH AL #4 C",
138
- "OH AL #4 N",
139
- "OH AL 1/0 A",
140
- "OH AL 1/0 B",
141
- "OH AL 1/0 C",
142
- "OH AL 1/0 N",
143
- "OH AL 2/0 A",
144
- "OH AL 2/0 B",
145
- "OH AL 2/0 C",
146
- "OH AL 2/0 N",
147
- "OH AL 4/0 A",
148
- "OH AL 4/0 B",
149
- "OH AL 4/0 C",
150
- "OH AL 4/0 N",
151
- "OH AL 336kcmil A",
152
- "OH AL 336kcmil B",
153
- "OH AL 336kcmil C",
154
- "OH AL 336kcmil N",
155
- "OH AL 477kcmil A",
156
- "OH AL 477kcmil B",
157
- "OH AL 477kcmil C",
158
- "OH AL 477kcmil N",
159
- "OH AL 795kcmil A",
160
- "OH AL 795kcmil B",
161
- "OH AL 795kcmil C",
162
- "OH AL 795kcmil N",
163
- "UG TPLX #4 S1",
164
- "UG TPLX #4 S2",
165
- "UG TPLX #4 A",
166
- "UG TPLX #4 B",
167
- "UG TPLX #4 C",
168
- "UG TPLX #4 N",
169
- "UG TPLX 1/0 S1",
170
- "UG TPLX 1/0 S2",
171
- "UG TPLX 1/0 A",
172
- "UG TPLX 1/0 B",
173
- "UG TPLX 1/0 C",
174
- "UG TPLX 1/0 N",
175
- "UG TPLX 2/0 S1",
176
- "UG TPLX 2/0 S2",
177
- "UG TPLX 2/0 A",
178
- "UG TPLX 2/0 B",
179
- "UG TPLX 2/0 C",
180
- "UG TPLX 2/0 N",
181
- "UG TPLX 4/0 S1",
182
- "UG TPLX 4/0 S2",
183
- "UG TPLX 4/0 A",
184
- "UG TPLX 4/0 B",
185
- "UG TPLX 4/0 C",
186
- "UG TPLX 4/0 N",
187
- "UG AL #2 A",
188
- "UG AL #2 B",
189
- "UG AL #2 C",
190
- "UG AL #2 N",
191
- "UG AL #4 A",
192
- "UG AL #4 B",
193
- "UG AL #4 C",
194
- "UG AL #4 N",
195
- "UG AL 1/0 A",
196
- "UG AL 1/0 B",
197
- "UG AL 1/0 C",
198
- "UG AL 1/0 N",
199
- "UG AL 2/0 A",
200
- "UG AL 2/0 B",
201
- "UG AL 2/0 C",
202
- "UG AL 2/0 N",
203
- "UG AL 4/0 A",
204
- "UG AL 4/0 B",
205
- "UG AL 4/0 C",
206
- "UG AL 4/0 N",
207
- "UG AL 350kcmil A",
208
- "UG AL 350kcmil B",
209
- "UG AL 350kcmil C",
210
- "UG AL 350kcmil N",
211
- "UG AL 500kcmil A",
212
- "UG AL 500kcmil B",
213
- "UG AL 500kcmil C",
214
- "UG AL 500kcmil N",
215
- "UG AL 750kcmil A",
216
- "UG AL 750kcmil B",
217
- "UG AL 750kcmil C",
218
- "UG AL 750kcmil N",
219
- "UG AL 1000kcmil A",
220
- "UG AL 1000kcmil B",
221
- "UG AL 1000kcmil C",
222
- "UG AL 1000kcmil N",
223
- "UG AL 1000mcm A",
224
- "UG AL 1000mcm B",
225
- "UG AL 1000mcm C"
226
- ]
227
98
  }
228
99
  }
229
100
  }
@@ -0,0 +1,54 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "id": "http://json-schema.org/openstudio-urban-modeling/hvmv_substation_properties.json#",
4
+ "title": "URBANopt HVMV Substation",
5
+ "description": "Schema for an URBANopt RNM HVMV Substation object",
6
+ "type": "object",
7
+ "properties": {
8
+ "Code": {
9
+ "description": "Unique name/ID of the feature in the RNM analysis.",
10
+ "type": "string"
11
+ },
12
+ "NodeA": {
13
+ "description": "Name/ID of the RNM 'From' Node it is associated with.",
14
+ "type": "string"
15
+ },
16
+ "NodeB": {
17
+ "description": "Name/ID of the RNM 'To' Node it is associated with.",
18
+ "type": "string"
19
+ },
20
+ "Vnom1": {
21
+ "description": "Nominal high voltange in kV.",
22
+ "type": "string"
23
+ },
24
+ "Vnom2": {
25
+ "description": "Nominal low voltage in kV.",
26
+ "type": "string"
27
+ },
28
+ "Phases": {
29
+ "description": "Phase",
30
+ "type": "string",
31
+ "enum": ["3-phase", "single phase"]
32
+ },
33
+ "Xsc(pu)": {
34
+ "description": "Reactance short-circuit (per unit). How much deviation per unit (multiplier).",
35
+ "type": "string"
36
+ },
37
+ "TapMin": {
38
+ "description": "Tap minimum. How much the voltage value can be decreased (multiplier).",
39
+ "type": "string"
40
+ },
41
+ "TapMax": {
42
+ "description": "Tap maximum. How much the voltage value can be increased (multiplier).",
43
+ "type": "string"
44
+ },
45
+ "Subest": {
46
+ "description": "Substation the substation is connected to.",
47
+ "type": "string"
48
+ },
49
+ "Feeder": {
50
+ "description": "Feeder the substation is connected to.",
51
+ "type": "string"
52
+ }
53
+ }
54
+ }
@@ -0,0 +1,69 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "id": "http://json-schema.org/openstudio-urban-modeling/line_properties.json#",
4
+ "title": "URBANopt Line",
5
+ "description": "Schema for an URBANopt RNM Line object",
6
+ "type": "object",
7
+ "properties": {
8
+ "Code": {
9
+ "description": "Unique name/ID of the feature in the RNM analysis.",
10
+ "type": "string"
11
+ },
12
+ "NodeA": {
13
+ "description": "Name/ID of the RNM 'From' Node it is associated with.",
14
+ "type": "string"
15
+ },
16
+ "NodeB": {
17
+ "description": "Name/ID of the RNM 'To' Node it is associated with.",
18
+ "type": "string"
19
+ },
20
+ "NomV": {
21
+ "description": "Nominal Voltage in kV.",
22
+ "type": "string"
23
+ },
24
+ "Len": {
25
+ "description": "Length of line in km.",
26
+ "type": "string"
27
+ },
28
+ "Equip": {
29
+ "description": "Type of line used. Options can be found in the electrical catalog.",
30
+ "type": "string"
31
+ },
32
+ "R": {
33
+ "description": "Resistance in ohms.",
34
+ "type": "string"
35
+ },
36
+ "X": {
37
+ "description": "Impedance in ohms/km.",
38
+ "type": "string"
39
+ },
40
+ "C": {
41
+ "description": "Capacitance in nF/km.",
42
+ "type": "string"
43
+ },
44
+ "R0": {
45
+ "description": "0-Resistance in ohms.",
46
+ "type": "string"
47
+ },
48
+ "X0": {
49
+ "description": "0-Impedance in ohms/km.",
50
+ "type": "string"
51
+ },
52
+ "C0": {
53
+ "description": "0-Capacitance in nF/km.",
54
+ "type": "string"
55
+ },
56
+ "Imax": {
57
+ "description": "Maximum current in A.",
58
+ "type": "string"
59
+ },
60
+ "Status": {
61
+ "description": "Line Status. If 1, the power line is closed (operating); if 0, the line is open (not operating).",
62
+ "type": "string"
63
+ },
64
+ "Phases": {
65
+ "description": "Phase of the line. If single phase, options are: A, B, or C (separated from 3-phase). If 3-phase: ABC.",
66
+ "type": "string"
67
+ }
68
+ }
69
+ }
@@ -90,4 +90,4 @@
90
90
  "region_type"
91
91
  ],
92
92
  "additionalProperties": false
93
- }
93
+ }