urbanopt-geojson 0.1.0

data/lib/urbanopt/geojson/district_system.rb

@@ -0,0 +1,53 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+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
+        'District System'
+      end
+
+      ##
+      # Returns the district system properties schema.
+      def schema_file
+        return File.join(File.dirname(__FILE__), 'schema', 'district_system_properties.json')
+      end
+    end
+  end
+end

data/lib/urbanopt/geojson/extension.rb

@@ -0,0 +1,63 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+require 'urbanopt/geojson/version'
+require 'openstudio/extension'
+
+module URBANopt
+  module GeoJSON
+    class Extension < OpenStudio::Extension::Extension
+      def initialize # :nodoc:
+        @root_dir = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..', '..'))
+      end
+
+      ##
+      # Returns the absolute path of the measures or returns nil, in case no measures are
+      # added. It can be used while configuring OSWs.
+      def measures_dir
+        return File.absolute_path(File.join(@root_dir, 'lib/measures'))
+      end
+
+      ##
+      # The directory containign relevant files such as weather data, design days, etc.
+      # The method returns nil if no files are present. It is used while configuring OSWs.
+      def files_dir
+        return nil
+      end
+
+      # The directory containing common files like copyright and license notices which are used to update measures and other code.
+      # This method will only be applied to measures in the current repository and
+      # returns the absolute path of the +doc_templates_dir+ or nil if there is none.
+      def doc_templates_dir
+        return File.absolute_path(File.join(@root_dir, 'doc_templates'))
+      end
+    end
+  end
+end

data/lib/urbanopt/geojson/feature.rb

@@ -0,0 +1,206 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+require 'urbanopt/core/feature'
+
+module URBANopt
+  module GeoJSON
+    class Feature < URBANopt::Core::Feature
+      attr_reader :feature_json
+
+      @@feature_schema = {}
+      @@schema_file_lock = Mutex.new
+
+      ##
+      # Used to validate the feature using the validate_feat method.
+      def initialize(feature)
+        @feature_json = validate_feat(feature)
+      end
+
+      def method_missing(name, *args, &blk)
+        if @feature_json[:properties].keys.map(&:to_sym).include? name.to_sym
+          return @feature_json[:properties][name.to_sym]
+        else
+          super
+        end
+      end
+
+      ##
+      # Returns the id of the feature.
+
+      def id
+        return @feature_json[:properties][:id]
+      end
+
+      ##
+      # Returns the name of the feature.
+
+      def name
+        return @feature_json[:properties][:name]
+      end
+
+      ##
+      # Raises an error if the +feature_type+ is not specified the the Feature's class.
+
+      def feature_type
+        raise 'feature_type not implemented for Feature, override in your class'
+      end
+
+      ##
+      # Raises an error if the +schema_file+ is not specified the the Feature's class.
+
+      def schema_file
+        raise 'schema_file not implemented for Feature, override in your class'
+      end
+
+      def schema
+        if @@feature_schema[feature_type].nil?
+          @@schema_file_lock.synchronize do
+            File.open(schema_file, 'r') do |file|
+              @@feature_schema[feature_type] = JSON.parse(file.read, symbolize_names: true)
+
+              # Allows additional properties.
+              @@feature_schema[feature_type][:additionalProperties] = true
+            end
+          end
+        end
+
+        return @@feature_schema[feature_type]
+      end
+
+      ##
+      # Returns coordinate with the minimum longitute and latitude within a given +building_json+ .
+      def get_min_lon_lat
+        min_lon = Float::MAX
+        min_lat = Float::MAX
+        multi_polygons = get_multi_polygons
+        multi_polygons.each do |multi_polygon|
+          multi_polygon.each do |polygon|
+            polygon.each do |point|
+              min_lon = point[0] if point[0] < min_lon
+              min_lat = point[1] if point[1] < min_lat
+            end
+            break
+          end
+        end
+        return [min_lon, min_lat]
+      end
+
+      ##
+      # Returns MultiPolygon coordinates (coordinate pairs in double nested Array)
+      # [Parameters]
+      # +json+
+      #
+      # For example:
+      #
+      #  polygon = {
+      #     'geometry': {
+      #       'type': 'Polygon',
+      #       'coordinates': [
+      #         [
+      #           [0, 5],
+      #           [5, 5],
+      #           [5, 0]
+      #         ]
+      #       ]
+      #     }
+      #   }
+      def get_multi_polygons(json = @feature_json)
+        geometry_type = json[:geometry][:type]
+        multi_polygons = []
+        if geometry_type == 'Polygon'
+          polygons = json[:geometry][:coordinates]
+          multi_polygons = [polygons]
+        elsif geometry_type == 'MultiPolygon'
+          multi_polygons = json[:geometry][:coordinates]
+        end
+        return multi_polygons
+      end
+
+      ##
+      # Returns instance of OpenStudio::PointLatLon for latitude and longitude of feature.
+      #
+      # [Parameters]
+      # * +runner+ - An instance of +Openstudio::Measure::OSRunner+ for the measure run.
+      def create_origin_lat_lon(runner)
+        min_lon_lat = get_min_lon_lat
+        min_lon = min_lon_lat[0]
+        min_lat = min_lon_lat[1]
+
+        if min_lon == Float::MAX || min_lat == Float::MAX
+          runner.registerError('Could not determine min_lat and min_lon')
+          return false
+        else
+          runner.registerInfo("Min_lat = #{min_lat}, min_lon = #{min_lon}")
+        end
+
+        return OpenStudio::PointLatLon.new(min_lat, min_lon, 0)
+      end
+
+      private
+
+      ##
+      # Used to validate the feature by checking +feature_id+ , +geometry+, +properties+
+      # and +geometry_type+ .
+
+      def validate_feat(feature) #:doc:
+        if feature.nil? || feature.empty?
+          raise("Feature '#{feature_id}' could not be found")
+          return false
+        end
+
+        if feature[:geometry].nil?
+          raise("No geometry found in '#{feature}'")
+          return false
+        end
+
+        if feature[:properties].nil?
+          raise("No properties found in '#{feature}'")
+          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
+        end
+
+        geometry_type = feature[:geometry][:type]
+        if geometry_type == 'Polygon'
+        elsif geometry_type == 'MultiPolygon'
+        else
+          raise("Unknown geometry type '#{geometry_type}'")
+          return false
+        end
+        return feature
+      end
+    end
+  end
+end

data/lib/urbanopt/geojson/geo_file.rb

@@ -0,0 +1,154 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+require 'json-schema'
+require 'urbanopt/core/feature_file'
+require 'urbanopt/geojson/building'
+require 'urbanopt/geojson/district_system'
+require 'urbanopt/geojson/logging'
+require 'json'
+
+module URBANopt
+  module GeoJSON
+    class GeoFile < URBANopt::Core::FeatureFile
+      @@geojson_schema = nil
+      @@schema_file_lock = Mutex.new
+
+      ##
+      # Raises an error in case the GeoJSON file is not valid.
+      #
+      # [Parameters]
+      #
+      # * +data+ - _Type:Hash_ Contains the GeoJSON.
+      def initialize(data, path = nil)
+        @path = path
+        @geojson = data
+        if !valid?
+          raise 'GeoJSON file does not adhere to schema'
+        end
+      end
+
+      ##
+      # [Parameters]
+      #
+      # Used to check the GeoJSON file path.
+      # * +path+ - _Type:String_ - GeoJSON file path.
+      def self.from_file(path)
+        if path.nil? || path.empty?
+          raise "GeoJSON file '#{path}' could not be found"
+        end
+
+        if !File.exist?(path)
+          raise "GeoJSON file '#{path}' does not exist"
+        end
+
+        geojson = JSON.parse(
+          File.open(path, 'r', &:read),
+          symbolize_names: true
+        )
+        return new(geojson, path)
+      end
+
+      def json
+        @geojson
+      end
+
+      attr_reader :path
+
+      ##
+      # This method loops through all the features in the GeoJSON file, creates new
+      # Buildings or District Systems based on the feature type, and returns the features.
+      #
+      def features
+        result = []
+        @geojson[: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'
+            result << URBANopt::GeoJSON::DistrictSystem.new(f)
+          end
+        end
+        return result
+      end
+
+      ##
+      # 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.
+      #
+      # [Parameters]
+      # * +feature_id+ - _Type:String/Number_ - Id affiliated with feature object.
+      def get_feature_by_id(feature_id)
+        @geojson[:features].each do |f|
+          if f[:properties] && f[:properties][:id] == feature_id
+            if f[:properties][:type] == 'Building'
+              return URBANopt::GeoJSON::Building.new(f)
+            elsif f[:properties] && f[:properties][:type] == 'District System'
+              return URBANopt::GeoJSON::DistrictSystem.new(f)
+            end
+          end
+        end
+        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')
+      end
+
+      ##
+      # Returns the +geojson_schema+ .
+      def schema
+        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)
+            end
+          end
+        end
+
+        return @@geojson_schema
+      end
+
+      ##
+      # Validates the GeoJSON file against the schema.
+      def valid?
+        return JSON::Validator.validate(schema, @geojson)
+      end
+
+      ##
+      # Returns detailed validation results.
+      def validation_errors
+        return JSON::Validator.fully_validate(schema, @geojson)
+      end
+    end
+  end
+end