urbanopt-geojson 0.1.0

data/docs/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "urbanopt-geojson-gem-docs",
+  "version": "0.0.1",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "dev": "vuepress dev",
+    "build": "vuepress build",
+    "deploy": "gh-pages -d .vuepress/dist"
+  },
+  "author": "Brian Schiller",
+  "dependencies": {
+    "highlight.js": "^9.15.6",
+    "json-schema-ref-parser": "^6.1.0",
+    "json-schema-view-js": "git+https://git@github.com/bgschiller/json-schema-view-js.git",
+    "vuepress": "^0.14.10",
+    "webpack-dev-middleware": "^3.6.0"
+  },
+  "devDependencies": {
+    "gh-pages": "^2.0.1"
+  }
+}

data/docs/schemas/building-properties.md

@@ -0,0 +1,3 @@
+# Building Properties
+
+<BuildingProperties />

data/docs/schemas/district-system-properties.md

@@ -0,0 +1,3 @@
+# District System Properties
+
+<DistrictSystemProperties />

data/docs/schemas/electrical-connector-properties.md

@@ -0,0 +1,3 @@
+# Electrical Connector Properties
+
+<ElectricalConnectorProperties />

data/docs/schemas/electrical-junction-properties.md

@@ -0,0 +1,3 @@
+# Electrical Junction Properties
+
+<ElectricalJunctionProperties />

data/docs/schemas/region-properties.md

@@ -0,0 +1,3 @@
+# Region Properties
+
+<RegionProperties />

data/docs/schemas/site-properties.md

@@ -0,0 +1,3 @@
+# Site Properties
+
+<SiteProperties />

data/docs/schemas/thermal-connector-properties.md

@@ -0,0 +1,3 @@
+# Thermal Connector Properties
+
+<ThermalConnectorProperties />

data/docs/schemas/thermal-junction-properties.md

@@ -0,0 +1,3 @@
+# Thermal Junction Properties
+
+<ThermalJunctionProperties />

data/lib/measures/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+    - 'spec/test_measures/**/*'
+inherit_from:
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop.yml

data/lib/measures/urban_geometry_creation/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/README.md

@@ -0,0 +1,48 @@
+
+
+###### (Automatically generated documentation)
+
+# UrbanGeometryCreation
+
+## 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/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/measure.rb

@@ -0,0 +1,199 @@
+# *********************************************************************************
+# 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 'json'
+require 'net/http'
+require 'uri'
+require 'urbanopt/geojson'
+
+# start the measure
+class UrbanGeometryCreation < OpenStudio::Measure::ModelMeasure
+  attr_accessor :origin_lat_lon
+
+  # human readable name
+  def name
+    return 'UrbanGeometryCreation'
+  end
+
+  # human readable description
+  def description
+    return 'This measure reads an URBANopt GeoJSON and creates geometry for a particular building.  Surrounding buildings are included as shading structures.'
+  end
+
+  # human readable description of modeling approach
+  def modeler_description
+    return 'This measure takes in the GeoJSON file, the feature_id of the building and the surrounding buildings as arguments and add has methods to create space types and add default construction sets.'
+  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 = all_features.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(:space_per_floor, model, @origin_lat_lon, @runner)
+      if spaces.nil?
+        @runner.registerError("Failed to create spaces for building '#{name}'")
+        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
+UrbanGeometryCreation.new.registerWithApplication

data/lib/measures/urban_geometry_creation/measure.xml

@@ -0,0 +1,139 @@
+<measure>
+  <schema_version>3.0</schema_version>
+  <name>urban_geometry_creation</name>
+  <uid>5ab85d6b-c9af-4361-8ab9-613ee99a5666</uid>
+  <version_id>0808dbbe-ec8a-46c7-b416-cbae39e2b06c</version_id>
+  <version_modified>20190523T021410Z</version_modified>
+  <xml_checksum>D254E772</xml_checksum>
+  <class_name>UrbanGeometryCreation</class_name>
+  <display_name>UrbanGeometryCreation</display_name>
+  <description>This measure reads an URBANopt GeoJSON and creates geometry for a particular building.  Surrounding buildings are included as shading structures.</description>
+  <modeler_description></modeler_description>
+  <arguments>
+    <argument>
+      <name>geojson_file</name>
+      <display_name>GeoJSON File</display_name>
+      <description>GeoJSON File.</description>
+      <type>String</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>feature_id</name>
+      <display_name>Feature ID</display_name>
+      <description>Feature ID.</description>
+      <type>String</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+    </argument>
+    <argument>
+      <name>surrounding_buildings</name>
+      <display_name>Surrounding Buildings</display_name>
+      <description>Select which surrounding buildings to include.</description>
+      <type>Choice</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>ShadingOnly</default_value>
+      <choices>
+        <choice>
+          <value>None</value>
+          <display_name>None</display_name>
+        </choice>
+        <choice>
+          <value>ShadingOnly</value>
+          <display_name>ShadingOnly</display_name>
+        </choice>
+        <choice>
+          <value>All</value>
+          <display_name>All</display_name>
+        </choice>
+      </choices>
+    </argument>
+  </arguments>
+  <outputs/>
+  <provenances/>
+  <tags>
+    <tag>Envelope.Form</tag>
+  </tags>
+  <attributes>
+    <attribute>
+      <name>Measure Type</name>
+      <value>ModelMeasure</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Apply Measure Now</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>OpenStudio Application</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Parametric Analysis Tool</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Analysis Spreadsheet</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>Model Articulation</value>
+      <datatype>string</datatype>
+    </attribute>
+  </attributes>
+  <files>
+    <file>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>D339FA87</checksum>
+    </file>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>B646B327</checksum>
+    </file>
+    <file>
+      <filename>nrel_stm_footprints.geojson</filename>
+      <filetype>geojson</filetype>
+      <usage_type>test</usage_type>
+      <checksum>21E06908</checksum>
+    </file>
+    <file>
+      <filename>shadowed_tests.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>53A7DD48</checksum>
+    </file>
+    <file>
+      <filename>urban_geometry_creation_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>B55E2F27</checksum>
+    </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>1.9.0</identifier>
+        <min_compatible>1.9.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>E152B533</checksum>
+    </file>
+  </files>
+</measure>