urbanopt-scenario 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3225219c08dfe2a6beb6fdf3ed6b26443eef98a
+  data.tar.gz: 97d3cc6a749f80df8b454812b14ddff48634b917
+SHA512:
+  metadata.gz: 7b624a22f243fecceb510cd12eafc0a06856b61b0327e895371a77d16bf2be73d856b94febac2f7b72ab3a9d310db50f724da818979d5c442f217dcca071f619
+  data.tar.gz: 39938a49c4ae3f9ffeb76df9ad07f0f4902a5a3c236c645a3651739e6d97bd58c85f9243cd28c9766489588b3a30b850aefa22ce38f4b7285ac6a9312f63d712

data/.github/CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# URBANopt Contribution Policy
+
+## Version 1.0
+
+The URBANopt team welcomes your contribution to the project. You can contribute to the URBANopt project in several ways: by using the software, reporting issues, contributing documentation, or contributing code back to the project. The GitHub [Contributing to Open Source](https://opensource.guide/how-to-contribute/) guide provides a good overview. If you contribute code, you agree that your contribution may be incorporated into the URBANopt Software Development Kit (SDK) and made available under the URBANopt SDK license.
+
+The contribution process for URBANopt is composed of three steps:
+
+## 1. Send consent email
+
+In order for us to distribute your code as part of URBANopt under the URBANopt SDK [license](https://github.com/urbanopt/urbanopt-scenario-gem/blob/develop/LICENSE.md), we’ll need your consent. An email acknowledging your understanding of these terms and agreeing to them is all that will be asked of any contributor. Send an email to the URBANopt project manager ([see below](#documentation) for the address) including the following text and a list of co-contributors (if any):
+
+*I agree to contribute to the URBANopt SDK. I agree to the following terms and conditions for my contributions: First, I agree that I am licensing the copyright to my contributions under the terms of the current URBANopt SDK license. Second, I hereby grant to Alliance for Sustainable Energy, LLC, to any successor manager and distributor of URBANopt SDK appointed by the U.S. Department of Energy, and to all recipients of a version of URBANopt SDK that includes my contributions, a non-exclusive, worldwide, royalty-free, irrevocable patent license under any patent claims owned by me, or owned by my employer and known to me, that are or will be,necessarily infringed upon by my contributions alone, or by combination of my contributions with the version of URBANopt SDK to which they are contributed, to make, have made, use, offer to sell, sell, import, and otherwise transfer any version of URBANopt SDK that includes my contributions, in source code and object code form. Third, I represent and warrant that I am authorized to make the contributions and grant the foregoing license(s). Additionally, if, to my knowledge, my employer has rights to intellectual property that covers my contributions, I represent and warrant that I have received permission to make these contributions and grant the foregoing license(s) on behalf of my employer.*
+
+Once we have your consent on file, you’ll only need to redo it if conditions change (e.g. a change of employer).
+
+## 2. Scope agreement and timeline commitment
+
+If your contribution is small (e.g. a bug fix), simply submit your contribution via GitHub. If you find a bug, first make sure it is not an already known issue, then report it in the GitHub [issue tracker](https://github.com/urbanopt/urbanopt-scenario-gem/issues) for this repository. If your contribution is larger (e.g. a new feature or new functionality/capability), we’ll need to evaluate your proposed contribution first. We may ask you to revise your materials and make changes to it, which we will then re-review.
+
+## 3. Technical contribution process
+
+We want URBANopt to adhere to our established quality standards. Smaller, non-code contributions may not require as much review as code contributions, but all contributions will be reviewed. Code contributions will initially be in a source control branch, and then will be merged into the official URBANopt repository after review and approval. Any bugs, either discovered by you, us, or any users will be tracked in our issue tracker. We request that you take full responsibility for correcting bugs. Be aware that, unless notified otherwise, the correction of bugs takes precedence over the submission or creation of new code.
+
+### Release Schedule
+
+Contributions should be aligned with the URBANopt release schedule. The URBANopt SDK is currently released publicly two times each year (approximately on the last workday of March and October). There are cutoff dates for when new contributions are allowed for the upcoming release (approximately two weeks before release date). If your contribution is incomplete or comes in past the cutoff date for a release, we reserve the right to hold your code for a later release.
+
+### Coding Standards
+
+Make sure you read and follow the coding standards when writing URBANopt SDK code. Although these standards are not complete or very detailed, they should give you an idea of the style that we would like you to adopt. New additions to the URBANopt SDK must be written using object-oriented programming techniques and practices. Please also look at the URBANopt SDK code itself as an example of the preferred coding style.
+
+### Code Reviews
+
+You will be working and testing your code in a source control branch. When a piece of functionality is complete, tested and working, let us know and we will review your code. If the functionality that you contributed is complex, we may ask you for a written design document as well. We want your code to follow coding standards, be clear, readable, and maintainable, and of course it should do what it is supposed to do. We will look for errors, style issues, comments (or lack thereof), and any other issues in your code. We will inform you of our comments and we expect you to make the recommended changes. New re-reviews may be expected until the code complies with our required processes.
+
+### Unit Tests
+
+We ask that you supply unit tests along with the code that you have written. A unit test is a program that exercises your code in isolation to verify that it does what it is supposed to do. Your unit tests are very important to us. First, they give an indication that your code works according to its intended functionality. Second, we execute your unit tests automatically along with our unit tests to verify that the overall URBANopt SDK code continues to work.
+
+### Code Coverage
+
+We require that your unit tests provide an adequate coverage of the source code you are submitting. You will need to design your unit tests in such a way that all critical parts of the code (at least) are tested and verified.
+
+### Documentation
+
+Proper documentation is crucial for our users, without it users will not know how to use your contribution. We require that you create user documentation so that end users know how to use your new functionality.
+
+For further questions or information:
+
+- Ben Polly\
+URBANopt Project Management\
+ben.polly@nrel.gov\
+(303) 384-7429
+
+URBANopt is funded by the U.S. Department of Energy (DOE) and managed by the National Renewable Energy Laboratory (NREL).
+
+URBANopt is developed in collaboration with NREL, LBNL, and private firms.

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+### Expected behavior
+
+_A clear and concise description of what you expected to happen._
+
+### Actual behavior
+
+_A clear and concise description of what actually happens._
+
+### To Reproduce
+
+Steps to reproduce the behavior:
+
+1. Go to '...'
+1. Enter '...'
+1. Enter '...'
+
+### Additional context
+
+_E.g.: Windows, Mac, Linux? Are you behind a firewall? Do you have additional security constraints?_

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+---
+
+### Is your feature request related to a problem? Please describe
+
+A clear and concise description of what the problem is. _I'm frustred when..._
+
+### Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+### Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+### Additional context
+
+Add any other context or screenshots about the feature request here.

data/.github/pull_request_template.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+Addresses #[issue number here].
+
+## Pull Request Description
+
+[description here]
+
+## Checklist
+
+Not all may apply:
+
+- [ ] Unit tests have been added or updated
+- [ ] Documentation has been modified appropriately
+- [ ] All tests are passing (green) on circleci
+- [ ] The [changelog](https://github.com/urbanopt/urbanopt-scenario-gem/blob/develop/CHANGELOG.md) has been updated appropriately
+- [ ] This branch is up-to-date with master

data/.gitignore

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

data/.rdoc_options

@@ -0,0 +1,36 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+- lib
+charset: UTF-8
+exclude:
+- doc_templates
+- docs
+- lib/measures
+- node_modules
+- spec
+- test
+- Gemfile
+- Gemfile.lock
+- Jenkinsfile
+- LICENSE.md
+- README.md
+- Rakefile
+- urbanopt-scenario-gem.gemspec
+- JSON
+- Object
+hyperlink_all: false
+line_numbers: false
+locale:
+locale_dir: locale
+locale_name:
+main_page: RDOC_MAIN.md
+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,3 @@
+--format documentation
+--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,23 @@
+---
+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
+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   
+  

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# URBANopt Scenario Gem
+ 
+## Version 0.1.1
+
+Date Range: 10/16/19 - 01/14/20
+
+Accepted Pull Requests:
+- Fixed [#34]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/34 ), Post process
+- Fixed [#44]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/44 ), reopt integrations
+- Fixed [#47]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/47 ), Use runner.conf for run options
+- Fixed [#48]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/48 ), Bump mixin-deep from 1.3.1 to 1.3.2 in /docs
+- Fixed [#49]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/49 ), Bump lodash from 4.17.11 to 4.17.15 in /docs
+- Fixed [#50]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/50 ), Bump lodash.template from 4.4.0 to 4.5.0 in /docs
+- Fixed [#51]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/51 ), Der
+- Fixed [#61]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/61 ), GitHub security
+- Fixed [#62]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/62 ), Update issue templates
+- Fixed [#64]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/64 ), update dependency versions for security
+
+## Version 0.1.0

data/Gemfile

@@ -0,0 +1,43 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in urbanopt-scenario-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']
+
+# Uncomment the extension and common measures gem if you need to test local development versions. Otherwise
+# these are included in the model articulation gem.
+#
+# 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?('../openstudio-common-measures-gem')
+#   gem 'openstudio-common-measures', path: '../openstudio-common-measures-gem'
+# elsif allow_local
+#   gem 'openstudio-common-measures', github: 'NREL/openstudio-common-measures-gem', branch: 'develop'
+# end
+
+if allow_local && File.exist?('../openstudio-model-articulation-gem')
+  gem 'openstudio-model-articulation', path: '../openstudio-model-articulation-gem'
+elsif allow_local
+  gem 'openstudio-model-articulation', github: 'NREL/openstudio-model-articulation-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'
+# gem 'rdoc'

data/Jenkinsfile

@@ -0,0 +1,10 @@
+//Jenkins pipelines are stored in shared libaries. 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-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.

data/RDOC_MAIN.md

@@ -0,0 +1,39 @@
+# URBANopt Scenario Gem
+
+### [back to main docs](../)
+
+The URBANopt Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results. User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files. A ScenarioRunner is used to perform simulations for each SimulationDir. Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.
+
+[RDoc Documentation](https://urbanopt.github.io/urbanopt-scenario-gem/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'urbanopt-scenario'
+```
+
+And then execute:
+
+    $ bundle install
+    $ bundle update
+
+Or install it yourself as:
+
+    $ gem install 'urbanopt-scenario'
+
+## Testing
+
+Check out the repository and then execute:
+
+    $ bundle install
+    $ bundle update    
+    $ bundle exec rake
+    
+## Releasing
+
+* Update change log
+* Update version in `/lib/urbanopt/scenario/version.rb`
+* Merge down to master
+* run `rake release` from master

data/README.md

@@ -0,0 +1,39 @@
+# URBANopt Scenario Gem 
+
+The URBANopt Scenario Gem includes functionality for defining scenarios, running simulations, and post-processing results. User defined SimulationMapper classes translate each Feature to a SimulationDir which is a directory containing simulation input files. A ScenarioRunner is used to perform simulations for each SimulationDir. Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.
+
+[RDoc Documentation](https://urbanopt.github.io/urbanopt-scenario-gem/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'urbanopt-scenario'
+```
+
+And then execute:
+
+    $ bundle install
+    $ bundle update
+
+Or install it yourself as:
+
+    $ gem install 'urbanopt-scenario'
+
+## Testing
+
+Check out the repository and then execute:
+
+    $ bundle install
+    $ bundle update    
+    $ bundle exec rake
+    
+## Releasing
+
+* Update CHANGELOG.md
+* Run `rake rubocop:auto_correct`
+* Update version in `/lib/urbanopt/scenario/version.rb`
+* Create PR to master, after tests and reviews complete, then merge
+* Locally - from the master branch, run `rake release`
+* On GitHub, go to the releases page and update the latest release tag. Name it “Version x.y.z” and copy the CHANGELOG entry into the description box.

data/Rakefile

@@ -0,0 +1,51 @@
+# *********************************************************************************
+# 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/scenario'
+rake_task = OpenStudio::Extension::RakeTask.new
+rake_task.set_extension_class(URBANopt::Scenario::Extension)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task :clear_all do
+  Dir.glob(File.join(File.dirname(__FILE__), '/spec/test/example_scenario/*')).each do |f|
+    FileUtils.rm_rf(f)
+  end
+end
+
+task default: :spec