urbanopt-scenario 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa105156f00e1e346655b0fb8ab67d7382e605cf46a7b15d12649de1c01e6be0
-  data.tar.gz: 5e46ec0982045197a85b4b88e84c8977a0ddb271eec910583e56c689993327ab
+  metadata.gz: 045ec14ad4bee6bc8f6f4e98752283e6e05984eb2065a1d010e34e4a65f2bdd8
+  data.tar.gz: cc078b87253bc6e07f1a250294b733502f076af6fe82abfa703c5330da421b08
 SHA512:
-  metadata.gz: c40716ebc14e8333194cecbd85361539093384b3e5b0e4ac03e2ad68608ff470c55f9a28103a70cf9fe477d6d5b3b114651cd51ed50a335269c94521e0b55ade
-  data.tar.gz: ea570aff4053398037934a0eaa01c18bddfcb1738794af5da7c0314389721e08b9c764c1bf4690175845314914666489f7c1846f32957b2c9e859610e779681e
+  metadata.gz: 26ad4b20871547310a4b5114c73563f69e2df92270dea95e0a340151e29580e09254ae91992c32790a1bf7fb1dd794ecf4b92d6a19972eb3e48bd00388c1b1f5
+  data.tar.gz: 03c29f502d554e30d0e8158aa95c7ba8081ae839f825797a90c3c8b057318c8f15c12044bc63f2610682d55b58200d4b5bfacd72e0b8a97b8b583a48e27355a4

data/.github/workflows/nightly_build.yml

@@ -0,0 +1,40 @@
+
+name: nightly_build
+
+on:
+  # push:
+  schedule:
+    # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
+    # 5 am UTC (11pm MDT the day before) every weekday night in MDT
+    - cron: '21 5 * * 2-6'
+
+# Cancels an existing job (of the same workflow) if it is still running
+# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-only-cancel-in-progress-jobs-or-runs-for-the-current-workflow
+# concurrency:
+#   group: ${{ github.workflow }}-${{ github.ref }}
+#   cancel-in-progress: true
+
+env:
+  # This env var should enforce develop branch of all dependencies
+  FAVOR_LOCAL_GEMS: true
+  GEM_DEVELOPER_KEY: ${{ secrets.GEM_DEVELOPER_KEY }}
+
+jobs:
+  weeknight-tests:
+    # Pinned to `ubuntu-20.04`. When ubuntu-latest adopts 22.04 it would break for us since 22 only supports Ruby 3.1
+    # https://github.com/ruby/setup-ruby#supported-platforms
+    runs-on: ubuntu-20.04
+    container:
+      image: docker://nrel/openstudio:3.4.0
+    steps:
+      - uses: actions/checkout@v3
+      - name: Update gems
+        run: bundle update
+      - name: Run Rspec
+        run: bundle exec rspec
+      # coveralls action docs: https://github.com/marketplace/actions/coveralls-github-action
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: "./coverage/lcov/urbanopt-scenario-gem.lcov"

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # URBANopt Scenario Gem
 
+## Version 0.9.0
+
+Date Range: 05/11/22 - 12/05/22
+
+- Update dependencies for OpenStudio 3.5.0
+- Fixed [#246]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/246 ), Code coverage reporting
+- Fixed [#250]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/250 ), Add reports for DISCO results
+- Fixed [#252]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/252 ), Process QAQC flags into visualization js files
+
+## Version 0.8.0
+
+Date Range: 11/23/21 - 05/10/22
+
+- Fixed [#225]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/225 ), fix dependencies
+- Fixed [#226]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/226 ), Bump node-forge from 0.10.0 to 1.0.0 in /docs
+- Fixed [#228]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/228 ), expanding opendss reporting
+- Fixed [#229]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/229 ), Bump follow-redirects from 1.14.1 to 1.14.8 in /docs
+- Fixed [#230]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/230 ), Bump nanoid from 3.1.23 to 3.3.0 in /docs
+- Fixed [#231]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/231 ), Bump url-parse from 1.5.1 to 1.5.7 in /docs
+- Fixed [#232]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/232 ), remove scenario-file (as a whole) from checks to re-run datapoints
+- Fixed [#233]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/233 ), Bump prismjs from 1.23.0 to 1.27.0 in /docs
+- Fixed [#234]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/234 ), Bump url-parse from 1.5.1 to 1.5.10 in /docs
+- Fixed [#235]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/235 ), Renewable pct
+- Fixed [#236]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/236 ), Bump nanoid from 3.1.23 to 3.3.1 in /docs
+- Fixed [#237]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/237 ), Bump follow-redirects from 1.14.1 to 1.14.9 in /docs
+- Fixed [#238]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/238 ), Bump node-forge from 0.10.0 to 1.3.0 in /docs
+- Fixed [#239]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/239 ), Bump minimist from 1.2.5 to 1.2.6 in /docs
+- Fixed [#240]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/240 ), Update copyrights
+- Fixed [#241]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/241 ), Bump async from 2.6.3 to 2.6.4 in /docs
+
 ## Version 0.7.0
 Date Range: 10/16/21 - 11/22/21:
 
@@ -164,4 +194,4 @@ Accepted Pull Requests:
 - 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
+## Version 0.1.0

data/Gemfile

@@ -39,9 +39,9 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # end
 
 # if allow_local && File.exist?('../urbanopt-reporting-gem')
-#   gem 'urbanopt-reporting', path: '../urbanopt-reporting-gem'
+#  gem 'urbanopt-reporting', path: '../urbanopt-reporting-gem'
 # elsif allow_local
-#   gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
+#  gem 'urbanopt-reporting', github: 'URBANopt/urbanopt-reporting-gem', branch: 'develop'
 # end
 
 # if allow_local && File.exist?('../openstudio-load-flexibility-measures-gem')

data/LICENSE.md

@@ -1,6 +1,4 @@
-# License
-
-URBANopt™, Copyright (c) 2019-2021, Alliance for Sustainable Energy, LLC, and other
+URBANopt™, Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/README.md

@@ -1,4 +1,6 @@
-# URBANopt Scenario Gem 
+# URBANopt Scenario Gem
+
+[![Coverage Status](https://coveralls.io/repos/github/urbanopt/urbanopt-scenario-gem/badge.svg?branch=develop)](https://coveralls.io/github/urbanopt/urbanopt-scenario-gem?branch=develop)
 
 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. The ScenarioRunner is used to perform simulations for each SimulationDir. Finally, a ScenarioPostProcessor can run on a Scenario to generate scenario level results.
 
@@ -26,9 +28,9 @@ Or install it yourself as:
 Check out the repository and then execute:
 
     $ bundle install
-    $ bundle update    
+    $ bundle update
     $ bundle exec rake
-    
+
 ## Releasing
 
 * Update CHANGELOG.md

data/doc_templates/LICENSE.md

@@ -0,0 +1,37 @@
+URBANopt™, Copyright (c) 2019-2022, 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.
+
+Redistribution of this software, without modification, must refer to the software
+by the same designation. Redistribution of a modified version of this software
+(i) may not refer to the modified version by the same designation, or by any
+confusingly similar designation, and (ii) must refer to the underlying software
+originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+the term “URBANopt”, or any confusingly similar designation may not be used to
+refer to any modified version of this software or any modified version of the
+underlying software originally provided by Alliance without the prior written
+consent of Alliance.
+
+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,41 @@
+<%
+# *********************************************************************************
+# URBANopt™, Copyright (c) 2019-2022, 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.
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
+# 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/copyright_js.txt

@@ -0,0 +1,4 @@
+/* @preserve
+ * URBANopt (tm), Copyright (c) 2019-2022, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
+ * Use of this source code is governed by the BSD 3-Clause license.
+*/

data/doc_templates/copyright_ruby.txt

@@ -0,0 +1,39 @@
+# *********************************************************************************
+# URBANopt™, Copyright (c) 2019-2022, 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.
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
+# 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.
+# *********************************************************************************