urbanopt-geojson 0.11.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32b936011feb9dbc9da74e001526895f70fffb05430d688edb3cb69a7a3c40ad
-  data.tar.gz: b783738bf7351f774698a456e11ba9668acf6f3462e67e14acf616ab7f8c20d4
+  metadata.gz: 598a86cd6ea379dcc630e4728a308ca6d543acaf1d06f64df8681d3aec2e8dbe
+  data.tar.gz: 7828a7da042ee0094f7361bd3ce38c7564a4bdccc1a24a9690a720b65df2122a
 SHA512:
-  metadata.gz: 45b454224a0e01c3a6a43d60de95f79ceb4bf75baf132ec5d63784c8f7252c8dfc7850f39031a764b5028578cd72ec3226ab312e5636a37f701951dc44ff755b
-  data.tar.gz: 85468f42a01a44ad7b7a666c98867defbb3c095ac70bb4d1aa6a2ab7970e60c0ec70f97712135b5b025b3d195bddf47a4ef75423529523f7e4aaadddead30994
+  metadata.gz: f1216daf8552b6973230763fb5d8fbfb12eaa31c30143af8220fb2945d673c2e76e26075c15710b188c88fc8c7d3ecbed1206a711a9c7659c6e60d2f06682582
+  data.tar.gz: 8ae72ca2e05eb23c3f1bf31018ba272bc2839e10290c2ea21bc44b35aacc66f98496879f93f91cc04bff7a7e22ec63b3897db194f909a6716d3a1771243acf3c

data/.github/workflows/nightly_build.yml

@@ -1,13 +1,12 @@
 name: Geojson-gem CI
 
 on:
-  # push:
+  workflow_dispatch:
+  push:
   schedule:
     # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
     # 5 am UTC (11pm MDT the day before) every weekday night in MDT
     - cron: '21 5 * * 2-6'
-  pull_request:
-    types: [review_requested]
 
 env:
   # This env var should enforce develop branch of all dependencies
@@ -18,7 +17,7 @@ jobs:
   weeknight-tests:
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.7.0
+      image: docker://nrel/openstudio:3.9.0
     steps:
       - uses: actions/checkout@v4
       - name: set git config options
@@ -28,11 +27,14 @@ jobs:
       - name: Update gems
         run: |
           ruby --version
+          bundle install
           bundle update
       - name: List OpenStudio measures
         run: bundle exec rake openstudio:list_measures
       - name: Update OpenStudio measures
-        run: bundle exec rake openstudio:update_measures
+        run: |
+          bundle install
+          bundle exec rake openstudio:update_measures
       - name: Test OpenStudio measures
         run: bundle exec rake openstudio:test_with_openstudio
       - name: Run Rspec

data/.gitignore

@@ -5,6 +5,7 @@
 /gems
 /_yardoc/
 /coverage/
+.coverage
 /doc/
 /pkg/
 /spec/reports/

data/.rakeTasks

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Settings><!--This file was automatically generated by Ruby plugin.
-You are allowed to: 
+You are allowed to:
 1. Remove rake task
 2. Add existing rake tasks
 To add existing rake tasks automatically delete this file and reload the project.
---><RakeGroup description="" fullCmd="" taksId="rake" /></Settings>
+--><RakeGroup description="" fullCmd="" taskId="rake" /></Settings>

data/CHANGELOG.md

@@ -1,6 +1,22 @@
 # URBANopt GeoJSON Gem
 
+## Version 1.0.0
+
+## Exciting new features 🎉
+
+* Upgrade to OpenStudio 3.9 and Ruby 3.2.2 by @vtnate in https://github.com/urbanopt/urbanopt-geojson-gem/pull/279
+
+**Full Changelog**: https://github.com/urbanopt/urbanopt-geojson-gem/compare/v0.11.2...v1.0.0
+
+## Version 0.11.2
+
+* Allow null for some optional fields by @vtnate in https://github.com/urbanopt/urbanopt-geojson-gem/pull/273
+* Added UO-ResStock connection variable to the site properties schema by @rawadelkontar in https://github.com/urbanopt/urbanopt-geojson-gem/pull/270
+
+**Full Changelog**: https://github.com/urbanopt/urbanopt-geojson-gem/compare/v0.11.1...v0.11.2
+
 ## Version 0.11.1
+
 Date Range: 01/09/24
 
 * downgrade json-schema to 2.7 by @vtnate in https://github.com/urbanopt/urbanopt-geojson-gem/pull/267
@@ -8,6 +24,7 @@ Date Range: 01/09/24
 **Full Changelog**: https://github.com/urbanopt/urbanopt-geojson-gem/compare/v0.11.0...v0.11.1
 
 ## Version 0.11.0
+
 Date Range: 7/19/23 - 01/09/24
 
 * Remove jenkins by @vtnate in https://github.com/urbanopt/urbanopt-geojson-gem/pull/260

data/Gemfile

@@ -11,19 +11,15 @@ gemspec
 # checkout the latest version (develop) from github.
 allow_local = ENV['FAVOR_LOCAL_GEMS']
 
-# pin this dependency to avoid unicode_normalize error
-gem 'addressable', '2.8.1'
-# pin this dependency to avoid using racc dependency (which has native extensions)
-gem 'parser', '3.2.2.2'
-
+# gem 'openstudio-extension', '~> 0.8.2'
 # if allow_local && File.exist?('../openstudio-extension-gem')
 #   gem 'openstudio-extension', path: '../openstudio-extension-gem'
 # elsif allow_local
 #   gem 'openstudio-extension', github: 'NREL/openstudio-extension-gem', branch: 'develop'
 # end
 
-if allow_local && File.exist?('../urbanopt-core-gem')
-  gem 'urbanopt-core', path: '../urbanopt-core-gem'
-elsif allow_local
-  gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'develop'
-end
+# if allow_local && File.exist?('../urbanopt-core-gem')
+#   gem 'urbanopt-core', path: '../urbanopt-core-gem'
+# elsif allow_local
+# gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'master'
+# end

data/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2023, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/doc_templates/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/lib/measures/urban_geometry_creation/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2023, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/lib/measures/urban_geometry_creation/README.md

@@ -2,13 +2,13 @@
 
 ###### (Automatically generated documentation)
 
-# UrbanGeometryCreation
+# 
 
 ## Description
-This measure reads an URBANopt GeoJSON and creates geometry for a particular building.  Surrounding buildings are included as shading structures.
+
 
 ## Modeler Description
-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.
+
 
 ## Measure Type
 ModelMeasure
@@ -19,38 +19,8 @@ ModelMeasure
 ## Arguments
 
 
-### GeoJSON File
-GeoJSON File.
-**Name:** geojson_file,
-**Type:** String,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Feature ID
-Feature ID.
-**Name:** feature_id,
-**Type:** String,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Surrounding Buildings
-Select which surrounding buildings to include.
-**Name:** surrounding_buildings,
-**Type:** Choice,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Scale Footprint Area by the Floor Area
-If true, the footprint area from GeoJSON will be scaled by the floor_area provided by the user in URBANopt.
-**Name:** scale_footprint_area_by_floor_area,
-**Type:** Boolean,
-**Units:** ,
-**Required:** false,
-**Model Dependent:** false
 
 
+This measure does not have any user arguments
 
 

data/lib/measures/urban_geometry_creation/measure.rb

@@ -121,7 +121,7 @@ class UrbanGeometryCreation < OpenStudio::Measure::ModelMeasure
       if scale_footprint_area_by_floor_area
         building_hash = feature.to_hash
         if building_hash[:number_of_stories] && building_hash[:floor_area]
-          scaled_footprint_area = building_hash[:floor_area].to_f / building_hash[:number_of_stories].to_f
+          scaled_footprint_area = building_hash[:floor_area].to_f / building_hash[:number_of_stories]
           @runner.registerInfo("Desired footprint area in ft2: #{scaled_footprint_area}")
         end
       end

data/lib/measures/urban_geometry_creation/measure.xml

@@ -1,10 +1,11 @@
 <?xml version="1.0"?>
 <measure>
   <schema_version>3.1</schema_version>
+  <error>Failed to infer measure name from '/Users/nmoore/github/urbanopt-geojson-gem/lib/measures/urban_geometry_creation/measure.rb'</error>
   <name>urban_geometry_creation</name>
   <uid>5ab85d6b-c9af-4361-8ab9-613ee99a5666</uid>
-  <version_id>583499fb-4275-4787-9168-e3383dca0fc6</version_id>
-  <version_modified>2023-11-20T17:10:01Z</version_modified>
+  <version_id>048231f4-ba53-4506-b922-35f13d8b806e</version_id>
+  <version_modified>2024-11-13T17:45:33Z</version_modified>
   <xml_checksum>D254E772</xml_checksum>
   <class_name>UrbanGeometryCreation</class_name>
   <display_name>UrbanGeometryCreation</display_name>
@@ -108,13 +109,13 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>9A4578CE</checksum>
+      <checksum>3C275955</checksum>
     </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>AA2D38B0</checksum>
+      <checksum>0B68E96D</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -131,7 +132,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>5D490083</checksum>
+      <checksum>D58B8040</checksum>
     </file>
     <file>
       <filename>nrel_stm_footprints.geojson</filename>

data/lib/measures/urban_geometry_creation_zoning/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2023, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/lib/measures/urban_geometry_creation_zoning/README.md

@@ -2,10 +2,10 @@
 
 ###### (Automatically generated documentation)
 
-# UrbanGeometryCreationZoning
+# 
 
 ## Description
-This measure reads an URBANopt GeoJSON and creates geometry with zoning for a particular building.  Surrounding buildings are included as shading structures.
+
 
 ## Modeler Description
 
@@ -19,30 +19,8 @@ ModelMeasure
 ## Arguments
 
 
-### GeoJSON File
-GeoJSON File.
-**Name:** geojson_file,
-**Type:** String,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Feature ID
-Feature ID.
-**Name:** feature_id,
-**Type:** String,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Surrounding Buildings
-Select which surrounding buildings to include.
-**Name:** surrounding_buildings,
-**Type:** Choice,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
 
 
+This measure does not have any user arguments
 
 

data/lib/measures/urban_geometry_creation_zoning/measure.rb

@@ -110,7 +110,8 @@ class UrbanGeometryCreationZoning < OpenStudio::Measure::ModelMeasure
       @runner.registerWarning("Surface elevation not set for building '#{name}'")
     end
 
-    if feature.type == 'Building'
+    case feature.type
+    when 'Building'
       # make requested building, zoning is set to true
       spaces = feature.create_building(:spaces_per_floor, model, @origin_lat_lon, @runner, true)
       if spaces.nil? || spaces.empty?
@@ -157,7 +158,7 @@ class UrbanGeometryCreationZoning < OpenStudio::Measure::ModelMeasure
         URBANopt::GeoJSON::Helper.convert_to_shading_surface_group(space)
       end
 
-    elsif feature.type == 'District System'
+    when 'District System'
       district_system_type = feature[:properties][:district_system_type]
       if district_system_type == 'Community Photovoltaic'
         shading_surfaces = URBANopt::GeoJSON::Helper.create_photovoltaics(feature, 0, model, @origin_lat_lon, @runner)

data/lib/measures/urban_geometry_creation_zoning/measure.xml

@@ -1,10 +1,11 @@
 <?xml version="1.0"?>
 <measure>
   <schema_version>3.1</schema_version>
+  <error>Failed to infer measure name from '/Users/nmoore/github/urbanopt-geojson-gem/lib/measures/urban_geometry_creation_zoning/measure.rb'</error>
   <name>urban_geometry_creation_zoning</name>
   <uid>96ea1317-76ac-4670-b51d-71ee3f4fdd65</uid>
-  <version_id>4d47bb3f-6e49-4309-a4e0-5f2c3748b947</version_id>
-  <version_modified>2023-11-20T17:10:01Z</version_modified>
+  <version_id>f4e83153-b29e-4154-9ed0-7062896e7448</version_id>
+  <version_modified>2024-11-14T16:53:21Z</version_modified>
   <xml_checksum>D254E772</xml_checksum>
   <class_name>UrbanGeometryCreationZoning</class_name>
   <display_name>UrbanGeometryCreationZoning</display_name>
@@ -89,13 +90,13 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>9A4578CE</checksum>
+      <checksum>3C275955</checksum>
     </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>0458EE16</checksum>
+      <checksum>0B68E96D</checksum>
     </file>
     <file>
       <filename>README.md.erb</filename>
@@ -112,7 +113,7 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>5827BCFA</checksum>
+      <checksum>1EA1A74B</checksum>
     </file>
     <file>
       <filename>OV_Buildings_Update_090420_res_eui_test.json</filename>
@@ -136,7 +137,7 @@
       <filename>urban_geometry_creation_zoning_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>FC65E7CE</checksum>
+      <checksum>3B495B27</checksum>
     </file>
   </files>
 </measure>

data/lib/urbanopt/geojson/building.rb

@@ -103,12 +103,13 @@ module URBANopt
         end
 
         spaces = []
-        if create_method == :space_per_floor || create_method == :spaces_per_floor
+        case create_method
+        when :space_per_floor, :spaces_per_floor
           (-number_of_stories_below_ground + 1..number_of_stories_above_ground).each do |story_number|
             new_spaces = create_space_per_floor(story_number, floor_to_floor_height, model, origin_lat_lon, runner, zoning, scaled_footprint_area)
             spaces.concat(new_spaces)
           end
-        elsif create_method == :space_per_building
+        when :space_per_building
           spaces = create_space_per_building(-number_of_stories_below_ground * floor_to_floor_height, number_of_stories_above_ground * floor_to_floor_height, model, origin_lat_lon, runner, zoning, other_building)
         end
         return spaces
@@ -417,10 +418,8 @@ module URBANopt
           space = space.get
           space.setName("Building Story #{story_number} Space")
           space.surfaces.each do |surface|
-            if surface.surfaceType == 'Wall'
-              if story_number < 1
-                surface.setOutsideBoundaryCondition('Ground')
-              end
+            if surface.surfaceType == 'Wall' && (story_number < 1)
+              surface.setOutsideBoundaryCondition('Ground')
             end
           end
           spaces << space

data/lib/urbanopt/geojson/district_system.rb

@@ -8,10 +8,6 @@ require 'urbanopt/geojson/feature'
 module URBANopt
   module GeoJSON # :nodoc: all
     class DistrictSystem < Feature
-      def initialize(feature)
-        super(feature)
-      end
-
       ##
       # Used to describe the feature type using the base method from the Feature class.
       def feature_type

data/lib/urbanopt/geojson/feature.rb

@@ -19,9 +19,7 @@ module URBANopt
         @feature_json = validate_feat(feature)
       end
 
-      # rubocop:disable Style/MethodMissing
       def method_missing(name, *args, &blk)
-        # rubocop:enable Style/MethodMissing
         if @feature_json[:properties].keys.map(&:to_sym).include? name.to_sym
 
           return @feature_json[:properties][name.to_sym]
@@ -196,10 +194,11 @@ module URBANopt
       def get_multi_polygons(json = @feature_json)
         geometry_type = json[:geometry][:type]
         multi_polygons = []
-        if geometry_type == 'Polygon'
+        case geometry_type
+        when 'Polygon'
           polygons = json[:geometry][:coordinates]
           multi_polygons = [polygons]
-        elsif geometry_type == 'MultiPolygon'
+        when 'MultiPolygon'
           multi_polygons = json[:geometry][:coordinates]
         end
         return multi_polygons
@@ -256,8 +255,7 @@ module URBANopt
         central_latitude = Math.atan2(z, central_square_root)
 
         [central_longitude * 180 / Math::PI,
-          central_latitude * 180 / Math::PI]
-
+         central_latitude * 180 / Math::PI]
       end
 
       private
@@ -292,8 +290,9 @@ module URBANopt
         end
 
         geometry_type = feature[:geometry][:type]
-        if geometry_type == 'Polygon'
-        elsif geometry_type == 'MultiPolygon'
+        case geometry_type
+        when 'Polygon'
+        when 'MultiPolygon'
         else
           raise("Unknown geometry type '#{geometry_type}'")
           return false

data/lib/urbanopt/geojson/geo_file.rb

@@ -47,7 +47,6 @@ module URBANopt
           symbolize_names: true
         )
 
-
         # validate geojson file against schema
         geojson_errors = validate(@@geojson_schema, geojson_file)
         unless geojson_errors.empty?
@@ -83,6 +82,7 @@ module URBANopt
               if feature[:properties][:name].nil?
                 raise('No name found for Building Feature')
               end
+
               if feature[:properties][:number_of_stories].nil?
                 @@logger.warn("Number of stories is required to calculate shading using the UrbanGeometryCreation measure.\n" \
                   "Not validating #{feature[:properties][:id]} against schema and ignoring in shading calculations")
@@ -96,6 +96,7 @@ module URBANopt
               if feature[:properties][:name].nil?
                 raise('No name found for Building Feature')
               end
+
               @@logger.warn("OS-HPXML files may not conform to schema, which is usually ok.\n" \
                 "Not validating #{feature[:properties][:id]} against schema")
             # Else validate for all required properties in the schema
@@ -196,16 +197,17 @@ module URBANopt
           { site: :electricity_emissions_annual_historical_subregion, feature: :electricity_emissions_annual_historical_subregion },
           { site: :electricity_emissions_future_year, feature: :electricity_emissions_future_year },
           { site: :electricity_emissions_hourly_historical_year, feature: :electricity_emissions_hourly_historical_year },
-          { site: :electricity_emissions_annual_historical_year, feature: :electricity_emissions_annual_historical_year }
+          { site: :electricity_emissions_annual_historical_year, feature: :electricity_emissions_annual_historical_year },
+          { site: :characterize_residential_buildings_from_buildstock_csv, feature: :characterize_residential_buildings_from_buildstock_csv },
+          { site: :resstock_buildstock_csv_path, feature: :resstock_buildstock_csv_path },
+          { site: :uo_buildstock_mapping_csv_path, feature: :uo_buildstock_mapping_csv_path }
         ]
 
         add_props.each do |prop|
-          if project.key?(prop[:site]) && project[prop[:site]]
-            # property exists in site
-            if !feature[:properties].key?(prop[:feature]) || feature[:properties][prop[:feature]].nil? || feature[:properties][prop[:feature]].to_s.empty?
-              # property does not exist in feature or is nil: add site property (don't overwrite)
-              feature[:properties][prop[:feature]] = project[prop[:site]]
-            end
+          # property exists in site
+          if project.key?(prop[:site]) && project[prop[:site]] && (!feature[:properties].key?(prop[:feature]) || feature[:properties][prop[:feature]].nil? || feature[:properties][prop[:feature]].to_s.empty?)
+            # property does not exist in feature or is nil: add site property (don't overwrite)
+            feature[:properties][prop[:feature]] = project[prop[:site]]
           end
         end
 
@@ -226,7 +228,7 @@ module URBANopt
         result = nil
         if @@geojson_schema.nil?
           @@schema_file_lock.synchronize do
-            File.open(File.dirname(__FILE__) + '/schema/geojson_schema.json') do |f|
+            File.open("#{File.dirname(__FILE__)}/schema/geojson_schema.json") do |f|
               result = JSON.parse(f.read, symbolize_names: true)
             end
           end
@@ -236,7 +238,7 @@ module URBANopt
 
       def self.get_building_schema(strict)
         result = nil
-        File.open(File.dirname(__FILE__) + '/schema/building_properties.json') do |f|
+        File.open("#{File.dirname(__FILE__)}/schema/building_properties.json") do |f|
           result = JSON.parse(f.read)
         end
         if strict
@@ -249,7 +251,7 @@ module URBANopt
 
       def self.get_district_system_schema(strict)
         result = nil
-        File.open(File.dirname(__FILE__) + '/schema/district_system_properties.json') do |f|
+        File.open("#{File.dirname(__FILE__)}/schema/district_system_properties.json") do |f|
           result = JSON.parse(f.read)
         end
         if strict
@@ -262,7 +264,7 @@ module URBANopt
 
       def self.get_region_schema(strict)
         result = nil
-        File.open(File.dirname(__FILE__) + '/schema/region_properties.json') do |f|
+        File.open("#{File.dirname(__FILE__)}/schema/region_properties.json") do |f|
           result = JSON.parse(f.read)
         end
         if strict
@@ -275,7 +277,7 @@ module URBANopt
 
       def self.get_site_schema(strict)
         result = nil
-        File.open(File.dirname(__FILE__) + '/schema/site_properties.json') do |f|
+        File.open("#{File.dirname(__FILE__)}/schema/site_properties.json") do |f|
           result = JSON.parse(f.read)
         end
         if strict
@@ -288,7 +290,7 @@ module URBANopt
 
       def self.get_electrical_connector_schema(strict)
         result = nil
-        File.open(File.dirname(__FILE__) + '/schema/electrical_connector_properties.json') do |f|
+        File.open("#{File.dirname(__FILE__)}/schema/electrical_connector_properties.json") do |f|
           result = JSON.parse(f.read)
         end
         if strict
@@ -301,7 +303,7 @@ module URBANopt
 
       def self.get_electrical_junction_schema(strict)
         result = nil
-        File.open(File.dirname(__FILE__) + '/schema/electrical_junction_properties.json') do |f|
+        File.open("#{File.dirname(__FILE__)}/schema/electrical_junction_properties.json") do |f|
           result = JSON.parse(f.read)
         end
         if strict
@@ -314,7 +316,7 @@ module URBANopt
 
       def self.get_thermal_connector_schema(strict)
         result = nil
-        File.open(File.dirname(__FILE__) + '/schema/thermal_connector_properties.json') do |f|
+        File.open("#{File.dirname(__FILE__)}/schema/thermal_connector_properties.json") do |f|
           result = JSON.parse(f.read)
         end
         if strict
@@ -327,7 +329,7 @@ module URBANopt
 
       def self.get_thermal_junction_schema(strict)
         result = nil
-        File.open(File.dirname(__FILE__) + '/schema/thermal_junction_properties.json') do |f|
+        File.open("#{File.dirname(__FILE__)}/schema/thermal_junction_properties.json") do |f|
           result = JSON.parse(f.read)
         end
         if strict

data/lib/urbanopt/geojson/helper.rb

@@ -242,6 +242,7 @@ module URBANopt
         other_buildings[:features].each do |other_building|
           other_id = other_building[:properties][:id]
           next if other_id == building.id
+
           # Consider building, if other building type is ShadingOnly and other id is not equal to building id
           if other_building_type == 'ShadingOnly' && other_id != building.id
             # Checks if any building point is shaded by any other building point.
@@ -277,6 +278,7 @@ module URBANopt
               runner.registerInfo("Feature #{other_building[:properties][:id]} is acting as shading object for #{building.id}")
             end
             next unless shadowed
+
             new_building = building.create_other_building(:space_per_building, model, origin_lat_lon, runner, zoning, 0, other_building)
             if new_building.nil? || new_building.empty?
               runner.registerWarning("Failed to create spaces for other building '#{name}'")
@@ -321,6 +323,7 @@ module URBANopt
         if is_shaded(min_pair[:building_point], min_pair[:other_building_point], origin_lat_lon)
           return true
         end
+
         return false
       end
 
@@ -339,7 +342,8 @@ module URBANopt
         if distance < 1
           return true
         end
-        elevation_angle = 2.5 #not sure of best value maybe allow as project level argument
+
+        elevation_angle = 2.5 # not sure of best value maybe allow as project level argument
         height = vector.z
         apparent_angle_rad = Math.atan2(height, distance)
         apparent_angle = OpenStudio.radToDeg(apparent_angle_rad)
@@ -351,9 +355,9 @@ module URBANopt
         return result
       end
 
-            class << self
-              private :is_shaded
-            end
-          end
-        end
+      class << self
+        private :is_shaded
       end
+    end
+  end
+end

data/lib/urbanopt/geojson/logging.rb

@@ -7,7 +7,7 @@ require 'logger'
 
 module URBANopt
   module GeoJSON
-    @@logger = Logger.new(STDERR)
+    @@logger = Logger.new($stderr)
     @@logger.progname = 'URBANopt::GeoJSON'
 
     def self.logger

data/lib/urbanopt/geojson/mapper_classes.rb

@@ -46,15 +46,16 @@ module URBANopt
           feature_file = scenario.feature_file
           feature = feature_file.get_feature_by_id(feature_id)
           raise "Cannot find feature '#{feature_id}' in '#{scenario.geometry_file}'" if feature.nil?
+
           # deep clone of @@osw before we configure it #:nodoc:
           osw = Marshal.load(Marshal.dump(@@osw))
           osw[:name] = feature_name
           osw[:description] = feature_name
-          end
+        end
         # rubocop:disable Lint/ReturnInVoidContext
         return osw
-       # rubocop:enable Lint/ReturnInVoidContext
-     end
+        # rubocop:enable Lint/ReturnInVoidContext
+      end
     end
   end
 end

data/lib/urbanopt/geojson/model.rb

@@ -75,6 +75,7 @@ module URBANopt
         stories.each_index do |i|
           space_type = space_types[i]
           next if space_type.nil?
+
           stories[i].spaces.each do |space|
             space.setSpaceType(space_type)
           end

data/lib/urbanopt/geojson/region.rb

@@ -10,9 +10,6 @@ module URBANopt
     class Region < Feature
       ##
       # Used to initialize the feature. This method is inherited from the Feature class.
-      def initialize(feature)
-        super(feature)
-      end
 
       ##
       # Used to describe the Region feature type using the base method from the Feature class.

data/lib/urbanopt/geojson/scale_area.rb

@@ -30,6 +30,7 @@ module URBANopt
         @vertices = vertices
         @centroid = OpenStudio.getCentroid(vertices)
         raise "Cannot compute centroid for '#{vertices}'" if @centroid.empty?
+
         @centroid = @centroid.get
         @desired_area = desired_area
         @new_vertices = vertices
@@ -41,15 +42,7 @@ module URBANopt
         @eps  = eps
       end
 
-      attr_reader :zero
-
-      attr_reader :one
-
-      attr_reader :two
-
-      attr_reader :ten
-
-      attr_reader :eps
+      attr_reader :zero, :one, :two, :ten, :eps, :new_vertices
 
       ##
       # Used to determine new scaled vertices, by iteratively passing in the perimeter distance to
@@ -59,12 +52,11 @@ module URBANopt
         @new_vertices = URBANopt::GeoJSON::Zoning.divide_floor_print(@vertices, x[0].to_f, @runner, scale = true)
         new_area = OpenStudio.getArea(@new_vertices)
         raise "Cannot compute area for '#{@new_vertices}'" if new_area.empty?
+
         new_area = new_area.get
 
         return [new_area - @desired_area]
       end
-
-      attr_reader :new_vertices
-    end # ScaleArea
-  end # GeoJSON
-end # URBANopt
+    end
+  end
+end

data/lib/urbanopt/geojson/schema/building_properties.json

@@ -283,6 +283,18 @@
 		"ev_curtailment_frac": {
 			"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",
 			"type": "number"
+		},
+		"characterize_residential_buildings_from_buildstock_csv":{
+		"description" : "Enable UO and ResStock connection to characterize residential buildings by matching them (and their properties) with building from the BuildStock CSV. Optional for residential buildings.",
+		"type": "boolean"
+		},
+		"resstock_buildstock_csv_path":{
+		"description" : "Path to the buildstock CSV that the users want to sample from to find the closest match to their UO residential buildings features. Optional for residential buildings.",
+		"type": "string"
+		},
+		"uo_buildstock_mapping_csv_path":{
+			"description" : "Path to the uo_buildstock mapping CSV. IN this CSV users can set a match of the UO features with a buildstock building and its characteristics and the feature will run with the assigned buildstock characteristics. Optional for residential buildings.",
+			"type": "string"
 		}
 	},
 	"required": [
@@ -515,4 +527,4 @@
 			]
 		}
 	}
-}
+}

data/lib/urbanopt/geojson/schema/site_properties.json

@@ -77,15 +77,15 @@
 		},
 		"underground_cables_ratio": {
 			"description": "Ratio of overall cables that are underground vs. overhead for RNM analysis.",
-			"type": "number"
+			"type": ["number", "null"]
 		},
 		"only_lv_consumers": {
 			"description": "If true, only low voltage consumers will be considered in the RNM analysis.",
-			"type": "boolean"
+			"type": ["boolean", "null"]
 		},
 		"max_number_of_lv_nodes_per_building": {
 			"description": "Maximum number of low voltage nodes to represent a single building.",
-			"type": "number"
+			"type": ["number", "null"]
 		},
 		"emissions": {
 			"description": "Should be set to true to calculate electricity emissions for the associated building.",
@@ -211,9 +211,21 @@
 				"2018",
 				"2019"
 			]
+		},
+		"characterize_residential_buildings_from_buildstock_csv":{
+		"description" : "Enable UO and ResStock connection to characterize residential buildings by matching them (and their properties) with building from the BuildStock CSV.",
+		"type": "boolean"
+		},
+		"resstock_buildstock_csv_path":{
+		"description" : "Path to the buildstock CSV that the users want to sample from to find the closest match to their UO residential buildings features.",
+		"type": "string"
+		},
+		"uo_buildstock_mapping_csv_path":{
+		"description" : "Path to the uo_buildstock mapping CSV. IN this CSV users can set a match of the UO features with a buildstock building and its characteristics and the feature will run with the assigned buildstock characteristics",
+		"type": "string"
 		}
 	},
 	"required": [
 	],
 	"additionalProperties": false
-}
+}

data/lib/urbanopt/geojson/schema/thermal_junction_properties.json

@@ -47,10 +47,6 @@
       "description": "Presence of pump: true if present, false if absent",
       "type": "boolean"
     },
-    "is_ghe_start_loop": {
-      "description": "Determines whether this junction is present at the start of the loop for a Ground Heat Exchanger Network.",
-      "type": "boolean"
-    },
     "connection_type": {
       "description": "Characterize the connection as series or parallel",
       "$ref": "#/definitions/ThermalJunctionConnectionType"

data/lib/urbanopt/geojson/update_areas.rb

@@ -25,10 +25,11 @@ geojson[:features].each do |feature|
   # end
 
   multi_polygons = nil
-  if geometry[:type] == 'Polygon'
+  case geometry[:type]
+  when 'Polygon'
     polygons = geometry[:coordinates]
     multi_polygons = [polygons]
-  elsif geometry[:type] == 'MultiPolygon'
+  when 'MultiPolygon'
     multi_polygons = geometry[:coordinates]
   end
 

data/lib/urbanopt/geojson/validate_geojson.rb

@@ -8,7 +8,7 @@ require 'json-schema'
 
 def get_building_schema(strict)
   result = nil
-  File.open(File.dirname(__FILE__) + '/../schema/building_properties.json') do |f|
+  File.open("#{File.dirname(__FILE__)}/../schema/building_properties.json") do |f|
     result = JSON.parse(f.read)
   end
   if strict
@@ -21,7 +21,7 @@ end
 
 def get_taxlot_schema(strict)
   result = nil
-  File.open(File.dirname(__FILE__) + '/../schema/taxlot_properties.json') do |f|
+  File.open("#{File.dirname(__FILE__)}/../schema/taxlot_properties.json") do |f|
     result = JSON.parse(f.read)
   end
   if strict
@@ -34,7 +34,7 @@ end
 
 def get_district_system_schema(strict)
   result = nil
-  File.open(File.dirname(__FILE__) + '/../schema/district_system_properties.json') do |f|
+  File.open("#{File.dirname(__FILE__)}/../schema/district_system_properties.json") do |f|
     result = JSON.parse(f.read)
   end
   if strict
@@ -47,7 +47,7 @@ end
 
 def get_region_schema(strict)
   result = nil
-  File.open(File.dirname(__FILE__) + '/../schema/region_properties.json') do |f|
+  File.open("#{File.dirname(__FILE__)}/../schema/region_properties.json") do |f|
     result = JSON.parse(f.read)
   end
   if strict
@@ -95,13 +95,14 @@ Dir.glob('denver_district*.geojson').each do |p|
       type = data['type']
       errors = []
 
-      if /building/i.match(type)
+      case type
+      when /building/i
         errors = validate(building_schema, data)
-      elsif /district system/i.match(type)
+      when /district system/i
         errors = validate(district_system_schema, data)
-      elsif /taxlot/i.match(type)
+      when /taxlot/i
         errors = validate(taxlot_schema, data)
-      elsif /region/i.match(type)
+      when /region/i
         errors = validate(region_schema, data)
       else
         raise("Unknown type: '#{type}'")

data/lib/urbanopt/geojson/version.rb

@@ -5,6 +5,6 @@
 
 module URBANopt
   module GeoJSON
-    VERSION = '0.11.1'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/lib/urbanopt/geojson/zoning.rb

@@ -28,11 +28,12 @@ module URBANopt
           vertex_1 = nil
           vertex_2 = nil
           vertex_3 = nil
-          if i == 0
+          case i
+          when 0
             vertex_1 = vertices[n - 1]
             vertex_2 = vertices[i]
             vertex_3 = vertices[i + 1]
-          elsif i == (n - 1)
+          when n - 1
             vertex_1 = vertices[i - 1]
             vertex_2 = vertices[i]
             vertex_3 = vertices[0]

data/urbanopt-geojson-gem.gemspec

@@ -22,14 +22,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '~> 2.7.0'
+  # We support exactly Ruby v3.2.2 because os-extension requires bundler==2.4.10 and that requires Ruby 3.2.2: https://stdgems.org/bundler/
+  # 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.
+  spec.required_ruby_version = '3.2.2'
 
-  spec.add_development_dependency 'bundler', '>= 2.1.0'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'simplecov', '~> 0.18.2'
-  spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'simplecov', '0.22.0'
+  spec.add_development_dependency 'simplecov-lcov', '0.8.0'
 
-  spec.add_runtime_dependency 'json-schema', '~> 2.7'
-  spec.add_runtime_dependency 'urbanopt-core', '~> 0.11.0'
+  spec.add_runtime_dependency 'json-schema', '~> 4.3.1'
+  spec.add_runtime_dependency 'urbanopt-core', '~> 1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-geojson
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Tanushree Charan
@@ -10,76 +10,48 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2025-01-22 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
@@ -88,28 +60,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 4.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 4.3.1
 - !ruby/object:Gem::Dependency
   name: urbanopt-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 1.0.0
 description: Library and measures to translate URBANopt GeoJSON format to OpenStudio
 email:
 - tanushree.charan@nrel.gov
@@ -233,16 +205,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - '='
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Translate URBANopt GeoJSON format to OpenStudio