urbanopt-geojson 0.1.0

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

@@ -0,0 +1,80 @@
+# *********************************************************************************
+# 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 'openstudio'
+require 'openstudio/ruleset/ShowRunnerOutput'
+require 'urbanopt/geojson'
+require 'minitest/autorun'
+require_relative '../measure.rb'
+require 'fileutils'
+
+class UrbanGeometryCreationTest < MiniTest::Unit::TestCase
+  def test_shadowed_case
+    denver_zoo = OpenStudio::PointLatLon.new(39.749242, -104.951024, 0)
+    blocky = [
+      OpenStudio::Point3d.new(0, 0, 2),
+      OpenStudio::Point3d.new(2, 0, 2),
+      OpenStudio::Point3d.new(2, 2, 2),
+      OpenStudio::Point3d.new(0, 2, 2),
+      OpenStudio::Point3d.new(0, 0, 2)
+    ]
+    rector = [
+      OpenStudio::Point3d.new(2.7, 4.4, 1),
+      OpenStudio::Point3d.new(4.7, 4.4, 1),
+      OpenStudio::Point3d.new(4.7, 8.4, 1),
+      OpenStudio::Point3d.new(2.7, 8.4, 1),
+      OpenStudio::Point3d.new(2.7, 4.4, 1)
+    ]
+
+    blocky_shadows_rector = URBANopt::GeoJSON::Helper.is_shadowed(rector, blocky, denver_zoo)
+    assert blocky_shadows_rector, 'Expected blocky to shadow the rector'
+  end
+
+  def test_flat_blocky_does_not_shadow
+    denver_zoo = OpenStudio::PointLatLon.new(39.749242, -104.951024, 0)
+    blocky = [
+      OpenStudio::Point3d.new(0, 0, 0),
+      OpenStudio::Point3d.new(2, 0, 0),
+      OpenStudio::Point3d.new(2, 2, 0),
+      OpenStudio::Point3d.new(0, 2, 0),
+      OpenStudio::Point3d.new(0, 0, 0)
+    ]
+    rector = [
+      OpenStudio::Point3d.new(2.7, 4.4, 1),
+      OpenStudio::Point3d.new(4.7, 4.4, 1),
+      OpenStudio::Point3d.new(4.7, 8.4, 1),
+      OpenStudio::Point3d.new(2.7, 8.4, 1),
+      OpenStudio::Point3d.new(2.7, 4.4, 1)
+    ]
+
+    blocky_shadows_rector = URBANopt::GeoJSON::Helper.is_shadowed(rector, blocky, denver_zoo)
+    assert !blocky_shadows_rector, 'Expected blocky at 0m tall not to shadow the rector'
+  end
+end

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

@@ -0,0 +1,143 @@
+# *********************************************************************************
+# 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 'openstudio'
+require 'openstudio/ruleset/ShowRunnerOutput'
+require 'urbanopt/geojson'
+require 'minitest/autorun'
+require_relative '../measure.rb'
+require 'fileutils'
+
+class UrbanGeometryCreationTest < MiniTest::Unit::TestCase
+  def test_one_building
+    # create an instance of the measure
+    measure = UrbanGeometryCreation.new
+    # create an empty model
+    model = OpenStudio::Model::Model.new
+
+    # create an instance of a runner
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+
+    geojson_file = File.absolute_path(File.join(File.dirname(__FILE__), 'nrel_stm_footprints.geojson'))
+
+    feature_id = '59a9ce2b42f7d007c059d2ee' # Energy Systems Integration Facility
+
+    surrounding_buildings = 'None'
+    # surrounding_buildings = "ShadingOnly"
+    # surrounding_buildings = "All"
+
+    # get arguments
+    arguments = measure.arguments(model)
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+
+    # create hash of argument values.
+    # If the argument has a default that you want to use, you don't need it in the hash
+    args_hash = {}
+    args_hash['geojson_file'] = geojson_file
+    args_hash['feature_id'] = feature_id
+    args_hash['surrounding_buildings'] = surrounding_buildings
+
+    # populate argument with specified hash value if specified
+    arguments.each do |arg|
+      temp_arg_var = arg.clone
+      if args_hash[arg.name]
+        assert(temp_arg_var.setValue(args_hash[arg.name]))
+      end
+      argument_map[arg.name] = temp_arg_var
+    end
+
+    # run the measure
+    measure.run(model, runner, argument_map)
+    result = runner.result
+
+    # save the model to test output directory
+    output_file_path = OpenStudio::Path.new(File.dirname(__FILE__) + "/output/#{feature_id}.osm")
+    model.save(output_file_path, true)
+
+    # show the output
+    show_output(result)
+
+    # assert that it ran correctly
+    assert_equal('Success', result.value.valueName)
+  end
+
+  def test_one_building_w_surrounding_buildings
+    # create an instance of the measure
+    measure = UrbanGeometryCreation.new
+
+    # create an empty model
+    model = OpenStudio::Model::Model.new
+
+    # create an instance of a runner
+    runner = OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new)
+
+    geojson_file = File.absolute_path(File.join(File.dirname(__FILE__), 'nrel_stm_footprints.geojson'))
+
+    feature_id = '59a9ce2b42f7d007c059d2f0' # Education Center
+
+    # surrounding_buildings = "None"
+    surrounding_buildings = 'ShadingOnly'
+    # surrounding_buildings = "All"
+
+    # get arguments
+    arguments = measure.arguments(model)
+    argument_map = OpenStudio::Measure.convertOSArgumentVectorToMap(arguments)
+
+    # create hash of argument values.
+    # If the argument has a default that you want to use, you don't need it in the hash
+    args_hash = {}
+    args_hash['geojson_file'] = geojson_file
+    args_hash['feature_id'] = feature_id
+    args_hash['surrounding_buildings'] = surrounding_buildings
+
+    # populate argument with specified hash value if specified
+    arguments.each do |arg|
+      temp_arg_var = arg.clone
+      if args_hash[arg.name]
+        assert(temp_arg_var.setValue(args_hash[arg.name]))
+      end
+      argument_map[arg.name] = temp_arg_var
+    end
+
+    # run the measure
+    measure.run(model, runner, argument_map)
+    result = runner.result
+
+    # save the model to test output directory
+    output_file_path = OpenStudio::Path.new(File.dirname(__FILE__) + "/output/#{feature_id}.osm")
+    model.save(output_file_path, true)
+
+    # show the output
+    show_output(result)
+
+    # assert that it ran correctly
+    assert_equal('Success', result.value.valueName)
+  end
+end

data/lib/measures/urban_geometry_creation_zoning/LICENSE.md

@@ -0,0 +1,27 @@
+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.

data/lib/measures/urban_geometry_creation_zoning/README.md

@@ -0,0 +1,48 @@
+
+
+###### (Automatically generated documentation)
+
+# UrbanGeometryCreationZoning
+
+## Description
+This measure reads an URBANopt GeoJSON and creates geometry for a particular building.  Surrounding buildings are included as shading structures.
+
+## Modeler Description
+
+
+## Measure Type
+ModelMeasure
+
+## Taxonomy
+
+
+## Arguments
+
+
+### GeoJSON File
+GeoJSON File.
+**Name:** geojson_file,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Feature ID
+Feature ID.
+**Name:** feature_id,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Surrounding Buildings
+Select which surrounding buildings to include.
+**Name:** surrounding_buildings,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+
+

data/lib/measures/urban_geometry_creation_zoning/README.md.erb

@@ -0,0 +1,42 @@
+<%#= README.md.erb is used to auto-generate README.md. %>
+<%#= To manually maintain README.md throw away README.md.erb and manually edit README.md %>
+###### (Automatically generated documentation)
+
+# <%= name %>
+
+## Description
+<%= description %>
+
+## Modeler Description
+<%= modelerDescription %>
+
+## Measure Type
+<%= measureType %>
+
+## Taxonomy
+<%= taxonomy %>
+
+## Arguments
+
+<% arguments.each do |argument| %>
+### <%= argument[:display_name] %>
+<%= argument[:description] %>
+**Name:** <%= argument[:name] %>,
+**Type:** <%= argument[:type] %>,
+**Units:** <%= argument[:units] %>,
+**Required:** <%= argument[:required] %>,
+**Model Dependent:** <%= argument[:model_dependent] %>
+<% end %>
+
+<% if arguments.size == 0 %>
+<%= "This measure does not have any user arguments" %>
+<% end %>
+
+<% if outputs.size > 0 %>
+## Outputs
+<% output_names = [] %>
+<% outputs.each do |output| %>
+<% output_names << output[:display_name] %>
+<% end %>
+<%= output_names.join(", ") %>
+<% end %>

data/lib/measures/urban_geometry_creation_zoning/measure.rb

@@ -0,0 +1,203 @@
+# *********************************************************************************
+# 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.
+# *********************************************************************************
+
+# see the URL below for information on how to write OpenStudio measures
+# http://nrel.github.io/OpenStudio-user-documentation/measures/measure_writing_guide/
+
+require 'json'
+require 'net/http'
+require 'uri'
+require 'openssl'
+require 'urbanopt/geojson'
+
+# start the measure
+class UrbanGeometryCreationZoning < OpenStudio::Measure::ModelMeasure
+  attr_accessor :origin_lat_lon
+
+  # human readable name
+  def name
+    return 'UrbanGeometryCreationZoning'
+  end
+
+  # human readable description
+  def description
+    return 'This measure reads an URBANopt GeoJSON and creates geometry with zoning for a particular building.  Surrounding buildings are included as shading structures.'
+  end
+
+  # human readable description of modeling approach
+  def modeler_description
+    return ''
+  end
+
+  def arguments(model)
+    args = OpenStudio::Measure::OSArgumentVector.new
+    # geojson file
+    geojson_file = OpenStudio::Measure::OSArgument.makeStringArgument('geojson_file', true)
+    geojson_file.setDisplayName('GeoJSON File')
+    geojson_file.setDescription('GeoJSON File.')
+    args << geojson_file
+    # feature id of the building to create
+    feature_id = OpenStudio::Measure::OSArgument.makeStringArgument('feature_id', true)
+    feature_id.setDisplayName('Feature ID')
+    feature_id.setDescription('Feature ID.')
+    args << feature_id
+    # which surrounding buildings to include
+    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.')
+    surrounding_buildings.setDefaultValue('ShadingOnly')
+    args << surrounding_buildings
+    return args
+  end
+
+  # define what happens when the measure is run
+  def run(model, runner, user_arguments)
+    super(model, runner, user_arguments)
+    # use the built-in error checking
+    if !runner.validateUserArguments(arguments(model), user_arguments)
+      return false
+    end
+
+    # assign the user inputs to variables
+    geojson_file = runner.getStringArgumentValue('geojson_file', user_arguments)
+    feature_id = runner.getStringArgumentValue('feature_id', user_arguments)
+    surrounding_buildings = runner.getStringArgumentValue('surrounding_buildings', user_arguments)
+
+    default_construction_set = URBANopt::GeoJSON::Model.create_construction_set(model, runner)
+
+    stories = []
+    model.getBuildingStorys.each { |story| stories << story }
+    stories.sort! { |x, y| x.nominalZCoordinate.to_s.to_f <=> y.nominalZCoordinate.to_s.to_f }
+
+    space_types = URBANopt::GeoJSON::Helper.create_space_types(stories, model, runner)
+
+    # delete the previous building
+    model.getBuilding.remove
+
+    # create new building and transfer default construction set
+    model.getBuilding.setDefaultConstructionSet(default_construction_set)
+
+    # instance variables
+    @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)
+
+    # EXPOSE NAME
+    name = feature.feature_json[:properties][:name]
+    model.getBuilding.setName(name)
+
+    # find min and max x coordinate
+    @origin_lat_lon = feature.create_origin_lat_lon(@runner)
+
+    site = model.getSite
+    site.setLatitude(@origin_lat_lon.lat)
+    site.setLongitude(@origin_lat_lon.lon)
+
+    begin
+      surface_elevation = feature.surface_elevation.to_f
+      surface_elevation = OpenStudio.convert(surface_elevation, 'ft', 'm').get
+      site.setElevation(surface_elevation)
+    rescue StandardError
+      @runner.registerWarning("Surface elevation not set for building '#{name}'")
+    end
+
+    if feature.type == 'Building'
+      # make requested building
+      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}")
+        return false
+      end
+
+      # DLM: temp hack
+      building_type = feature.building_type
+      if building_type == 'Vacant'
+        shading_surfaces = URBANopt::GeoJSON::Helper.create_shading_surfaces(feature, model, @origin_lat_lon, @runner, spaces)
+      end
+
+      # make other buildings to convert to shading
+      convert_to_shades = []
+      if surrounding_buildings == 'ShadingOnly'
+        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|
+        convert_to_shades.each do |other_space|
+          space.intersectSurfaces(other_space)
+        end
+      end
+
+      # match surfaces
+      @runner.registerInfo('Matching surfaces')
+      all_spaces = OpenStudio::Model::SpaceVector.new
+      model.getSpaces.each do |space|
+        all_spaces << space
+      end
+      OpenStudio::Model.matchSurfaces(all_spaces)
+
+      # make windows
+      spaces = feature.create_windows(spaces)
+
+      # change adjacent surfaces to adiabatic
+      model = URBANopt::GeoJSON::Model.change_adjacent_surfaces_to_adiabatic(model, @runner)
+
+      # convert other buildings to shading surfaces
+      convert_to_shades.map do |space|
+        URBANopt::GeoJSON::Helper.convert_to_shading_surface_group(space)
+      end
+
+    elsif feature.type == 'District System'
+      district_system_type = feature[:properties][:district_system_type]
+      if district_system_type == 'Community Photovoltaic'
+        shading_surfaces = URBANopt::GeoJSON::Helper.create_photovoltaics(feature, 0, model, @origin_lat_lon, @runner)
+      end
+    else
+      @runner.registerError("Unknown feature type '#{feature.type}'")
+      return false
+    end
+
+    # transfer data from previous model
+    stories = URBANopt::GeoJSON::Model.transfer_prev_model_data(model, space_types)
+
+    return true
+  end
+end
+
+# register the measure to be used by the application
+UrbanGeometryCreationZoning.new.registerWithApplication