urbanopt-geojson 0.7.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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
@@ -1,99 +1,127 @@
1
1
  {
2
- "$schema": "http://json-schema.org/draft-04/schema#",
3
- "id": "http://json-schema.org/openstudio-urban-modeling/taxlot_properties.json#",
4
- "title": "URBANopt Site",
5
- "description": "Schema for an URBANopt Site object",
6
- "type": "object",
7
- "properties": {
8
- "id": {
9
- "description": "Unique id used to refer to this feature within this dataset, generated by database.",
10
- "type": "string"
11
- },
12
- "project_id": {
13
- "description": "Project which this feature belongs to.",
14
- "type": "string"
15
- },
16
- "name": {
17
- "description": "Feature name",
18
- "type": "string"
19
- },
20
- "state": {
21
- "description": "State name",
22
- "type": "string"
23
- },
24
- "city": {
25
- "description": "City name",
26
- "type": "string"
27
- },
28
- "latitude": {
29
- "description": "Latitude of site origin in WGS 84 coordinate system (deg)",
30
- "type": "number"
31
- },
32
- "longitude": {
33
- "description": "Longitude of site origin in WGS 84 coordinate system (deg)",
34
- "type": "number"
35
- },
36
- "surface_elevation": {
37
- "description": "The surface elevation (above NAVD88 datum) of the project (ft). ",
38
- "type": "number"
39
- },
40
- "import_surrounding_buildings_as_shading": {
41
- "description": "If true, import geometry from surrounding buildings when performing energy calculations.",
42
- "type": "boolean"
43
- },
44
- "timesteps_per_hour": {
45
- "description": "Number of timesteps per hour for energy simulations.",
46
- "type": "integer",
47
- "minimum": 1,
48
- "maximum": 60
49
- },
50
- "begin_date": {
51
- "description": "Date to begin simulation, format YYYY-MM-DD.",
52
- "type": "string"
53
- },
54
- "end_date": {
55
- "description": "Date to end simulation, format YYYY-MM-DD.",
56
- "type": "string"
57
- },
58
- "climate_zone": {
59
- "description": "ASHRAE 169 climate zone.",
60
- "type": "string"
61
- },
62
- "cec_climate_zone": {
63
- "description": "CEC Title24 climate zone.",
64
- "type": "string"
65
- },
66
- "default_template": {
67
- "description": "Default OpenStudio Standards template.",
68
- "type": "string"
69
- },
70
- "weather_filename": {
71
- "description": "Name of weather file in EPW format.",
72
- "type": "string"
73
- },
74
- "tariff_filename": {
75
- "description": "Name of utility tariff file in IDF or URDB format.",
76
- "type": "string"
77
- },
78
- "underground_cables_ratio": {
79
- "description": "Ratio of overall cables that are underground vs. overhead for RNM analysis.",
80
- "type": "number"
81
- },
82
- "only_lv_consumers": {
83
- "description": "If true, only low voltage consumers will be considered in the RNM analysis.",
84
- "type": "boolean"
85
- },
86
- "max_number_of_lv_nodes_per_building": {
87
- "description": "Maximum number of low voltage nodes to represent a single building.",
88
- "type": "number"
89
- },
90
- "user_data": {
91
- "description": "Arbitrary user data"
92
- }
93
- },
94
- "required": [
95
- "latitude",
96
- "longitude"
97
- ],
98
- "additionalProperties": false
99
- }
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "id": "http://json-schema.org/openstudio-urban-modeling/taxlot_properties.json#",
4
+ "title": "URBANopt Site",
5
+ "description": "Schema for an URBANopt Site object",
6
+ "type": "object",
7
+ "properties": {
8
+ "id": {
9
+ "description": "Unique id used to refer to this feature within this dataset, generated by database.",
10
+ "type": "string"
11
+ },
12
+ "project_id": {
13
+ "description": "Project which this feature belongs to.",
14
+ "type": "string"
15
+ },
16
+ "name": {
17
+ "description": "Feature name",
18
+ "type": "string"
19
+ },
20
+ "state": {
21
+ "description": "State name",
22
+ "type": "string"
23
+ },
24
+ "city": {
25
+ "description": "City name",
26
+ "type": "string"
27
+ },
28
+ "latitude": {
29
+ "description": "Latitude of site origin in WGS 84 coordinate system (deg)",
30
+ "type": "number"
31
+ },
32
+ "longitude": {
33
+ "description": "Longitude of site origin in WGS 84 coordinate system (deg)",
34
+ "type": "number"
35
+ },
36
+ "surface_elevation": {
37
+ "description": "The surface elevation (above NAVD88 datum) of the project (ft). ",
38
+ "type": "number"
39
+ },
40
+ "import_surrounding_buildings_as_shading": {
41
+ "description": "If true, import geometry from surrounding buildings when performing energy calculations.",
42
+ "type": "boolean"
43
+ },
44
+ "timesteps_per_hour": {
45
+ "description": "Number of timesteps per hour for energy simulations.",
46
+ "type": "integer",
47
+ "minimum": 1,
48
+ "maximum": 60
49
+ },
50
+ "begin_date": {
51
+ "description": "Date to begin simulation, format YYYY-MM-DD.",
52
+ "type": "string"
53
+ },
54
+ "end_date": {
55
+ "description": "Date to end simulation, format YYYY-MM-DD.",
56
+ "type": "string"
57
+ },
58
+ "climate_zone": {
59
+ "description": "ASHRAE 169 climate zone.",
60
+ "type": "string"
61
+ },
62
+ "cec_climate_zone": {
63
+ "description": "CEC Title24 climate zone.",
64
+ "type": "string"
65
+ },
66
+ "default_template": {
67
+ "description": "Default OpenStudio Standards template.",
68
+ "type": "string"
69
+ },
70
+ "weather_filename": {
71
+ "description": "Name of weather file in EPW format.",
72
+ "type": "string"
73
+ },
74
+ "tariff_filename": {
75
+ "description": "Name of utility tariff file in IDF or URDB format.",
76
+ "type": "string"
77
+ },
78
+ "underground_cables_ratio": {
79
+ "description": "Ratio of overall cables that are underground vs. overhead for RNM analysis.",
80
+ "type": "number"
81
+ },
82
+ "only_lv_consumers": {
83
+ "description": "If true, only low voltage consumers will be considered in the RNM analysis.",
84
+ "type": "boolean"
85
+ },
86
+ "max_number_of_lv_nodes_per_building": {
87
+ "description": "Maximum number of low voltage nodes to represent a single building.",
88
+ "type": "number"
89
+ },
90
+ "emissions": {
91
+ "description": "Should be set to true to calculate emissions for the associated building.",
92
+ "type": "boolean"
93
+ },
94
+ "emissions_future_subregion": {
95
+ "description": "Future subregion. Options are: AZNMc, CAMXc, ERCTc, FRCCc, MROEc, MROWc, NEWEc, NWPPc, NYSTc, RFCEc, RFCMc, RFCWc, RMPAc, SPNOc, SPSOc, SRMVc, SRMWc, SRSOc, SRTVc, and SRVCc",
96
+ "type": "string"
97
+ },
98
+ "emissions_hourly_historical_subregion": {
99
+ "description": "Historical hourly subregion. Options are: California, Carolinas, Central, Florida, Mid-Atlantic, Midwest, New England, New York, Northwest, Rocky Mountains, Southeast, Southwest, Tennessee, and Texas",
100
+ "type": "string"
101
+ },
102
+ "emissions_annual_historical_subregion": {
103
+ "description": "Historical annual subregion. Options are: AKGD, AKMS, AZNM, CAMX, ERCT, FRCC, HIMS, HIOA, MROE, MROW, NEWE, NWPP, NYCW, NYLI, NYUP, RFCE, RFCM, RFCW, RMPA, SPNO, SPSO, SRMV, SRMW, SRSO, SRTV, and SRVC",
104
+ "type": "string"
105
+ },
106
+ "emissions_future_year": {
107
+ "description": "Future Year. Options are: 2020 to 2050 in two year increments",
108
+ "type": "string"
109
+ },
110
+ "emissions_hourly_historical_year": {
111
+ "description": "Hourly Historical Year. Options are: 2019.",
112
+ "type": "string"
113
+ },
114
+ "emissions_annual_historical_year": {
115
+ "description": "Annual Historical Year. Options are: 2007, 2009, 2010, 2012, 2014, 2016, 2018, and 2019.",
116
+ "type": "string"
117
+ },
118
+ "user_data": {
119
+ "description": "Arbitrary user data"
120
+ }
121
+ },
122
+ "required": [
123
+ "latitude",
124
+ "longitude"
125
+ ],
126
+ "additionalProperties": false
127
+ }
@@ -0,0 +1,33 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "id": "http://json-schema.org/openstudio-urban-modeling/switch_properties.json#",
4
+ "title": "URBANopt Switch",
5
+ "description": "Schema for an URBANopt RNM Switch 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_kV": {
21
+ "description": "Nominal Voltage in kV.",
22
+ "type": "string"
23
+ },
24
+ "Subest": {
25
+ "description": "Substation the switch is connected to.",
26
+ "type": "string"
27
+ },
28
+ "Feeder": {
29
+ "description": "Feeder the switch is connected to.",
30
+ "type": "string"
31
+ }
32
+ }
33
+ }
@@ -1,5 +1,5 @@
1
1
  # *********************************************************************************
2
- # URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
2
+ # URBANopt™, Copyright (c) 2019-2022, 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,
@@ -1,5 +1,5 @@
1
1
  # *********************************************************************************
2
- # URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
2
+ # URBANopt™, Copyright (c) 2019-2022, 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,
@@ -1,5 +1,5 @@
1
1
  # *********************************************************************************
2
- # URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
2
+ # URBANopt™, Copyright (c) 2019-2022, 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,
@@ -40,6 +40,6 @@
40
40
 
41
41
  module URBANopt
42
42
  module GeoJSON
43
- VERSION = '0.7.0'.freeze
43
+ VERSION = '0.8.0'.freeze
44
44
  end
45
45
  end
@@ -1,5 +1,5 @@
1
1
  # *********************************************************************************
2
- # URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
2
+ # URBANopt™, Copyright (c) 2019-2022, 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,
@@ -1,5 +1,5 @@
1
1
  # *********************************************************************************
2
- # URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
2
+ # URBANopt™, Copyright (c) 2019-2022, 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,
@@ -1,5 +1,5 @@
1
1
  # *********************************************************************************
2
- # URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
2
+ # URBANopt™, Copyright (c) 2019-2022, 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,
@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
30
30
  spec.add_development_dependency 'rspec', '~> 3.9'
31
31
 
32
32
  spec.add_runtime_dependency 'json-schema', '~> 2.8'
33
- spec.add_runtime_dependency 'urbanopt-core', '~> 0.7.0'
33
+ spec.add_runtime_dependency 'urbanopt-core', '~> 0.8.0'
34
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.7.0
4
+ version: 0.8.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tanushree Charan
@@ -10,7 +10,7 @@ authors:
10
10
  autorequire:
11
11
  bindir: exe
12
12
  cert_chain: []
13
- date: 2021-11-22 00:00:00.000000000 Z
13
+ date: 2022-05-13 00:00:00.000000000 Z
14
14
  dependencies:
15
15
  - !ruby/object:Gem::Dependency
16
16
  name: bundler
@@ -74,14 +74,14 @@ dependencies:
74
74
  requirements:
75
75
  - - "~>"
76
76
  - !ruby/object:Gem::Version
77
- version: 0.7.0
77
+ version: 0.8.0
78
78
  type: :runtime
79
79
  prerelease: false
80
80
  version_requirements: !ruby/object:Gem::Requirement
81
81
  requirements:
82
82
  - - "~>"
83
83
  - !ruby/object:Gem::Version
84
- version: 0.7.0
84
+ version: 0.8.0
85
85
  description: Library and measures to translate URBANopt GeoJSON format to OpenStudio
86
86
  email:
87
87
  - tanushree.charan@nrel.gov
@@ -167,13 +167,22 @@ files:
167
167
  - lib/urbanopt/geojson/model.rb
168
168
  - lib/urbanopt/geojson/region.rb
169
169
  - lib/urbanopt/geojson/scale_area.rb
170
+ - lib/urbanopt/geojson/schema/breaker_properties.json
170
171
  - lib/urbanopt/geojson/schema/building_properties.json
172
+ - lib/urbanopt/geojson/schema/capacitor_properties.json
173
+ - lib/urbanopt/geojson/schema/consumer_properties.json
174
+ - lib/urbanopt/geojson/schema/distribution_generator.json
175
+ - lib/urbanopt/geojson/schema/distribution_transformer.json
171
176
  - lib/urbanopt/geojson/schema/district_system_properties.json
177
+ - lib/urbanopt/geojson/schema/dummy_node_properties.json
172
178
  - lib/urbanopt/geojson/schema/electrical_connector_properties.json
173
179
  - lib/urbanopt/geojson/schema/electrical_junction_properties.json
174
180
  - lib/urbanopt/geojson/schema/geojson_schema.json
181
+ - lib/urbanopt/geojson/schema/hvmv_substation_properties.json
182
+ - lib/urbanopt/geojson/schema/line_properties.json
175
183
  - lib/urbanopt/geojson/schema/region_properties.json
176
184
  - lib/urbanopt/geojson/schema/site_properties.json
185
+ - lib/urbanopt/geojson/schema/switch_properties.json
177
186
  - lib/urbanopt/geojson/schema/thermal_connector_properties.json
178
187
  - lib/urbanopt/geojson/schema/thermal_junction_properties.json
179
188
  - lib/urbanopt/geojson/update_areas.rb