Merge branch 'develop'

CHANGELOG.md

@@ -1,5 +1,12 @@
 # URBANopt GeoJSON Gem
 
+## 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
 

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,

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,

lib/measures/urban_geometry_creation/measure.rb

@@ -121,7 +121,7 @@ def run(model, runner, user_arguments)
       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

lib/measures/urban_geometry_creation/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <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>114e5a3f-0e66-47f2-aa96-299f71b4ef0f</version_id>
+  <version_modified>2024-06-25T21:15:26Z</version_modified>
   <xml_checksum>D254E772</xml_checksum>
   <class_name>UrbanGeometryCreation</class_name>
   <display_name>UrbanGeometryCreation</display_name>
@@ -108,7 +108,7 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>9A4578CE</checksum>
+      <checksum>3C275955</checksum>
     </file>
     <file>
       <filename>README.md</filename>

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,

lib/measures/urban_geometry_creation_zoning/measure.rb

@@ -110,7 +110,8 @@ def run(model, runner, user_arguments)
       @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 @@ def run(model, runner, user_arguments)
         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)

lib/measures/urban_geometry_creation_zoning/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <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>8b2f1d05-725a-4f06-bcac-1fb685f12f89</version_id>
+  <version_modified>2024-06-25T21:15:28Z</version_modified>
   <xml_checksum>D254E772</xml_checksum>
   <class_name>UrbanGeometryCreationZoning</class_name>
   <display_name>UrbanGeometryCreationZoning</display_name>
@@ -89,7 +89,7 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>9A4578CE</checksum>
+      <checksum>3C275955</checksum>
     </file>
     <file>
       <filename>README.md</filename>

lib/measures/urban_geometry_creation_zoning/tests/urban_geometry_creation_zoning_test.rb

@@ -8,7 +8,7 @@
 require 'openstudio'
 require 'openstudio/ruleset/ShowRunnerOutput'
 require 'minitest/autorun'
-require_relative '../measure.rb'
+require_relative '../measure'
 require 'fileutils'
 
 class UrbanGeometryCreationZoningTest < MiniTest::Test

lib/urbanopt/geojson/building.rb

@@ -103,12 +103,13 @@ def create_building(create_method, model, origin_lat_lon, runner, zoning = false
         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 @@ def create_space_per_floor(story_number, floor_to_floor_height, model, origin_la
           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

lib/urbanopt/geojson/district_system.rb

@@ -8,10 +8,6 @@
 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

lib/urbanopt/geojson/feature.rb

@@ -19,9 +19,7 @@ def initialize(feature)
         @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 @@ def get_min_lon_lat
       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 @@ def find_feature_center(vertices)
         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 @@ def validate_feat(feature) #:doc:
         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

lib/urbanopt/geojson/geo_file.rb

@@ -47,7 +47,6 @@ def self.from_file(path)
           symbolize_names: true
         )
 
-
         # validate geojson file against schema
         geojson_errors = validate(@@geojson_schema, geojson_file)
         unless geojson_errors.empty?
@@ -83,6 +82,7 @@ def self.from_file(path)
               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 @@ def self.from_file(path)
               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 @@ def merge_site_properties(feature)
           { 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 @@ def self.get_geojson_schema(strict)
         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 @@ def self.get_geojson_schema(strict)
 
       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 @@ def self.get_building_schema(strict)
 
       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 @@ def self.get_district_system_schema(strict)
 
       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 @@ def self.get_region_schema(strict)
 
       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 @@ def self.get_site_schema(strict)
 
       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 @@ def self.get_electrical_connector_schema(strict)
 
       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 @@ def self.get_electrical_junction_schema(strict)
 
       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 @@ def self.get_thermal_connector_schema(strict)
 
       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

lib/urbanopt/geojson/helper.rb

@@ -242,6 +242,7 @@ def self.process_other_buildings(building, other_building_type, other_buildings,
         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 @@ def self.process_other_buildings(building, other_building_type, other_buildings,
               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 @@ def self.is_shadowed(potentially_shaded, potential_shader, origin_lat_lon)
         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 @@ def self.is_shaded(building_point, other_building_point, origin_lat_lon)
         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 @@ def self.is_shaded(building_point, other_building_point, origin_lat_lon)
         return result
       end
 
-            class << self
-              private :is_shaded
-            end
-          end
-        end
+      class << self
+        private :is_shaded
       end
+    end
+  end
+end

lib/urbanopt/geojson/logging.rb

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