urbanopt-geojson 1.0.0 → 1.1.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 (14) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/nightly_build.yml +1 -1
  3. data/CHANGELOG.md +12 -0
  4. data/Gemfile +2 -3
  5. data/lib/measures/urban_geometry_creation/LICENSE.md +1 -1
  6. data/lib/measures/urban_geometry_creation/README.md +34 -4
  7. data/lib/measures/urban_geometry_creation/measure.xml +4 -5
  8. data/lib/measures/urban_geometry_creation_zoning/LICENSE.md +1 -1
  9. data/lib/measures/urban_geometry_creation_zoning/README.md +25 -3
  10. data/lib/measures/urban_geometry_creation_zoning/measure.xml +4 -5
  11. data/lib/urbanopt/geojson/schema/thermal_connector_properties.json +2 -2
  12. data/lib/urbanopt/geojson/version.rb +1 -1
  13. data/urbanopt-geojson-gem.gemspec +7 -4
  14. metadata +52 -10
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 598a86cd6ea379dcc630e4728a308ca6d543acaf1d06f64df8681d3aec2e8dbe
4
- data.tar.gz: 7828a7da042ee0094f7361bd3ce38c7564a4bdccc1a24a9690a720b65df2122a
3
+ metadata.gz: 0f09af43f10eb659941256761144de158f4182670fca7c5e92924d1073016d5c
4
+ data.tar.gz: 410f86f190807a5fff3bac1a29e8500601129582572eb325c03dea0e72899b7f
5
5
  SHA512:
6
- metadata.gz: f1216daf8552b6973230763fb5d8fbfb12eaa31c30143af8220fb2945d673c2e76e26075c15710b188c88fc8c7d3ecbed1206a711a9c7659c6e60d2f06682582
7
- data.tar.gz: 8ae72ca2e05eb23c3f1bf31018ba272bc2839e10290c2ea21bc44b35aacc66f98496879f93f91cc04bff7a7e22ec63b3897db194f909a6716d3a1771243acf3c
6
+ metadata.gz: 16284df9a89bf6d8b47f01df6206c7be3c883aa7b74f2a7ebb45dae7e9f025460fc26134f54047da0d18851f9ed48939230b5c4a4d92b92a36dbae782b51f117
7
+ data.tar.gz: 48368d17fbf7024df6bedc2b8ed2e0ad9ff59eee886cc49c95b2a1b233fc0927605cae6bd26a4e1123b408200b5f2692c3708cffeb392ef71e7fc7171aa7a017
data/.github/workflows/nightly_build.yml CHANGED
@@ -17,7 +17,7 @@ jobs:
17
17
  weeknight-tests:
18
18
  runs-on: ubuntu-latest
19
19
  container:
20
- image: docker://nrel/openstudio:3.9.0
20
+ image: docker://nrel/openstudio:3.10.0
21
21
  steps:
22
22
  - uses: actions/checkout@v4
23
23
  - name: set git config options
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # URBANopt GeoJSON Gem
2
2
 
3
+ ## Version 1.1.0
4
+
5
+ * Upgrade to OpenStudio 3.10
6
+
7
+ ## Version 1.0.1
8
+
9
+ ## What's Changed
10
+
11
+ * Use SI units for connector lengths by @vtnate in https://github.com/urbanopt/urbanopt-geojson-gem/pull/283
12
+
13
+ **Full Changelog**: https://github.com/urbanopt/urbanopt-geojson-gem/compare/v1.0.0...v1.0.1
14
+
3
15
  ## Version 1.0.0
4
16
 
5
17
  ## Exciting new features 🎉
data/Gemfile CHANGED
@@ -11,15 +11,14 @@ gemspec
11
11
  # checkout the latest version (develop) from github.
12
12
  allow_local = ENV['FAVOR_LOCAL_GEMS']
13
13
 
14
- # gem 'openstudio-extension', '~> 0.8.2'
15
14
  # if allow_local && File.exist?('../openstudio-extension-gem')
16
15
  # gem 'openstudio-extension', path: '../openstudio-extension-gem'
17
16
  # elsif allow_local
18
- # gem 'openstudio-extension', github: 'NREL/openstudio-extension-gem', branch: 'develop'
17
+ # gem 'openstudio-extension', github: 'NREL/openstudio-extension-gem', branch: 'develop'
19
18
  # end
20
19
 
21
20
  # if allow_local && File.exist?('../urbanopt-core-gem')
22
21
  # gem 'urbanopt-core', path: '../urbanopt-core-gem'
23
22
  # elsif allow_local
24
- # gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'master'
23
+ # gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'develop'
25
24
  # end
data/lib/measures/urban_geometry_creation/LICENSE.md CHANGED
@@ -1,4 +1,4 @@
1
- URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
1
+ URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
2
2
  contributors. All rights reserved.
3
3
 
4
4
  Redistribution and use in source and binary forms, with or without modification,
data/lib/measures/urban_geometry_creation/README.md CHANGED
@@ -2,13 +2,13 @@
2
2
 
3
3
  ###### (Automatically generated documentation)
4
4
 
5
- #
5
+ # UrbanGeometryCreation
6
6
 
7
7
  ## Description
8
-
8
+ This measure reads an URBANopt GeoJSON and creates geometry for a particular building. Surrounding buildings are included as shading structures.
9
9
 
10
10
  ## Modeler Description
11
-
11
+ This measure takes in the GeoJSON file, the feature_id of the building and the surrounding buildings as arguments and add has methods to create space types and add default construction sets.
12
12
 
13
13
  ## Measure Type
14
14
  ModelMeasure
@@ -19,8 +19,38 @@ ModelMeasure
19
19
  ## Arguments
20
20
 
21
21
 
22
+ ### GeoJSON File
23
+ GeoJSON File.
24
+ **Name:** geojson_file,
25
+ **Type:** String,
26
+ **Units:** ,
27
+ **Required:** true,
28
+ **Model Dependent:** false
29
+
30
+ ### Feature ID
31
+ Feature ID.
32
+ **Name:** feature_id,
33
+ **Type:** String,
34
+ **Units:** ,
35
+ **Required:** true,
36
+ **Model Dependent:** false
37
+
38
+ ### Surrounding Buildings
39
+ Select which surrounding buildings to include.
40
+ **Name:** surrounding_buildings,
41
+ **Type:** Choice,
42
+ **Units:** ,
43
+ **Required:** true,
44
+ **Model Dependent:** false
45
+
46
+ ### Scale Footprint Area by the Floor Area
47
+ If true, the footprint area from GeoJSON will be scaled by the floor_area provided by the user in URBANopt.
48
+ **Name:** scale_footprint_area_by_floor_area,
49
+ **Type:** Boolean,
50
+ **Units:** ,
51
+ **Required:** false,
52
+ **Model Dependent:** false
22
53
 
23
54
 
24
- This measure does not have any user arguments
25
55
 
26
56
 
data/lib/measures/urban_geometry_creation/measure.xml CHANGED
@@ -1,11 +1,10 @@
1
1
  <?xml version="1.0"?>
2
2
  <measure>
3
3
  <schema_version>3.1</schema_version>
4
- <error>Failed to infer measure name from '/Users/nmoore/github/urbanopt-geojson-gem/lib/measures/urban_geometry_creation/measure.rb'</error>
5
4
  <name>urban_geometry_creation</name>
6
5
  <uid>5ab85d6b-c9af-4361-8ab9-613ee99a5666</uid>
7
- <version_id>048231f4-ba53-4506-b922-35f13d8b806e</version_id>
8
- <version_modified>2024-11-13T17:45:33Z</version_modified>
6
+ <version_id>2c5d7aa9-2e06-43c5-bbcb-fbeb28d798cf</version_id>
7
+ <version_modified>2025-06-24T01:22:20Z</version_modified>
9
8
  <xml_checksum>D254E772</xml_checksum>
10
9
  <class_name>UrbanGeometryCreation</class_name>
11
10
  <display_name>UrbanGeometryCreation</display_name>
@@ -109,13 +108,13 @@
109
108
  <filename>LICENSE.md</filename>
110
109
  <filetype>md</filetype>
111
110
  <usage_type>license</usage_type>
112
- <checksum>3C275955</checksum>
111
+ <checksum>C901E1FD</checksum>
113
112
  </file>
114
113
  <file>
115
114
  <filename>README.md</filename>
116
115
  <filetype>md</filetype>
117
116
  <usage_type>readme</usage_type>
118
- <checksum>0B68E96D</checksum>
117
+ <checksum>AA2D38B0</checksum>
119
118
  </file>
120
119
  <file>
121
120
  <filename>README.md.erb</filename>
data/lib/measures/urban_geometry_creation_zoning/LICENSE.md CHANGED
@@ -1,4 +1,4 @@
1
- URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
1
+ URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
2
2
  contributors. All rights reserved.
3
3
 
4
4
  Redistribution and use in source and binary forms, with or without modification,
data/lib/measures/urban_geometry_creation_zoning/README.md CHANGED
@@ -2,10 +2,10 @@
2
2
 
3
3
  ###### (Automatically generated documentation)
4
4
 
5
- #
5
+ # UrbanGeometryCreationZoning
6
6
 
7
7
  ## Description
8
-
8
+ This measure reads an URBANopt GeoJSON and creates geometry with zoning for a particular building. Surrounding buildings are included as shading structures.
9
9
 
10
10
  ## Modeler Description
11
11
 
@@ -19,8 +19,30 @@ ModelMeasure
19
19
  ## Arguments
20
20
 
21
21
 
22
+ ### GeoJSON File
23
+ GeoJSON File.
24
+ **Name:** geojson_file,
25
+ **Type:** String,
26
+ **Units:** ,
27
+ **Required:** true,
28
+ **Model Dependent:** false
29
+
30
+ ### Feature ID
31
+ Feature ID.
32
+ **Name:** feature_id,
33
+ **Type:** String,
34
+ **Units:** ,
35
+ **Required:** true,
36
+ **Model Dependent:** false
37
+
38
+ ### Surrounding Buildings
39
+ Select which surrounding buildings to include.
40
+ **Name:** surrounding_buildings,
41
+ **Type:** Choice,
42
+ **Units:** ,
43
+ **Required:** true,
44
+ **Model Dependent:** false
22
45
 
23
46
 
24
- This measure does not have any user arguments
25
47
 
26
48
 
data/lib/measures/urban_geometry_creation_zoning/measure.xml CHANGED
@@ -1,11 +1,10 @@
1
1
  <?xml version="1.0"?>
2
2
  <measure>
3
3
  <schema_version>3.1</schema_version>
4
- <error>Failed to infer measure name from '/Users/nmoore/github/urbanopt-geojson-gem/lib/measures/urban_geometry_creation_zoning/measure.rb'</error>
5
4
  <name>urban_geometry_creation_zoning</name>
6
5
  <uid>96ea1317-76ac-4670-b51d-71ee3f4fdd65</uid>
7
- <version_id>f4e83153-b29e-4154-9ed0-7062896e7448</version_id>
8
- <version_modified>2024-11-14T16:53:21Z</version_modified>
6
+ <version_id>42bc662d-aaf5-4cd2-acd4-97072e1a2f21</version_id>
7
+ <version_modified>2025-06-24T01:22:20Z</version_modified>
9
8
  <xml_checksum>D254E772</xml_checksum>
10
9
  <class_name>UrbanGeometryCreationZoning</class_name>
11
10
  <display_name>UrbanGeometryCreationZoning</display_name>
@@ -90,13 +89,13 @@
90
89
  <filename>LICENSE.md</filename>
91
90
  <filetype>md</filetype>
92
91
  <usage_type>license</usage_type>
93
- <checksum>3C275955</checksum>
92
+ <checksum>C901E1FD</checksum>
94
93
  </file>
95
94
  <file>
96
95
  <filename>README.md</filename>
97
96
  <filetype>md</filetype>
98
97
  <usage_type>readme</usage_type>
99
- <checksum>0B68E96D</checksum>
98
+ <checksum>0458EE16</checksum>
100
99
  </file>
101
100
  <file>
102
101
  <filename>README.md.erb</filename>
data/lib/urbanopt/geojson/schema/thermal_connector_properties.json CHANGED
@@ -36,14 +36,14 @@
36
36
  "$ref": "#/definitions/ThermalConnectorType"
37
37
  },
38
38
  "lengths": {
39
- "description": "Length of each segment in ft, generated on export.",
39
+ "description": "Length of each segment in meters, generated on export.",
40
40
  "type": "array",
41
41
  "items": {
42
42
  "type": "number"
43
43
  }
44
44
  },
45
45
  "total_length": {
46
- "description": "Total length of the connector in ft, generated on export.",
46
+ "description": "Total length of the connector in meters, generated on export.",
47
47
  "type": "number"
48
48
  },
49
49
  "startJunctionId": {
data/lib/urbanopt/geojson/version.rb CHANGED
@@ -5,6 +5,6 @@
5
5
 
6
6
  module URBANopt
7
7
  module GeoJSON
8
- VERSION = '1.0.0'.freeze
8
+ VERSION = '1.1.0'.freeze
9
9
  end
10
10
  end
data/urbanopt-geojson-gem.gemspec CHANGED
@@ -26,10 +26,13 @@ Gem::Specification.new do |spec|
26
26
  # It would be nice to be able to use newer patches of Ruby 3.2, which would require os-extension to relax its dependency on bundler.
27
27
  spec.required_ruby_version = '3.2.2'
28
28
 
29
- spec.add_development_dependency 'rspec', '~> 3.13'
30
- spec.add_development_dependency 'simplecov', '0.22.0'
31
- spec.add_development_dependency 'simplecov-lcov', '0.8.0'
29
+ spec.add_development_dependency 'rake', '~> 13.0'
30
+ spec.add_development_dependency 'rspec', '~> 3.9'
31
+ spec.add_development_dependency 'rubocop', '~> 1.50'
32
+ spec.add_development_dependency 'rubocop-performance', '~> 1.20'
33
+ spec.add_development_dependency 'simplecov', '~> 0.22.0'
34
+ spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
32
35
 
33
36
  spec.add_runtime_dependency 'json-schema', '~> 4.3.1'
34
- spec.add_runtime_dependency 'urbanopt-core', '~> 1.0.0'
37
+ spec.add_runtime_dependency 'urbanopt-core', '~> 1.1.0'
35
38
  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: 1.0.0
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tanushree Charan
@@ -10,48 +10,90 @@ authors:
10
10
  autorequire:
11
11
  bindir: exe
12
12
  cert_chain: []
13
- date: 2025-01-22 00:00:00.000000000 Z
13
+ date: 2025-10-06 00:00:00.000000000 Z
14
14
  dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: rake
17
+ requirement: !ruby/object:Gem::Requirement
18
+ requirements:
19
+ - - "~>"
20
+ - !ruby/object:Gem::Version
21
+ version: '13.0'
22
+ type: :development
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ requirements:
26
+ - - "~>"
27
+ - !ruby/object:Gem::Version
28
+ version: '13.0'
15
29
  - !ruby/object:Gem::Dependency
16
30
  name: rspec
17
31
  requirement: !ruby/object:Gem::Requirement
18
32
  requirements:
19
33
  - - "~>"
20
34
  - !ruby/object:Gem::Version
21
- version: '3.13'
35
+ version: '3.9'
22
36
  type: :development
23
37
  prerelease: false
24
38
  version_requirements: !ruby/object:Gem::Requirement
25
39
  requirements:
26
40
  - - "~>"
27
41
  - !ruby/object:Gem::Version
28
- version: '3.13'
42
+ version: '3.9'
43
+ - !ruby/object:Gem::Dependency
44
+ name: rubocop
45
+ requirement: !ruby/object:Gem::Requirement
46
+ requirements:
47
+ - - "~>"
48
+ - !ruby/object:Gem::Version
49
+ version: '1.50'
50
+ type: :development
51
+ prerelease: false
52
+ version_requirements: !ruby/object:Gem::Requirement
53
+ requirements:
54
+ - - "~>"
55
+ - !ruby/object:Gem::Version
56
+ version: '1.50'
57
+ - !ruby/object:Gem::Dependency
58
+ name: rubocop-performance
59
+ requirement: !ruby/object:Gem::Requirement
60
+ requirements:
61
+ - - "~>"
62
+ - !ruby/object:Gem::Version
63
+ version: '1.20'
64
+ type: :development
65
+ prerelease: false
66
+ version_requirements: !ruby/object:Gem::Requirement
67
+ requirements:
68
+ - - "~>"
69
+ - !ruby/object:Gem::Version
70
+ version: '1.20'
29
71
  - !ruby/object:Gem::Dependency
30
72
  name: simplecov
31
73
  requirement: !ruby/object:Gem::Requirement
32
74
  requirements:
33
- - - '='
75
+ - - "~>"
34
76
  - !ruby/object:Gem::Version
35
77
  version: 0.22.0
36
78
  type: :development
37
79
  prerelease: false
38
80
  version_requirements: !ruby/object:Gem::Requirement
39
81
  requirements:
40
- - - '='
82
+ - - "~>"
41
83
  - !ruby/object:Gem::Version
42
84
  version: 0.22.0
43
85
  - !ruby/object:Gem::Dependency
44
86
  name: simplecov-lcov
45
87
  requirement: !ruby/object:Gem::Requirement
46
88
  requirements:
47
- - - '='
89
+ - - "~>"
48
90
  - !ruby/object:Gem::Version
49
91
  version: 0.8.0
50
92
  type: :development
51
93
  prerelease: false
52
94
  version_requirements: !ruby/object:Gem::Requirement
53
95
  requirements:
54
- - - '='
96
+ - - "~>"
55
97
  - !ruby/object:Gem::Version
56
98
  version: 0.8.0
57
99
  - !ruby/object:Gem::Dependency
@@ -74,14 +116,14 @@ dependencies:
74
116
  requirements:
75
117
  - - "~>"
76
118
  - !ruby/object:Gem::Version
77
- version: 1.0.0
119
+ version: 1.1.0
78
120
  type: :runtime
79
121
  prerelease: false
80
122
  version_requirements: !ruby/object:Gem::Requirement
81
123
  requirements:
82
124
  - - "~>"
83
125
  - !ruby/object:Gem::Version
84
- version: 1.0.0
126
+ version: 1.1.0
85
127
  description: Library and measures to translate URBANopt GeoJSON format to OpenStudio
86
128
  email:
87
129
  - tanushree.charan@nrel.gov