urbanopt-geojson 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2afe9730a81071fc7bcf3a584298c6771d3d4766
+  data.tar.gz: 48a7b0ec274e3f6494d5855e75ab3c74caf8d5c4
+SHA512:
+  metadata.gz: 332c02871d7688938821dcfdcadef5181a2305b0b5e2fefef31d6332ea57ee4dff21009f7cd469843c1b30e2280b44422cf86820b4f1e4ff1e590d06d3418caf
+  data.tar.gz: d98d982d60a8242eaee9007bf7e7944c7b7014edc994ce4c2efb480e7a102cd3fe2100d5eed2843e74e46947e89ae8ad3f545fcbb515cd88e4e25b4c5d7ace1d

data/.gitignore

@@ -0,0 +1,24 @@
+/.bundle/
+/.yardoc
+/.ruby-version
+/Gemfile.lock
+/gems
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test/
+/lib/measures/test_results
+/lib/measures/*/tests/output
+out.txt
+.rubocop*s3*
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore IDE files
+/.idea
+.DS_Store
+urbanopt-geojson-*.gem

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake" /></Settings>

data/.rdoc_options

@@ -0,0 +1,43 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+- lib
+charset: UTF-8
+exclude:
+- docs
+- node_modules
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- Jenkinsfile
+- README.md
+- !ruby/regexp /(copyright)/
+- !ruby/regexp /(\.css)/
+- !ruby/regexp /(\.erb)/
+- !ruby/regexp /(\.html)/
+- !ruby/regexp /(\.geojson)/
+- !ruby/regexp /(\.json)/
+- !ruby/regexp /(\.js)/
+- !ruby/regexp /(\.osw)/
+- !ruby/regexp /(\.osw.out)/
+- !ruby/regexp /(\.osm)/
+- !ruby/regexp /(\.xml)/
+- !ruby/regexp /(lib\/measures)/
+- urbanopt-geojson-gem.gemspec
+hyperlink_all: false
+line_numbers: false
+locale:
+locale_dir: locale
+locale_name:
+main_page: RDOC_MAIN.md
+#markup: markdown
+output_decoration: true
+op_dir: ./docs/.vuepress/public/rdoc
+show_hash: false
+tab_width: 8
+template_stylesheets: ["./docs/.vuepress/public/custom_rdoc_styles.css"]
+title:
+visibility: :protected
+webcvs:

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  Exclude:
+    - gems/**/*
+    - measures/**/*
+    - spec/files/**/measures/**/*
+
+
+inherit_from:
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop.yml
+

data/.travis.yml

@@ -0,0 +1,35 @@
+---
+sudo: false
+language: ruby
+#cache: bundler
+rvm:
+  - 2.2.4
+matrix:
+  include:
+  - env: OPENSTUDIO_VERSION=2.7.0 && OPENSTUDIO_SHA=544f363db5 && RUBYLIB=/usr/local/openstudio-2.7.0/Ruby:/usr/Ruby
+before_install:
+  - gem install bundler -v '1.17'
+  - gem install bundler -v '~> 1.17'
+install:
+  - bundle install
+  - bash -c 'cd docs && npm i'
+before_script:
+  - curl -sLO https://raw.githubusercontent.com/NREL/OpenStudio-server/develop/docker/deployment/scripts/install_openstudio.sh
+  - chmod +x install_openstudio.sh
+  - sudo ./install_openstudio.sh $OPENSTUDIO_VERSION $OPENSTUDIO_SHA
+  - sudo ./install_openstudio.sh $OPENSTUDIO_VERSION $OPENSTUDIO_SHA
+script:
+  - bundle exec rake
+  - bundle exec rake openstudio:list_measures
+  - bundle exec rake openstudio:update_measures
+  - bundle exec rake openstudio:test_with_openstudio
+  - bundle exec rake
+  - bundle exec rdoc
+  - bash -c 'cd docs && npm run build'
+deploy:
+  provider: pages
+  local-dir: docs/.vuepress/dist
+  skip-cleanup: true
+  github-token: $GITHUB_TOKEN
+  on:
+    branch: master

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# URBANopt GeoJSON Gem
+ 
+## Version 0.1.0 
+
+* Initial release of the URBANopt GeoJSON Gem

data/Gemfile

@@ -0,0 +1,27 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in urbanopt-geojson-gem.gemspec
+gemspec
+
+# Local gems are useful when developing and integrating the various dependencies.
+# To favor the use of local gems, set the following environment variable:
+#   Mac: export FAVOR_LOCAL_GEMS=1
+#   Windows: set FAVOR_LOCAL_GEMS=1
+# Note that if allow_local is true, but the gem is not found locally, then it will
+# checkout the latest version (develop) from github.
+allow_local = ENV['FAVOR_LOCAL_GEMS']
+
+if allow_local && File.exist?('../OpenStudio-extension-gem')
+  gem 'openstudio-extension', path: '../OpenStudio-extension-gem'
+elsif allow_local
+  gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'develop'
+end
+
+if allow_local && File.exist?('../urbanopt-core-gem')
+  gem 'urbanopt-core', path: '../urbanopt-core-gem'
+elsif allow_local
+  gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'develop'
+end
+
+# simplecov has an unnecessary dependency on native json gem, use fork that does not require this
+gem 'simplecov', github: 'NREL/simplecov'

data/Jenkinsfile

@@ -0,0 +1,10 @@
+//Jenkins pipelines are stored in shared libraries. Please see: https://github.com/tijcolem/nrel_cbci_jenkins_libs 
+ 
+@Library('cbci_shared_libs') _
+
+// Build for PR to develop branch only. 
+if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) { // check if set
+
+  openstudio_extension_gems()
+    
+}

data/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/RDOC_MAIN.md

@@ -0,0 +1,48 @@
+# UrbanOpt GeoJSON Gem
+
+### [back to main docs](../)
+
+The URBANopt GeoJSON Gem has been developed by restructuring methods extracted from the
+[urban_geometry_creation](https://github.com/NREL/openstudio-urban-measures/tree/develop/measures/urban_geometry_creation)
+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: 
+
+- geojson.rb : Base gem file that imports all modules and classes. 
+- extension.rb : The extension class inherits from OpenStudio::Extension::Extension, and
+  overrides the following methods as needed -
+    - _measures_dir_
+    - _files_dir_
+    - _doc_templates_dir_
+- Gemfile and .gemspec : Describe the extension dependencies on other gems. 
+- Classes and Modules within +lib/urbanopt/geojson+ -
+
+
+    *Modules that do not require instances for calling the methods:*
+
+    - URBANopt::GeoJSON::Helper : Contains methods extracted from the two measures to
+      perform utility-like tasks like - +is_shaded+ and +is_shadowed+.
+    - URBANopt::GeoJSON::Zoning : Contains methods extracted from
+      +urban_geometry_creation_zoning+ .
+    - URBANopt::GeoJSON::Model : Contains methods that perform tasks on an instance of
+      +OpenStudio::Model::Model+. 
+
+    *Classes and subclasses that contain instance-dependant methods and private methods
+    that perform tasks on the given feature.*
+
+    - URBANopt::GeoJSON::GeoFile : Contains a +get_feature+ method that returns an
+      instance of a Feature Subclass for the the feature type. Also contains methods to validate the GeoJSON
+      file against the GeoJSON schema. 
+    - URBANopt::GeoJSON::Feature : Contains methods to return +feature+ +id+ , +name+ ,
+      +multiple+ +polygons+ +coordinates+ which are inherited by classes for all feature types.
+    - URBANopt::GeoJSON::Building : A subclass of Feature, contains class methods that
+      are specific to handling features of the Building type. 
+    - URBANopt::GeoJSON::DistrictSystem : A subclass of Feature, contains class methods
+      that are specific to handling features of District System type. *Note: This subclass does not contain any methods yet*. 

data/README.md

@@ -0,0 +1,40 @@
+# URBANopt GeoJSON Gem
+
+Library and measures to translate URBANopt GeoJSON format to OpenStudio. See the [developer documentation](https://urbanopt.github.io/urbanopt-geojson-gem/) for more details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'urbanopt-geojson'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install 'urbanopt-geojson'
+
+## Usage
+
+The URBANopt GeoJSON Gem is an OpenStudio Extension Gem with functionality to translate
+information in a GeoJSON format to energy model inputs. GeoJSON is a commonly used format
+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.
+* Translate Building Feature to OpenStudio Shading Objects.
+
+# Releasing
+
+* Update change log
+* Update version in `/lib/urbanopt/geojson/version.rb`
+* Merge down to master
+* Release via github
+* run `rake release` from master

data/Rakefile

@@ -0,0 +1,45 @@
+# *********************************************************************************
+# 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 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+# Load in the rake tasks from the base extension gem
+require 'openstudio/extension/rake_task'
+require 'urbanopt/geojson'
+rake_task = OpenStudio::Extension::RakeTask.new
+rake_task.set_extension_class(URBANopt::GeoJSON::Extension)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: :spec

data/deploy_docs.sh

@@ -0,0 +1,4 @@
+set -e
+bundle exec rdoc --template-stylesheets ./docs/.vuepress/public/custom_rdoc_styles.css
+npm run build --prefix docs
+npm run deploy --prefix docs

data/doc_templates/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/doc_templates/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/doc_templates/copyright_erb.txt

@@ -0,0 +1,31 @@
+<%
+  # *********************************************************************************
+  # 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.
+  # *********************************************************************************
+%>