urbanopt-geojson 0.1.0 → 0.2.0.pre1

data/docs/package.json

@@ -17,6 +17,13 @@
     "webpack-dev-middleware": "^3.6.0"
   },
   "devDependencies": {
-    "gh-pages": "^2.0.1"
+    "braces": ">=2.3.1",
+    "gh-pages": "^2.0.1",
+    "js-yaml": ">=3.13.1",
+    "lodash": ">=4.17.12",
+    "lodash.template": ">=4.5.0",
+    "mixin-deep": ">=1.3.2",
+    "serialize-javascript": ">=2.1.1",
+    "set-value": ">=2.0.1"
   }
 }

data/lib/change_log.rb

@@ -0,0 +1,147 @@
+#!/usr/bin/env ruby
+
+require 'github_api'
+require 'date'
+require 'optparse'
+require 'optparse/date'
+
+# Instructions:
+#   Get a token from github's settings (https://github.com/settings/tokens)
+#
+# Example:
+#   ruby change_log.rb -t abcdefghijklmnopqrstuvwxyz -s 2017-09-06
+#
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: change_log.rb [options]\n" +
+  "Prints New, Open, Closed Issues, and number of accepted PRs"
+  opts.separator ""
+
+  # defaults, go back 90 days
+  options[:start_date] = Date.today - 90
+  options[:end_date] = Date.today
+
+  opts.on('-s', '--start-date [DATE]', Date, 'Start of data (e.g. 2017-09-06)') do |v|
+    options[:start_date] = v
+  end
+  opts.on('-e', '--end-date [DATE]', Date, 'End of data (e.g. 2017-09-13)') do |v|
+    options[:end_date] = v
+  end
+  opts.on('-t', '--token [String]', String, 'Github API Token') do |v|
+    options[:token] = v
+  end
+end.parse!
+
+# Convert dates to time objects
+options[:start_date] = Time.parse(options[:start_date].to_s)
+options[:end_date] = Time.parse(options[:end_date].to_s)
+puts options
+
+### Repository options
+repo_owner = 'URBANopt'
+repo = 'urbanopt-geojson-gem'
+
+github = Github.new
+if options[:token]
+  puts 'Using github token'
+  github = Github.new oauth_token: options[:token]
+end
+
+total_open_issues = []
+total_open_pull_requests = []
+new_issues = []
+closed_issues = []
+accepted_pull_requests = []
+
+def get_num(issue)
+  issue.html_url.split('/')[-1].to_i
+end
+
+def get_issue_num(issue)
+  "\##{get_num(issue)}"
+end
+
+def get_html_url(issue)
+  issue.html_url
+end
+
+def get_title(issue)
+  issue.title
+end
+
+def print_issue(issue)
+  is_feature = false
+  issue.labels.each { |label| is_feature = true if label.name == 'Feature Request' }
+
+  if is_feature
+    "- Improved [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
+  else
+    "- Fixed [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
+  end
+end
+
+# Process Open Issues
+results = -1
+page = 1
+while results != 0
+  resp = github.issues.list user: repo_owner, repo: repo, sort: 'created', direction: 'asc',
+                            state: 'open', per_page: 100, page: page
+  results = resp.length
+  resp.env[:body].each do |issue, _index|
+    created = Time.parse(issue.created_at)
+    if !issue.key?(:pull_request)
+      total_open_issues << issue
+      if created >= options[:start_date] && created <= options[:end_date]
+        new_issues << issue
+      end
+    else
+      total_open_pull_requests << issue
+    end
+  end
+
+  page += 1
+end
+
+# Process Closed Issues
+results = -1
+page = 1
+while results != 0
+  resp = github.issues.list user: repo_owner, repo: repo, sort: 'created', direction: 'asc',
+                            state: 'closed', per_page: 100, page: page
+  results = resp.length
+  resp.env[:body].each do |issue, _index|
+    created = Time.parse(issue.created_at)
+    closed = Time.parse(issue.closed_at)
+    if !issue.key?(:pull_request)
+      if created >= options[:start_date] && created <= options[:end_date]
+        new_issues << issue
+      end
+      if closed >= options[:start_date] && closed <= options[:end_date]
+        closed_issues << issue
+      end
+    elsif closed >= options[:start_date] && closed <= options[:end_date]
+      accepted_pull_requests << issue
+    end
+  end
+
+  page += 1
+end
+
+closed_issues.sort! { |x, y| get_num(x) <=> get_num(y) }
+new_issues.sort! { |x, y| get_num(x) <=> get_num(y) }
+accepted_pull_requests.sort! { |x, y| get_num(x) <=> get_num(y) }
+total_open_pull_requests.sort! { |x, y| get_num(x) <=> get_num(y) }
+
+puts "Total Open Issues: #{total_open_issues.length}"
+puts "Total Open Pull Requests: #{total_open_pull_requests.length}"
+puts "\nDate Range: #{options[:start_date].strftime('%m/%d/%y')} - #{options[:end_date].strftime('%m/%d/%y')}:"
+puts "\nNew Issues: #{new_issues.length} (" + new_issues.map { |issue| get_issue_num(issue) }.join(', ') + ')'
+
+puts "\nClosed Issues: #{closed_issues.length}"
+closed_issues.each { |issue| puts print_issue(issue) }
+
+puts "\nAccepted Pull Requests: #{accepted_pull_requests.length}"
+accepted_pull_requests.each { |issue| puts print_issue(issue) }
+
+puts "\nAll Open Issues: #{total_open_issues.length} (" + total_open_issues.map { |issue| get_issue_num(issue) }.join(', ') + ')'

data/lib/measures/urban_geometry_creation/LICENSE.md

@@ -1,4 +1,4 @@
-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/measures/urban_geometry_creation/measure.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,
@@ -68,8 +68,6 @@ class UrbanGeometryCreation < OpenStudio::Measure::ModelMeasure
     chs = OpenStudio::StringVector.new
     chs << 'None'
     chs << 'ShadingOnly'
-    chs << 'All'
-    # Note: Only ShadingOnly is implemented at the moment
     surrounding_buildings = OpenStudio::Measure::OSArgument.makeChoiceArgument('surrounding_buildings', chs, true)
     surrounding_buildings.setDisplayName('Surrounding Buildings')
     surrounding_buildings.setDescription('Select which surrounding buildings to include.')

data/lib/measures/urban_geometry_creation/tests/shadowed_tests.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/measures/urban_geometry_creation/tests/urban_geometry_creation_test.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,
@@ -50,8 +50,6 @@ class UrbanGeometryCreationTest < MiniTest::Unit::TestCase
     feature_id = '59a9ce2b42f7d007c059d2ee' # Energy Systems Integration Facility
 
     surrounding_buildings = 'None'
-    # surrounding_buildings = "ShadingOnly"
-    # surrounding_buildings = "All"
 
     # get arguments
     arguments = measure.arguments(model)
@@ -72,7 +70,7 @@ class UrbanGeometryCreationTest < MiniTest::Unit::TestCase
       end
       argument_map[arg.name] = temp_arg_var
     end
-
+    
     # run the measure
     measure.run(model, runner, argument_map)
     result = runner.result
@@ -100,11 +98,9 @@ class UrbanGeometryCreationTest < MiniTest::Unit::TestCase
 
     geojson_file = File.absolute_path(File.join(File.dirname(__FILE__), 'nrel_stm_footprints.geojson'))
 
-    feature_id = '59a9ce2b42f7d007c059d2f0' # Education Center
+    feature_id = '59a9ce2b42f7d007c059d2f0' # Thermal Test Facility
 
-    # surrounding_buildings = "None"
     surrounding_buildings = 'ShadingOnly'
-    # surrounding_buildings = "All"
 
     # get arguments
     arguments = measure.arguments(model)

data/lib/measures/urban_geometry_creation_zoning/LICENSE.md

@@ -1,4 +1,4 @@
-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/measures/urban_geometry_creation_zoning/measure.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,
@@ -72,8 +72,6 @@ class UrbanGeometryCreationZoning < OpenStudio::Measure::ModelMeasure
     chs = OpenStudio::StringVector.new
     chs << 'None'
     chs << 'ShadingOnly'
-    chs << 'All'
-    # Note: Only ShadingOnly is implemented at the moment
     surrounding_buildings = OpenStudio::Measure::OSArgument.makeChoiceArgument('surrounding_buildings', chs, true)
     surrounding_buildings.setDisplayName('Surrounding Buildings')
     surrounding_buildings.setDescription('Select which surrounding buildings to include.')
@@ -113,8 +111,8 @@ class UrbanGeometryCreationZoning < OpenStudio::Measure::ModelMeasure
     @runner = runner
     @origin_lat_lon = nil
 
-    all_features = URBANopt::GeoJSON::GeoFile.from_file(geojson_file)
-    feature = URBANopt::GeoJSON::GeoFile.from_file(geojson_file).get_feature_by_id(feature_id)
+    all_features = URBANopt::GeoJSON::GeoFile.from_file(geojson_file)  
+    feature = URBANopt::GeoJSON::GeoFile.from_file(geojson_file).get_feature_by_id(feature_id) 
 
     # EXPOSE NAME
     name = feature.feature_json[:properties][:name]
@@ -136,7 +134,7 @@ class UrbanGeometryCreationZoning < OpenStudio::Measure::ModelMeasure
     end
 
     if feature.type == 'Building'
-      # make requested building
+      # make requested building, zoning is set to true
       spaces = feature.create_building(:spaces_per_floor, model, @origin_lat_lon, @runner, true)
       if spaces.nil? || spaces.empty?
         @runner.registerError("Failed to create building spaces for feature #{feature_id}")
@@ -155,6 +153,7 @@ class UrbanGeometryCreationZoning < OpenStudio::Measure::ModelMeasure
         convert_to_shades = feature.create_other_buildings(surrounding_buildings, all_features.json, model, @origin_lat_lon, @runner)
       end
 
+      
       # intersect surfaces in this building with others
       @runner.registerInfo('Intersecting surfaces')
       spaces.each do |space|

data/lib/measures/urban_geometry_creation_zoning/tests/{urban_geometry_creation_test.rb → urban_geometry_creation_zoning_test.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,
@@ -47,11 +47,9 @@ class UrbanGeometryCreationZoningTest < MiniTest::Unit::TestCase
 
     geojson_file = File.absolute_path(File.join(File.dirname(__FILE__), 'nrel_stm_footprints.geojson'))
 
-    feature_id = '59a9ce2b42f7d007c059d2ee' # Energy Systems Integration Facility
+    feature_id = '59a9ce2b42f7d007c059d2f0' 
 
     surrounding_buildings = 'None'
-    # surrounding_buildings = "ShadingOnly"
-    # surrounding_buildings = "All"
 
     # get arguments
     arguments = measure.arguments(model)
@@ -100,11 +98,9 @@ class UrbanGeometryCreationZoningTest < MiniTest::Unit::TestCase
 
     geojson_file = File.absolute_path(File.join(File.dirname(__FILE__), 'nrel_stm_footprints.geojson'))
 
-    feature_id = '59a9ce2b42f7d007c059d2f0' # Education Center
+    feature_id = '59a9ce2b42f7d007c059d2ee' 
 
-    # surrounding_buildings = "None"
     surrounding_buildings = 'ShadingOnly'
-    # surrounding_buildings = "All"
 
     # get arguments
     arguments = measure.arguments(model)

data/lib/urbanopt-geojson.rb

@@ -0,0 +1,31 @@
+# *********************************************************************************
+# 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,
+# 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_relative 'urbanopt/geojson'

data/lib/urbanopt/geojson.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/building.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,
@@ -33,10 +33,34 @@ require 'urbanopt/geojson/feature'
 module URBANopt
   module GeoJSON
     class Building < URBANopt::GeoJSON::Feature
+
       ##
       # Used to initialize the feature. This method is inherited from the Feature class.
-      def initialize(feature)
+      def initialize(feature = {})
         super(feature)
+
+        @id = feature[:properties][:id]
+        @name = feature[:properties][:name]
+        @detailed_model_filename = feature[:properties][:detailed_model_filename]
+        @floor_area = feature[:properties][:floor_area]
+        @number_of_stories = feature[:properties][:number_of_stories]
+        @number_of_stories_above_ground = feature[:properties][:number_of_stories_above_ground]
+        @footprint_area = feature[:properties][:footprint_area]
+        @template = feature[:properties][:template]
+        @building_type = feature[:properties][:building_type]
+        @system_type = feature[:properties][:system_type]
+        @weekday_start_time = feature[:properties][:weekday_start_time]
+        @weekday_duration = feature[:properties][:weekday_duration]
+        @weekend_start_time = feature[:properties][:weekend_start_time]
+        @weekend_duration = feature[:properties][:weekend_duration]
+        @mixed_type_1 = feature[:properties][:mixed_type_1]
+        @mixed_type_1_percentage = feature[:properties][:mixed_type_1_percentage]
+        @mixed_type_2 = feature[:properties][:mixed_type_2]
+        @mixed_type_2_percentage = feature[:properties][:mixed_type_2_percentage]
+        @mixed_type_3 = feature[:properties][:mixed_type_3]
+        @mixed_type_3_percentage = feature[:properties][:mixed_type_3_percentage]
+        @mixed_type_4 = feature[:properties][:mixed_type_4]
+        @mixed_type_4_percentage = feature[:properties][:mixed_type_4_percentage]
       end
 
       ##
@@ -174,20 +198,30 @@ module URBANopt
       # Returns an array of instances of +OpenStudio::Model::Space+.
       #
       # [Parameters]
-      # * +other_building_type+ - _Type:String_ - Describes the surrounding buildings. Currently 'ShadingOnly' is the only option that is processed.
-      # * +other_buildings+ - _Type:URBANopt::GeoJSON::FeatureCollection_ - List of surrounding buildings to include (self will be ignored if present in list).
+      # * +other_building_type+ - _Type:String_ - Describes the surrounding buildings. Supports 'None', 'ShadingOnly' options.
+      # * +other_buildings+ - _Type:URBANopt::GeoJSON::FeatureCollection_ - List of all surrounding features 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.
       # * +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.
       def create_other_buildings(other_building_type, other_buildings, model, origin_lat_lon, runner, zoning = false)
+        building_features = {}
+        building_features[:features] = []
         if other_buildings[:features].nil?
           runner.registerWarning("No features found in #{other_buildings}")
           return []
+        else
+          # remove non-buildings from the other_buildings list of all project features
+          # since this is for shading, keep District Systems as well
+          other_buildings[:features].each do |f|
+            if f[:properties][:type] == 'Building' || f[:properties][:type] == 'District System'
+              building_features[:features] << f
+            end
+          end
         end
 
         other_spaces = URBANopt::GeoJSON::Helper.process_other_buildings(
-          self, other_building_type, other_buildings, model, origin_lat_lon, runner, zoning
+          self, other_building_type, building_features, model, origin_lat_lon, runner, zoning
         )
         return other_spaces
       end
@@ -215,6 +249,39 @@ module URBANopt
         end
       end
 
+      ##
+      # Convert to a Hash equivalent for JSON serialization
+      ##
+      # - Exclude attributes with nil values.
+      ##
+      def to_hash
+        result = {}
+        result[:id] = @id if @id
+        result[:name] = @name if @name
+        result[:detailed_model_filename] = @detailed_model_filename if @detailed_model_filename
+        result[:floor_area] = @floor_area if @floor_area
+        result[:number_of_stories] = @number_of_stories if @number_of_stories
+        result[:number_of_stories_above_ground] = @number_of_stories_above_ground if @number_of_stories_above_ground
+        result[:footprint_area] = @footprint_area if @footprint_area
+        result[:template] = @template if @template
+        result[:building_type] = @building_type if @building_type
+        result[:system_type] = @system_type if @system_type
+        result[:weekday_start_time] = @weekday_start_time if @weekday_start_time
+        result[:weekday_duration] = @weekday_duration if @weekday_duration
+        result[:weekend_start_time] = @weekend_start_time if @weekend_start_time
+        result[:weekend_duration] = @weekend_duration if @weekend_duration
+        result[:mixed_type_1] = @mixed_type_1 if @mixed_type_1
+        result[:mixed_type_1_percentage] = @mixed_type_1_percentage if @mixed_type_1_percentage
+        result[:mixed_type_2] = @mixed_type_2 if @mixed_type_2
+        result[:mixed_type_2_percentage] = @mixed_type_2_percentage if @mixed_type_2_percentage
+        result[:mixed_type_3] = @mixed_type_3 if @mixed_type_3
+        result[:mixed_type_3_percentage] = @mixed_type_3_percentage if @mixed_type_3_percentage
+        result[:mixed_type_4] = @mixed_type_4 if @mixed_type_4
+        result[:mixed_type_4_percentage] = @mixed_type_4_percentage if @mixed_type_4_percentage
+        return result 
+      end
+
+
       private
 
       ##
@@ -298,7 +365,7 @@ module URBANopt
             floor_print = URBANopt::GeoJSON::Helper.floor_print_from_polygon(polygon, elevation, origin_lat_lon, runner, zoning)
             if floor_print
               if zoning
-                this_floor_prints = URBANopt::GeoJSON::Zoning.divide_floor_print(floor_print, 4.0, runner)
+                this_floor_prints = URBANopt::GeoJSON::Zoning.divide_floor_print(floor_print, 4.0, runner) 
                 floor_prints.concat(this_floor_prints)
               else
                 floor_prints << floor_print
@@ -308,9 +375,9 @@ module URBANopt
             end
             # Subsequent polygons are holes, and are not supported.
             break
-          end
-        end
-        result = []
+          end 
+        end 
+        spaces = []
         floor_prints.each do |floor_print|
           space = OpenStudio::Model::Space.fromFloorPrint(floor_print, floor_to_floor_height, model)
           if space.empty?
@@ -325,17 +392,22 @@ module URBANopt
                 surface.setOutsideBoundaryCondition('Ground')
               end
             end
-          end
-          building_story = OpenStudio::Model::BuildingStory.new(model)
-          building_story.setName("Building Story #{story_number}")
+          end 
+          spaces << space
+        end 
+        
+        building_story = OpenStudio::Model::BuildingStory.new(model)
+        building_story.setName("Building Story #{story_number}")
+        spaces.each do |space|
           space.setBuildingStory(building_story)
           thermal_zone = OpenStudio::Model::ThermalZone.new(model)
           thermal_zone.setName("Building Story #{story_number} ThermalZone")
           space.setThermalZone(thermal_zone)
-          result << space
-        end
-        return result
+        end 
+        
+        return spaces
       end
-    end
-  end
-end
+    
+    end 
+  end 
+end