urbanopt-geojson 0.1.0

data/lib/urbanopt/geojson/zoning.rb

@@ -0,0 +1,134 @@
+# *********************************************************************************
+# 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.
+# *********************************************************************************
+
+module URBANopt
+  module GeoJSON
+    module Zoning
+      ##
+      # This method divides the floor print using perimeter and core zoning at
+      # the depth of the +perimeter_depth+.
+      #
+      # It returns an Array of Arrays containing instances of +OpenStudio::Point3d+ .
+      #
+      # [Parameters]
+      # * +floor_print+ - _Type:Array_ - An instance of +OpenStudio::Point3dVector.new+ .
+      # * +perimeter_depth+ - _Type:Float_ - Represents perimeter depth.
+      # * +runner+ - _Type:String_ - Measure run's instance of +OpenStudio::Measure::OSRunner+ .
+      def self.divide_floor_print(floor_print, perimeter_depth, runner)
+        result = []
+        t_inv = OpenStudio::Transformation.alignFace(floor_print)
+        t = t_inv.inverse
+        vertices = t * floor_print
+        new_vertices = OpenStudio::Point3dVector.new
+        n = vertices.size
+        (0...n).each do |i|
+          vertex_1 = nil
+          vertex_2 = nil
+          vertex_3 = nil
+          if i == 0
+            vertex_1 = vertices[n - 1]
+            vertex_2 = vertices[i]
+            vertex_3 = vertices[i + 1]
+          elsif i == (n - 1)
+            vertex_1 = vertices[i - 1]
+            vertex_2 = vertices[i]
+            vertex_3 = vertices[0]
+          else
+            vertex_1 = vertices[i - 1]
+            vertex_2 = vertices[i]
+            vertex_3 = vertices[i + 1]
+          end
+          vector_1 = (vertex_2 - vertex_1)
+          vector_2 = (vertex_3 - vertex_2)
+          angle_1 = Math.atan2(vector_1.y, vector_1.x) + Math::PI / 2.0
+          angle_2 = Math.atan2(vector_2.y, vector_2.x) + Math::PI / 2.0
+          vector = OpenStudio::Vector3d.new(Math.cos(angle_1) + Math.cos(angle_2), Math.sin(angle_1) + Math.sin(angle_2), 0)
+          vector.setLength(perimeter_depth)
+          new_point = vertices[i] + vector
+          new_vertices << new_point
+        end
+        normal = OpenStudio.getOutwardNormal(new_vertices)
+        if normal.empty? || normal.get.z < 0
+          runner.registerWarning('Wrong direction for resulting normal, will not divide')
+          return [floor_print]
+        end
+        self_intersects = OpenStudio.selfIntersects(OpenStudio.reverse(new_vertices), 0.01)
+        if OpenStudio::VersionString.new(OpenStudio.openStudioVersion) < OpenStudio::VersionString.new('1.12.4')
+          self_intersects = !self_intersects
+        end
+        if self_intersects
+          runner.registerWarning('Self intersecting surface result, will not divide')
+        end
+        result << t_inv * new_vertices
+        (0...n).each do |i|
+          perim_vertices = OpenStudio::Point3dVector.new
+          if i == (n - 1)
+            perim_vertices << vertices[i]
+            perim_vertices << vertices[0]
+            perim_vertices << new_vertices[0]
+            perim_vertices << new_vertices[i]
+          else
+            perim_vertices << vertices[i]
+            perim_vertices << vertices[i + 1]
+            perim_vertices << new_vertices[i + 1]
+            perim_vertices << new_vertices[i]
+          end
+          result << t_inv * perim_vertices
+        end
+        return result
+      end
+
+      ##
+      # The get_first_floor_points is used to return the points for the first floor.
+      #
+      # It returns an Array containing instances of +OpenStudio::Point3d+.
+      #
+      # [Parameters]
+      # * +multi_polygons+ - _Type-Array_ - Coordinate pairs in double nested +Array+ .
+      # * +origin_lat_lon+ - _Type-Float_ - An instance of +OpenStudio::PointLatLon+ indicating origin
+      #   latitude and longitude.
+      # * +runner+ - _Type-String_ - Measure run's instance of +OpenStudio::Measure::OSRunner+ .
+      def self.get_first_floor_points(multi_polygons, origin_lat_lon, runner)
+        building_points = []
+        multi_polygons.each do |multi_polygon|
+          multi_polygon.each do |polygon|
+            elevation = 0
+            floor_print = URBANopt::GeoJSON::Helper.floor_print_from_polygon(polygon, elevation, origin_lat_lon, runner, true)
+            floor_print.each do |point|
+              building_points << point
+            end
+            break
+          end
+        end
+        return building_points
+      end
+    end
+  end
+end

data/package-lock.json

@@ -0,0 +1,3 @@
+{
+  "lockfileVersion": 1
+}

data/urbanopt-geojson-gem.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'urbanopt/geojson/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'urbanopt-geojson'
+  spec.version       = URBANopt::GeoJSON::VERSION
+  spec.authors       = ['Tanushree Charan', 'Nicholas Long', 'Dan Macumber']
+  spec.email         = ['tanushree.charan@nrel.gov', 'nicholas.long@nrel.gov', 'daniel.macumber@nrel.gov']
+
+  spec.summary       = 'Library and measures to translate URBANopt GeoJSON format to OpenStudio'
+  spec.description   = 'Library and measures to translate URBANopt GeoJSON format to OpenStudio'
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.homepage      = 'https://github.com/urbanopt/urbanopt-geojson-gem'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '12.3.1'
+  spec.add_development_dependency 'rspec', '3.7.0'
+
+  # lock the version of these dependencies due to using older version of Ruby.
+  spec.add_dependency 'public_suffix', '3.1.1'
+
+  # other dependencies
+  spec.add_dependency 'json-schema'
+  spec.add_dependency 'openstudio-extension', '~> 0.1.3'
+  spec.add_dependency 'urbanopt-core', '~> 0.1.0'
+end

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: urbanopt-geojson
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tanushree Charan
+- Nicholas Long
+- Dan Macumber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: openstudio-extension
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: urbanopt-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Library and measures to translate URBANopt GeoJSON format to OpenStudio
+email:
+- tanushree.charan@nrel.gov
+- nicholas.long@nrel.gov
+- daniel.macumber@nrel.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rakeTasks"
+- ".rdoc_options"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Jenkinsfile
+- LICENSE.md
+- RDOC_MAIN.md
+- README.md
+- Rakefile
+- deploy_docs.sh
+- doc_templates/LICENSE.md
+- doc_templates/README.md.erb
+- doc_templates/copyright_erb.txt
+- doc_templates/copyright_js.txt
+- doc_templates/copyright_ruby.txt
+- docs/.gitignore
+- docs/.vuepress/components/BuildingProperties.vue
+- docs/.vuepress/components/DistrictSystemProperties.vue
+- docs/.vuepress/components/ElectricalConnectorProperties.vue
+- docs/.vuepress/components/ElectricalJunctionProperties.vue
+- docs/.vuepress/components/InnerJsonSchema.vue
+- docs/.vuepress/components/JsonSchema.vue
+- docs/.vuepress/components/RegionProperties.vue
+- docs/.vuepress/components/SiteProperties.vue
+- docs/.vuepress/components/StaticLink.vue
+- docs/.vuepress/components/ThermalConnectorProperties.vue
+- docs/.vuepress/components/ThermalJunctionProperties.vue
+- docs/.vuepress/config.js
+- docs/.vuepress/highlight.js
+- docs/.vuepress/public/custom_rdoc_styles.css
+- docs/.vuepress/utils.js
+- docs/README.md
+- docs/doc/created.rid
+- docs/package-lock.json
+- docs/package.json
+- docs/schemas/building-properties.md
+- docs/schemas/district-system-properties.md
+- docs/schemas/electrical-connector-properties.md
+- docs/schemas/electrical-junction-properties.md
+- docs/schemas/region-properties.md
+- docs/schemas/site-properties.md
+- docs/schemas/thermal-connector-properties.md
+- docs/schemas/thermal-junction-properties.md
+- lib/measures/.rubocop.yml
+- lib/measures/urban_geometry_creation/LICENSE.md
+- lib/measures/urban_geometry_creation/README.md
+- lib/measures/urban_geometry_creation/README.md.erb
+- lib/measures/urban_geometry_creation/measure.rb
+- lib/measures/urban_geometry_creation/measure.xml
+- lib/measures/urban_geometry_creation/tests/nrel_stm_footprints.geojson
+- lib/measures/urban_geometry_creation/tests/shadowed_tests.rb
+- lib/measures/urban_geometry_creation/tests/urban_geometry_creation_test.rb
+- lib/measures/urban_geometry_creation_zoning/LICENSE.md
+- lib/measures/urban_geometry_creation_zoning/README.md
+- lib/measures/urban_geometry_creation_zoning/README.md.erb
+- lib/measures/urban_geometry_creation_zoning/measure.rb
+- lib/measures/urban_geometry_creation_zoning/measure.xml
+- lib/measures/urban_geometry_creation_zoning/tests/nrel_stm_footprints.geojson
+- lib/measures/urban_geometry_creation_zoning/tests/urban_geometry_creation_test.rb
+- lib/urbanopt/geojson.rb
+- lib/urbanopt/geojson/building.rb
+- lib/urbanopt/geojson/district_system.rb
+- lib/urbanopt/geojson/extension.rb
+- lib/urbanopt/geojson/feature.rb
+- lib/urbanopt/geojson/geo_file.rb
+- lib/urbanopt/geojson/helper.rb
+- lib/urbanopt/geojson/logging.rb
+- lib/urbanopt/geojson/mapper_classes.rb
+- lib/urbanopt/geojson/model.rb
+- lib/urbanopt/geojson/region.rb
+- lib/urbanopt/geojson/schema/building_properties.json
+- lib/urbanopt/geojson/schema/district_system_properties.json
+- lib/urbanopt/geojson/schema/electrical_connector_properties.json
+- lib/urbanopt/geojson/schema/electrical_junction_properties.json
+- lib/urbanopt/geojson/schema/geojson_schema.json
+- lib/urbanopt/geojson/schema/region_properties.json
+- lib/urbanopt/geojson/schema/site_properties.json
+- lib/urbanopt/geojson/schema/thermal_connector_properties.json
+- lib/urbanopt/geojson/schema/thermal_junction_properties.json
+- lib/urbanopt/geojson/update_areas.rb
+- lib/urbanopt/geojson/validate_geojson.rb
+- lib/urbanopt/geojson/version.rb
+- lib/urbanopt/geojson/workflows/building.osw
+- lib/urbanopt/geojson/workflows/building.osw.out
+- lib/urbanopt/geojson/workflows/district_system.osw
+- lib/urbanopt/geojson/workflows/district_system.osw.out
+- lib/urbanopt/geojson/zoning.rb
+- package-lock.json
+- urbanopt-geojson-gem.gemspec
+homepage: https://github.com/urbanopt/urbanopt-geojson-gem
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Library and measures to translate URBANopt GeoJSON format to OpenStudio
+test_files: []