urbanopt-geojson 0.2.0.pre1 → 0.2.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4010985913ad5a7c4115f4d3e1dc3f137d81157
-  data.tar.gz: 82061675885f216f28529494fbbe90eef06236d8
+  metadata.gz: 1ad031bd7b8b2d22974781fa200d6fc6c233c7cf
+  data.tar.gz: a6bab4394e0bf97c15e86bdc054c37420648c184
 SHA512:
-  metadata.gz: b4517386698b1df8997784da819c6d353e16678376f55d73318486114257a6e4b38c6125f5a3ec20e4ad153fdaf69fa6911d954b339e5973ad5139f3fc51317b
-  data.tar.gz: ba38c577f1f2edad1623a06bf3cd6a83c3ea03760c6a031fa6e2370b240bff39245fead20b6e493685882ce6f24073fcaeffb2ec04949e24439fb6ab1277a77b
+  metadata.gz: d07f450de4bc75b28452c6d18e5ab4207139fab076a3298ec10b36e13d5eab6ac4dbc002a78dc59adb0dca4770ed4d402deaf3247905df8ae926dc7fc64444d2
+  data.tar.gz: 82905227028b1112170d0fe8f9d411af2ba5d275690178ce1d67178952752b13ede774242e115d39cf54260da7f6532e3a4cd23ab61e9b7ff447b9e351240272

data/RDOC_MAIN.md

@@ -7,13 +7,19 @@ The URBANopt GeoJSON Gem has been developed by restructuring methods extracted f
 and
 [urban_geometry_creation_zoning.](https://github.com/NREL/openstudio-urban-measures/tree/develop/measures/urban_geometry_creation_zoning)
 
-The +urban_geometry_creation+ measure can be used to create an OpenStudio Model for the
-building feature and create the surrounding buildings as shading objects. 
-
-The +urban_geometry_creation_zoning+ measure is under development and would be used for creating an OpenStudio
-Model with zoning in the future. 
-
-The main components of the gem are: 
+The +urban_geometry_creation+ measure can be used to create an OpenStudio Model for a
+building feature from the feature file and create the surrounding buildings that are shading the
+building feature as shading objects.
+The arguments used in the measure are the +GeoJSON File+, +Feature ID+ of the building and +Surrounding Buildings+. The
+Surrounding Buildings argument takes two possible choices - None or Shading Only. The None choice
+would create no other buildings adjacent to the building feature while the Shading Only option
+determines what other buildings are shading the building feature and creates them as OpenStudio Shading Surfaces.
+
+The +urban_geometry_creation_zoning+ measure has the same capabilities as the
++urban_geometry_creation+ measure, however it also creates core and perimeter zones for the spaces
+in the OpenStudio Model. It takes in the same arguments as the +urban_geometry_creation+ measure. 
+
+The main components of the gem are:
 
 - geojson.rb : Base gem file that imports all modules and classes. 
 - extension.rb : The extension class inherits from OpenStudio::Extension::Extension, and

data/README.md

@@ -26,9 +26,9 @@ for describing geospatial data related to the built environment.
 
 The current functionalities of the URBANopt GeoJSON gem include:
 
-* Validate a GeoJSON file
-* Calculate available roof area for photovoltaics.
-* Translate Building Feature to an OpenStudio Model.
+* Validate a GeoJSON file against schema.
+* Translate Building Feature to an OpenStudio Model and create zones within OpenStudio Spaces within
+ the Model.
 * Translate Building Feature to OpenStudio Shading Objects.
 
 # Releasing

data/lib/measures/urban_geometry_creation/tests/urban_geometry_creation_test.rb

@@ -98,7 +98,7 @@ class UrbanGeometryCreationTest < MiniTest::Unit::TestCase
 
     geojson_file = File.absolute_path(File.join(File.dirname(__FILE__), 'nrel_stm_footprints.geojson'))
 
-    feature_id = '59a9ce2b42f7d007c059d2f0' # Thermal Test Facility
+    feature_id = '59a9ce2b42f7d007c059d2f0'
 
     surrounding_buildings = 'ShadingOnly'
 

data/lib/urbanopt/geojson/building.rb

@@ -88,8 +88,7 @@ module URBANopt
       # * +origin_lat_lon+ - _Type:Float_ - An instance of +OpenStudio::PointLatLon+ indicating the latitude and longitude of the origin.
       # * +runner+ - _Type:String_ - An instance of +OpenStudio::Measure::OSRunner+ for the measure run.
       # * +zoning+ - _Type:Boolean_ - Value is +true+ if utilizing detailed zoning, else
-      #   +false+. Zoning is set to False by default. Currently, only zoning set to +false+ is
-      #   supported.
+      #   +false+. Zoning is set to False by default. 
       # * +other_building+ - _Type:URBANopt::GeoJSON::Feature - Optional, allow the user to pass in a different building to process. This is used for creating the other buildings for shading.
       def create_building(create_method, model, origin_lat_lon, runner, zoning = false, other_building = @feature_json)
         number_of_stories = other_building[:properties][:number_of_stories]
@@ -134,7 +133,7 @@ module URBANopt
             spaces.concat(new_spaces)
           end
         elsif create_method == :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)
+          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
       end
@@ -294,18 +293,22 @@ module URBANopt
       # * +origin_lat_lon+ - _Type:Float_ - An instance of +OpenStudio::PointLatLon+ indicating the latidude and longitude of the origin.
       # * +runner+ - _Type:String_ - An instance of +Openstudio::Measure::OSRunner+ for the measure run.
       # * +zoning+ - _Type:Boolean_ - Value is +true+ if utilizing detailed zoning, else
-      #   +false+. Zoning is set to False by default. Currently, only zoning set to +false+ is
-      #   supported.
-      def create_space_per_building(min_elevation, max_elevation, model, origin_lat_lon, runner, zoning = false) #:doc:
-        geometry = @feature_json[:geometry]
-        properties = @feature_json[:properties]
+      #   +false+. Zoning is set to False by default.
+      def create_space_per_building(min_elevation, max_elevation, model, origin_lat_lon, runner, zoning = false, other_building) #:doc:
+        if other_building
+          geometry = other_building[:geometry]
+          properties = other_building[:properties]
+        else
+          geometry = @feature_json[:geometry]
+          properties = @feature_json[:properties]
+        end
         if zoning
           name = properties[:id]
         else
           name = properties[:name]
         end
         floor_prints = []
-        multi_polygons = get_multi_polygons
+        multi_polygons = get_multi_polygons(other_building)
         multi_polygons.each do |multi_polygon|
           if multi_polygon.size > 1
             runner.registerWarning('Ignoring holes in polygon')
@@ -349,8 +352,7 @@ module URBANopt
       #   origin's latitude and longitude.
       # * +runner+ - _Type:String_ - An instance of +Openstudio::Measure::OSRunner+ for the measure run.
       # * +zoning+ - _Type:Boolean_ - Value is +true+ if utilizing detailed zoning, else
-      #   +false+. Zoning is set to False by default. Currently, only zoning set to +false+ is
-      #   supported.
+      #   +false+. Zoning is set to False by default. 
       def create_space_per_floor(story_number, floor_to_floor_height, model, origin_lat_lon, runner, zoning = false) #:doc:
         geometry = @feature_json[:geometry]
         properties = @feature_json[:properties]

data/lib/urbanopt/geojson/helper.rb

@@ -222,8 +222,7 @@ module URBANopt
       # * +origin_lat_lon+ - _Type:Float_ - An instance of +OpenStudio::PointLatLon+ indicating the latitude and longitude of the origin.
       # * +runner+ - _Type:String_ - An instance of +Openstudio::Measure::OSRunner+ for the measure run.
       # * +zoning+ - _Type:Boolean_ - Value is +true+ if utilizing detailed zoning, else
-      #   +false+. Zoning is set to false by default. Currently, zoning set to +false+ is
-      #   only supported.
+      #   +false+. Zoning is set to false by default. 
       def self.process_other_buildings(building, other_building_type, other_buildings, model, origin_lat_lon, runner, zoning = false)
         # Empty array to store the new OpenStudio model spaces that need to be converted to shading objects
         feature_points = building.feature_points(origin_lat_lon, runner, zoning)
@@ -233,7 +232,8 @@ module URBANopt
         other_buildings[:features].each do |other_building|
           other_id = other_building[:properties][:id]
           next if other_id == building.id
-          if other_building_type == 'ShadingOnly'
+          # 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.
             roof_elevation = other_building[:properties][:roof_elevation]
             number_of_stories = other_building[:properties][:number_of_stories]

data/lib/urbanopt/geojson/version.rb

@@ -30,6 +30,6 @@
 
 module URBANopt
   module GeoJSON
-    VERSION = '0.2.0.pre1'.freeze
+    VERSION = '0.2.0.pre2'.freeze
   end
 end

data/lib/urbanopt/geojson.rb

@@ -37,5 +37,5 @@ require 'urbanopt/geojson/helper'
 require 'urbanopt/geojson/model'
 require 'urbanopt/geojson/zoning'
 require 'urbanopt/geojson/model'
-require 'urbanopt/geojson/extension'
+require 'urbanopt/geojson/derived_extension'
 require 'urbanopt/geojson/logging'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-geojson
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre1
+  version: 0.2.0.pre2
 platform: ruby
 authors:
 - Tanushree Charan
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -189,8 +189,8 @@ files:
 - lib/urbanopt-geojson.rb
 - lib/urbanopt/geojson.rb
 - lib/urbanopt/geojson/building.rb
+- lib/urbanopt/geojson/derived_extension.rb
 - lib/urbanopt/geojson/district_system.rb
-- lib/urbanopt/geojson/extension.rb
 - lib/urbanopt/geojson/feature.rb
 - lib/urbanopt/geojson/files/electrical_database.json
 - lib/urbanopt/geojson/geo_file.rb