urbanopt-geojson 0.3.1 → 0.4.0

data/lib/urbanopt/geojson/mapper_classes.rb

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

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

@@ -0,0 +1,91 @@
+# *********************************************************************************
+# URBANopt (tm), 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,
+# 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'
+require 'net/http'
+require 'uri'
+require 'openssl'
+require 'bigdecimal/newton'
+
+module Newton
+  def self.jacobian(f, fx, x)
+    Jacobian.jacobian(f, fx, x)
+  end
+
+  def self.ludecomp(a, n, zero = 0, one = 1)
+    LUSolve.ludecomp(a, n, zero, one)
+  end
+
+  def self.lusolve(a, b, ps, zero = 0.0)
+    LUSolve.lusolve(a, b, ps, zero)
+  end
+end
+
+module URBANopt
+  module GeoJSON
+    class ScaleArea
+      def initialize(vertices, desired_area, runner, eps)
+        @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
+        @runner = runner
+        @zero = BigDecimal('0.0')
+        @one  = BigDecimal('1.0')
+        @two  = BigDecimal('2.0')
+        @ten  = BigDecimal('10.0')
+        @eps  = eps # BigDecimal::new(eps)
+      end
+
+      attr_reader :zero
+
+      attr_reader :one
+
+      attr_reader :two
+
+      attr_reader :ten
+
+      attr_reader :eps
+
+      # compute value
+      def values(x)
+        @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

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

@@ -87,7 +87,7 @@
       "type": "string"
     },
     "floor_area": {
-      "description": "Usable floor area (ft^2).",
+      "description": "Usable floor area (ft^2). Required for residential buildings, this represents conditioned floor area.",
       "type": "number"
     },
     "number_of_stories": {
@@ -95,7 +95,7 @@
       "type": "integer"
     },
     "number_of_stories_above_ground": {
-      "description": "The number of building stories above ground. Defaults to number_of_stories.",
+      "description": "The number of building stories above ground. Defaults to number_of_stories. Required for residential buildings.",
       "type": "integer"
     },
     "maximum_roof_height": {
@@ -194,7 +194,7 @@
       "maximum": 100
     },
     "number_of_residential_units": {
-      "description": "Total number of residential units in the building. Required for single-family attached or multifamily residential buildings.",
+      "description": "Total number of residential units in the building. Required for single-family attached and multifamily residential buildings.",
       "type": "integer"
     },
     "number_of_bedrooms": {
@@ -241,8 +241,8 @@
         "type",
         "name",
         "floor_area",
+        "number_of_stories_above_ground",
         "number_of_stories",
-        "footprint_area",
         "building_type",
         "number_of_bedrooms",
         "foundation_type",
@@ -262,8 +262,8 @@
         "type",
         "name",
         "floor_area",
+        "number_of_stories_above_ground",
         "number_of_stories",
-        "footprint_area",
         "building_type",
         "number_of_residential_units",
         "number_of_bedrooms",
@@ -284,8 +284,8 @@
         "type",
         "name",
         "floor_area",
+        "number_of_stories_above_ground",
         "number_of_stories",
-        "footprint_area",
         "building_type",
         "number_of_residential_units",
         "number_of_bedrooms",
@@ -519,7 +519,12 @@
         "DEER 2060",
         "DEER 2065",
         "DEER 2070",
-        "DEER 2075"
+        "DEER 2075",
+        "Residential IECC 2006 - Customizable Template Sep 2020",
+        "Residential IECC 2009 - Customizable Template Sep 2020",
+        "Residential IECC 2012 - Customizable Template Sep 2020",
+        "Residential IECC 2015 - Customizable Template Sep 2020",
+        "Residential IECC 2018 - Customizable Template Sep 2020"
       ]
     },
     "foundationType": {

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

@@ -88,7 +88,7 @@
       "description": "Type of electrical line",
       "type": "string",
       "enum": [
-        "Line"
+        "Wire"
       ]
     },
     "WireType": {

data/lib/urbanopt/geojson/update_areas.rb

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

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

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,
@@ -30,6 +30,6 @@
 
 module URBANopt
   module GeoJSON
-    VERSION = '0.3.1'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

data/lib/urbanopt/geojson/zoning.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,
@@ -41,7 +41,8 @@ module URBANopt
       # * +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)
+      # * +scale+ - _Type:Boolean_ - Checks whether floor print is to be scaled. Default is false.
+      def self.divide_floor_print(floor_print, perimeter_depth, runner, scale = false)
         result = []
         t_inv = OpenStudio::Transformation.alignFace(floor_print)
         t = t_inv.inverse
@@ -86,21 +87,25 @@ module URBANopt
         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]
+        if scale == true
+          result = t_inv * new_vertices
+        else
+          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
-          result << t_inv * perim_vertices
         end
         return result
       end

data/urbanopt-geojson-gem.gemspec

@@ -9,9 +9,10 @@ Gem::Specification.new do |spec|
   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.summary       = 'Translate URBANopt GeoJSON format to OpenStudio'
   spec.description   = 'Library and measures to translate URBANopt GeoJSON format to OpenStudio'
   spec.homepage      = 'https://github.com/urbanopt/urbanopt-geojson-gem'
+  spec.licenses      = 'Nonstandard'
 
   # 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.
@@ -28,11 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.7'
 
-  # 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.2.3'
-  spec.add_dependency 'urbanopt-core', '~> 0.3.0'
+  spec.add_runtime_dependency 'json-schema', '~> 2.8'
+  spec.add_runtime_dependency 'openstudio-extension', '~> 0.2.5'
+  spec.add_runtime_dependency 'urbanopt-core', '~> 0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-geojson
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Tanushree Charan
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-07 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,44 +58,44 @@ dependencies:
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: openstudio-extension
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.5
 - !ruby/object:Gem::Dependency
   name: urbanopt-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 description: Library and measures to translate URBANopt GeoJSON format to OpenStudio
 email:
 - tanushree.charan@nrel.gov
@@ -179,6 +179,7 @@ files:
 - lib/urbanopt/geojson/mapper_classes.rb
 - lib/urbanopt/geojson/model.rb
 - lib/urbanopt/geojson/region.rb
+- lib/urbanopt/geojson/scale_area.rb
 - lib/urbanopt/geojson/schema/building_properties.json
 - lib/urbanopt/geojson/schema/district_system_properties.json
 - lib/urbanopt/geojson/schema/electrical_connector_properties.json
@@ -199,7 +200,8 @@ files:
 - package-lock.json
 - urbanopt-geojson-gem.gemspec
 homepage: https://github.com/urbanopt/urbanopt-geojson-gem
-licenses: []
+licenses:
+- Nonstandard
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -216,9 +218,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Library and measures to translate URBANopt GeoJSON format to OpenStudio
+summary: Translate URBANopt GeoJSON format to OpenStudio
 test_files: []