urbanopt-geojson 0.1.0 → 0.2.0.pre1

data/lib/urbanopt/geojson/district_system.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, 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/urbanopt/geojson/extension.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, 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/urbanopt/geojson/feature.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -177,19 +177,21 @@ module URBANopt
         end
 
         if feature[:geometry].nil?
-          raise("No geometry found in '#{feature}'")
+          raise("No geometry found in '#{feature[:properties][:name]}'")
           return false
         end
 
         if feature[:properties].nil?
-          raise("No properties found in '#{feature}'")
+          raise("No properties found in '#{feature[:properties][:name]}'")
           return false
         end
 
-        errors = JSON::Validator.fully_validate(schema, feature[:properties])
-        if !errors.empty?
-          raise("Invalid properties for '#{feature}'\n  #{errors.join('\n  ')}")
-          return false
+        unless feature[:properties][:detailed_model_filename]
+          errors = JSON::Validator.fully_validate(schema, feature[:properties])
+          if !errors.empty?
+            raise("Invalid properties for '#{feature[:properties][:name]}'\n  #{errors.join('\n  ')}")
+            return false
+          end
         end
 
         geometry_type = feature[:geometry][:type]

data/lib/urbanopt/geojson/files/electrical_database.json

@@ -0,0 +1,28 @@
+{
+    "transformer_properties": {
+        "nameclass": "Transformer--25KVA CT",
+        "kva": 25,
+        "resistance": 0.1,
+        "phases": ["A"],
+        "high_voltage": 13.2,
+        "low_voltage": 0.24,
+        "is_center_tap": true,
+        "connection": "Delta-Wye"
+    },
+    "capacitor_properties": {
+        "nameclass": "Capacitor--150KVAR",
+        "kvar": 150,
+        "resistance": 0.1,
+        "phases": ["A","B","C"],
+        "control_type": "Voltage",
+        "connection": "Delta-Wye"
+    },
+    "wire": {
+        "nameclass": "OH AL 4/0",
+        "phase": "A",
+        "height": 50,
+        "x": 0,
+        "amapcity": 200
+    }
+
+}

data/lib/urbanopt/geojson/geo_file.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -42,17 +42,15 @@ module URBANopt
       @@schema_file_lock = Mutex.new
 
       ##
-      # Raises an error in case the GeoJSON file is not valid.
+      # Initialize GeoJSON file and path.
       #
       # [Parameters]
       #
-      # * +data+ - _Type:Hash_ Contains the GeoJSON.
-      def initialize(data, path = nil)
+      # * +path+ - _Type:String_ GeoJSON File path.
+      # * +data+ - _Type:Hash_ Contains the GeoJSON File.
+      def initialize(geojson_file, path = nil)
         @path = path
-        @geojson = data
-        if !valid?
-          raise 'GeoJSON file does not adhere to schema'
-        end
+        @geojson_file = geojson_file
       end
 
       ##
@@ -69,15 +67,69 @@ module URBANopt
           raise "GeoJSON file '#{path}' does not exist"
         end
 
-        geojson = JSON.parse(
+        geojson_file = JSON.parse(
           File.open(path, 'r', &:read),
           symbolize_names: true
         )
-        return new(geojson, path)
+
+        # validate geojson file against schema
+        geojson_errors = validate(@@geojson_schema, geojson_file)
+        unless geojson_errors.empty?
+          raise "GeoJSON file does not adhere to the schema: \n #{geojson_errors.join('\n  ')}"
+        end
+
+        # initialize @@logger
+        @@logger ||= URBANopt::GeoJSON.logger
+        
+        # validate each feature against schema
+        geojson_file[:features].each do |feature|
+          properties = feature[:properties]
+          type = properties[:type]
+
+          errors = []
+
+          case type
+          when 'Building'
+            # Incase detailed_model_filename present check for fewer properties
+            if feature[:properties][:detailed_model_filename]
+              if feature[:properties][:id].nil?
+                raise("No id found for Building Feature")
+              end
+              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...ignoring #{feature[:properties][:id]} in shading calculations")
+              end
+              feature[:additionalProperties] = true
+            # Else validate for all required properties in the schema 
+            else
+              errors = validate(@@building_schema, properties)
+            end
+          when 'District System'
+            errors = validate(@@district_system_schema, properties)
+          when 'Region'
+            error = validate(@@district_system_schema, properties)
+          when 'ElectricalJunction'
+            errors = validate(@@electrical_junction_schema, properties)
+          when 'ElectricalConnector'
+            errors = validate(@@electrical_connector_schema, properties)
+          when 'ElectricalJunction'
+            errors = validate(@@thermal_junction_schema, properties)
+          when 'ThermalConnector'
+            errors = validate(@@thermal_connector_schema, properties)
+          end
+          
+          unless errors.empty?
+            raise ("#{type} does not adhere to schema: \n #{errors.join('\n  ')}")
+          end
+        
+        end
+        return new(geojson_file, path)
       end
 
       def json
-        @geojson
+        @geojson_file
       end
 
       attr_reader :path
@@ -88,7 +140,7 @@ module URBANopt
       #
       def features
         result = []
-        @geojson[:features].each do |f|
+        @geojson_file[:features].each do |f|
           if f[:properties] && f[:properties][:type] == 'Building'
             result << URBANopt::GeoJSON::Building.new(f)
           elsif f[:properties] && f[:properties][:type] == 'District System'
@@ -101,13 +153,15 @@ module URBANopt
       ##
       # Returns feature object by feature_id from specified GeoJSON file and creates a
       # new +URBANopt::GeoJSON::Building+ or +URBANopt::GeoJSON::DistrictSystem+ based on the
-      # feature type.
+      # feature type.  Before returning the feature, merge 'Site Origin' properties into the feature
       #
       # [Parameters]
       # * +feature_id+ - _Type:String/Number_ - Id affiliated with feature object.
       def get_feature_by_id(feature_id)
-        @geojson[:features].each do |f|
+        @geojson_file[:features].each do |f|
           if f[:properties] && f[:properties][:id] == feature_id
+            # merge site origin properties
+            f = merge_site_properties(f)
             if f[:properties][:type] == 'Building'
               return URBANopt::GeoJSON::Building.new(f)
             elsif f[:properties] && f[:properties][:type] == 'District System'
@@ -118,37 +172,165 @@ module URBANopt
         return nil
       end
 
-      ##
-      # Returns the file path for the +geojson_schema.json+ .
-      def schema_file
-        return File.join(File.dirname(__FILE__), 'schema', 'geojson_schema.json')
+      ## 
+      # Merge Site Properties in Feature.  Returns feature with site properties added to its properties section. Does not overwrite existing properties.
+      # 
+      # [Parameters]
+      # +feature+ - _Type:Hash_ - feature object.
+      def merge_site_properties(feature)
+        site_origins = @geojson_file[:features].select {|f| f[:properties][:type] == 'Site Origin'}
+        if site_origins.size > 0
+          site_origin = site_origins[0]
+          # site origin found, do some merging
+          # this maps site properties to building/district system properties. 
+          add_props = [
+            {site: :surface_elevation, feature: :surface_elevation}, 
+            {site: :timesteps_per_hour, feature: :timesteps_per_hour},
+            {site: :begin_date, feature: :begin_date},
+            {site: :end_date, feature: :end_date},
+            {site: :cec_climate_zone, feature: :cec_climate_zone},
+            {site: :climate_zone, feature: :climate_zone},
+            {site: :default_template, feature: :template},
+            {site: :weather_filename, feature: :weather_filename},
+            {site: :tariff_filename, feature: :tariff_filename}
+          ]
+
+          add_props.each do |prop|
+            if site_origin[:properties].key?(prop[:site]) and site_origin[:properties][prop[:site]]
+              # property exists in site
+              if !feature[:properties].key?(prop[:feature]) or feature[:properties][prop[:feature]].nil? or feature[:properties][prop[:feature]].empty?
+                # property does not exist in feature or is nil: add site property (don't overwrite)
+                feature[:properties][prop[:feature]] = site_origin[:properties][prop[:site]]
+              end
+            end
+          end
+        end
+        return feature
       end
 
       ##
-      # Returns the +geojson_schema+ .
-      def schema
+      # Validate GeoJSON against schema
+      #
+      # [Parameters]
+      # * +data+ - + - _Type:Hash_ - Input GeoJSON file 
+      def self.validate(schema_json, data)
+        errors = JSON::Validator.fully_validate(schema_json, data, errors_as_objects: true)
+        return errors
+      end
+
+      def self.get_geojson_schema(strict)
+        result = nil
         if @@geojson_schema.nil?
           @@schema_file_lock.synchronize do
-            File.open(schema_file, 'r') do |file|
-              @@geojson_schema = JSON.parse(file.read, symbolize_names: true)
+            File.open(File.dirname(__FILE__) + '/schema/geojson_schema.json') do |f|
+              result = JSON.parse(f.read, symbolize_names: true)
             end
           end
         end
+        return result
+      end
 
-        return @@geojson_schema
+      def self.get_building_schema(strict)
+        result = nil
+        File.open(File.dirname(__FILE__) + '/schema/building_properties.json') do |f|
+          result = JSON.parse(f.read)
+        end
+        if strict
+          result['additionalProperties'] = true
+        else
+          result['additionalProperties'] = false
+        end
+        return result
+      end
+      
+      def self.get_district_system_schema(strict)
+        result = nil
+        File.open(File.dirname(__FILE__) + '/schema/district_system_properties.json') do |f|
+          result = JSON.parse(f.read)
+        end
+        if strict
+          result['additionalProperties'] = true
+        else
+          result['additionalProperties'] = false
+        end
+        return result
+      end
+      
+      def self.get_region_schema(strict)
+        result = nil
+        File.open(File.dirname(__FILE__) + '/schema/region_properties.json') do |f|
+          result = JSON.parse(f.read)
+        end
+        if strict
+          result['additionalProperties'] = true
+        else
+          result['additionalProperties'] = false
+        end
+        return result
       end
 
-      ##
-      # Validates the GeoJSON file against the schema.
-      def valid?
-        return JSON::Validator.validate(schema, @geojson)
+      def self.get_electrical_connector_schema(strict)
+        result = nil
+        File.open(File.dirname(__FILE__) + '/schema/electrical_connector_properties.json') do |f|
+          result = JSON.parse(f.read)
+        end
+        if strict
+          result['additionalProperties'] = true
+        else
+          result['additionalProperties'] = false
+        end
+        return result
       end
 
-      ##
-      # Returns detailed validation results.
-      def validation_errors
-        return JSON::Validator.fully_validate(schema, @geojson)
+      def self.get_electrical_junction_schema(strict)
+        result = nil
+        File.open(File.dirname(__FILE__) + '/schema/electrical_junction_properties.json') do |f|
+          result = JSON.parse(f.read)
+        end
+        if strict
+          result['additionalProperties'] = true
+        else
+          result['additionalProperties'] = false
+        end
+        return result
       end
+
+      def self.get_thermal_connector_schema(strict)
+        result = nil
+        File.open(File.dirname(__FILE__) + '/schema/thermal_connector_properties.json') do |f|
+          result = JSON.parse(f.read)
+        end
+        if strict
+          result['additionalProperties'] = true
+        else
+          result['additionalProperties'] = false
+        end
+        return result
+      end
+
+      def self.get_thermal_junction_schema(strict)
+        result = nil
+        File.open(File.dirname(__FILE__) + '/schema/thermal_junction_properties.json') do |f|
+          result = JSON.parse(f.read)
+        end
+        if strict
+          result['additionalProperties'] = true
+        else
+          result['additionalProperties'] = false
+        end
+        return result
+      end
+
+      strict = true
+      @@geojson_schema = get_geojson_schema(strict)
+      @@building_schema = get_building_schema(strict)
+      @@district_system_schema = get_district_system_schema(strict)
+      @@region_schema = get_region_schema(strict)
+      @@electrical_connector_schema = get_electrical_connector_schema(strict)
+      @@electrical_junction_schema = get_electrical_junction_schema(strict)
+      @@thermal_connector_schema = get_thermal_connector_schema(strict)
+      @@thermal_junction_schema = get_thermal_junction_schema(strict)
+
     end
   end
 end

data/lib/urbanopt/geojson/helper.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
 # contributors. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without modification,
@@ -216,7 +216,7 @@ module URBANopt
       #
       # [Parameters]
       # * +building+ - _Type:URBANopt::GeoJSON::Building_ - The core building that other buildings will be referenced.
-      # * +other_building_type+ - _Type:String_ - Describes the surrounding buildings. Currently 'ShadingOnly' is the only option that is processed.
+      # * +other_building_type+ - _Type:String_ - Describes the surrounding buildings. 
       # * +other_buildings+ - _Type:URBANopt::GeoJSON::FeatureCollection_ - List of surrounding buildings to include (self will be ignored if present in list).
       # * +model+ - _Type:OpenStudio::Model::Model_ - An instance of an OpenStudio Model.
       # * +origin_lat_lon+ - _Type:Float_ - An instance of +OpenStudio::PointLatLon+ indicating the latitude and longitude of the origin.
@@ -255,14 +255,16 @@ module URBANopt
             # find the polygon of the other_building by passing it to the get_multi_polygons method
             other_building_points = building.other_points(other_building, other_height, origin_lat_lon, runner, zoning)
             shadowed = URBANopt::GeoJSON::Helper.is_shadowed(feature_points, other_building_points, origin_lat_lon)
-            next unless shadowed
-          end
+            next unless shadowed 
+            new_building = building.create_other_building(:space_per_building, model, origin_lat_lon, runner, zoning, other_building)
+            if new_building.nil? || new_building.empty?
+              runner.registerWarning("Failed to create spaces for other building '#{name}'")
+            end
+            other_spaces.concat(new_building)
 
-          new_building = building.create_other_building(:space_per_building, model, origin_lat_lon, runner, zoning, other_building)
-          if new_building.nil? || new_building.empty?
-            runner.registerWarning("Failed to create spaces for other building '#{name}'")
+          elsif other_building_type == 'None'
           end
-          other_spaces.concat(new_building)
+
         end
         return other_spaces
       end

data/lib/urbanopt/geojson/logging.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, 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/urbanopt/geojson/mapper_classes.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# URBANopt, Copyright (c) 2019-2020, 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/urbanopt/geojson/model.rb

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