openstudio-load-flexibility-measures 0.3.1 → 0.5.0

data/CHANGELOG.md

@@ -1,48 +1,63 @@
-# OpenStudio Load Flexibility Measures Gem
-
-## Version 0.3.1
-* Updated OS Extension dependency to 0.4.2
-* Updated OS Standards dependency to 0.2.13
-
-## Version 0.3.0
-* Merged [#20](https://github.com/NREL/openstudio-load-flexibility-measures-gem/pull/20), 030 upgrade
-  * Added Ruby 2.7.0 dependency
-  * Updated OS Extension dependency to 0.4.0
-* Updated documentation for Add Packaged Ice Storage measure
-* Corrected output variable in Add HPWH measure
-
-## Version 0.2.1
-* Updated dependency for OS Extension 0.3.2
-* Removed extraneous delimiter argument from Add Packaged Ice Storage measure
-  * Fixed [#18](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/18), remove "delimiter" argument from add_packaged_ice_storage
-
-## Version 0.2.0
-
-* Updated dependencies for OS Version 3.1:
-  * Merged [#15](https://github.com/NREL/openstudio-load-flexibility-measures-gem/pull/15), Os 3.1.0
-  * OS Extension set to 0.3.1
-  * OS Standards set to 0.2.12
-* Updated measure names within documentation
-* Updated documentation for Add Packaged Ice Storage measure
-
-## Version 0.1.3
-
-* Measures have been renamed and readme updated:
-  * "Add Ice Storage to Plant Loop for Load Flexibility" is now "Add Central Ice Storage"
-  * "Add Distributed Ice Storage to Air Loop for Load Flexibility" is now "Add Packaged Ice Storage"
-  * "Add Central HPHW for Load Flexibility" is now "Add HPHW"
-* Bug Fixes:
-  * [#12](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/12), File names become too long when using with URBANopt CLI
-
-## Version 0.1.2
-
-* Bug Fixes:
-  * [#4](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/4), use unix paths in 'add_distributed_ice_storage_to_air_loop_for_load_flexibility'
-  * [#6](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/6), code error in add_distributed measure
-  * [#8](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/8), EMS output variables cause measure failure
-* Remove .DS_Store and exclude from future releases
-* Code cleanup
-
-## Version 0.1.1
-
-* Initial release
+# OpenStudio Load Flexibility Measures Gem
+
+## Version 0.5.0
+* Updated OS Standards dependency to 0.2.16
+* Fixed [#41](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/41), Error in applying add_hpwh measure with "non-simplified" options to MF prototype building in OS 3.3
+
+## Version 0.4.0
+* Updated OS Extension dependency to 0.5.1
+* Updated OS Standards dependency to 0.2.15
+* adding compatibility matrix and contribution policy
+
+## Version 0.3.2
+* Modify HPWH measure "simplified" option to automatically identify water heater objects without explicit user naming
+* Modify HPWH measure to improve integration with URBANopt workflow
+* Update HPWH measure documentation
+
+## Version 0.3.1
+* Updated OS Extension dependency to 0.4.2
+* Updated OS Standards dependency to 0.2.13
+* Added Jenkins file for CI testing
+
+## Version 0.3.0
+* Merged [#20](https://github.com/NREL/openstudio-load-flexibility-measures-gem/pull/20), 030 upgrade
+  * Added Ruby 2.7.0 dependency
+  * Updated OS Extension dependency to 0.4.0
+* Updated documentation for Add Packaged Ice Storage measure
+* Corrected output variable in Add HPWH measure
+
+## Version 0.2.1
+* Updated dependency for OS Extension 0.3.2
+* Removed extraneous delimiter argument from Add Packaged Ice Storage measure
+  * Fixed [#18](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/18), remove "delimiter" argument from add_packaged_ice_storage
+
+## Version 0.2.0
+
+* Updated dependencies for OS Version 3.1:
+  * Merged [#15](https://github.com/NREL/openstudio-load-flexibility-measures-gem/pull/15), Os 3.1.0
+  * OS Extension set to 0.3.1
+  * OS Standards set to 0.2.12
+* Updated measure names within documentation
+* Updated documentation for Add Packaged Ice Storage measure
+
+## Version 0.1.3
+
+* Measures have been renamed and readme updated:
+  * "Add Ice Storage to Plant Loop for Load Flexibility" is now "Add Central Ice Storage"
+  * "Add Distributed Ice Storage to Air Loop for Load Flexibility" is now "Add Packaged Ice Storage"
+  * "Add Central HPHW for Load Flexibility" is now "Add HPHW"
+* Bug Fixes:
+  * [#12](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/12), File names become too long when using with URBANopt CLI
+
+## Version 0.1.2
+
+* Bug Fixes:
+  * [#4](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/4), use unix paths in 'add_distributed_ice_storage_to_air_loop_for_load_flexibility'
+  * [#6](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/6), code error in add_distributed measure
+  * [#8](https://github.com/NREL/openstudio-load-flexibility-measures-gem/issues/8), EMS output variables cause measure failure
+* Remove .DS_Store and exclude from future releases
+* Code cleanup
+
+## Version 0.1.1
+
+* Initial release

data/Gemfile

@@ -1,7 +1,31 @@
-source 'http://rubygems.org'
-
-gemspec
-
-if File.exist?('../openstudio-standards')
-  gem 'openstudio-standards', path: '../openstudio-standards'
-end
+source 'http://rubygems.org'
+
+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 when you want CI to use develop branch of extension gem
+# gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'develop'
+
+# uncomment when you want CI to use develop branch of openstudio-standards gem
+# gem 'openstudio-standards', github: 'NREL/OpenStudio-standards', branch: 'master'
+
+# Only uncomment if you need to test a different version of the extension 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
+
+# Only uncomment if you need to test a different version of OpenStudio-standards
+# if allow_local && File.exist?('../openstudio-standards')
+#   gem 'openstudio-standards', path: '../openstudio-standards'
+# elsif allow_local
+#   gem 'openstudio-standards', github: 'NREL/OpenStudio-standards', branch: 'develop'
+# end

data/Jenkinsfile

@@ -1,10 +1,11 @@
-//Jenkins pipelines are stored in shared libraries. Please see: https://github.com/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()
-
-}
+//Jenkins pipelines are stored in shared libraries. Please see: https://github.com/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 @@
+OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted 
+provided that the following conditions are met:
+
+(1) Redistributions of source code must retain the above copyright notice, this list of conditions 
+and the following disclaimer.
+
+(2) 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.
+
+(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse 
+or promote products derived from this software without specific prior written permission from the 
+respective party.
+
+(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other 
+derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar 
+designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
+
+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, THE UNITED STATES GOVERNMENT, 
+OR ANY 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/README.md

@@ -1,42 +1,57 @@
-# Openstudio Load Flexibility Measures Gem
-
-This gem contains measures for thermal energy storage for building cooling and domestic hot water heating.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'openstudio-load-flexibility-measures'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install 'openstudio-load-flexibility-measures'
-
-## Usage
-
-The openstudio-load-flexibility-measures gem contains measures to apply thermal load flexibility to a building model. The current version contains the following:
-* Add [HPHW](https://github.com/NREL/openstudio-load-flexibility-measures-gem/tree/master/lib/measures/add_hpwh) (Heat Pump Hot Water Heater)
-* Add [Central Ice Storage](https://github.com/NREL/openstudio-load-flexibility-measures-gem/tree/master/lib/measures/add_central_ice_storage) (for plant loops)
-* Add [Packaged Ice Storage](https://github.com/NREL/openstudio-load-flexibility-measures-gem/tree/master/lib/measures/add_packaged_ice_storage) (for rooftop units)
-
-Detailed instructions for usage are included in each measure's respective README.md and docs folder. 
-
-# Releasing
-
-* Update CHANGELOG.md
-* Run rake rubocop:auto_correct
-* Update version in `/lib/openstudio/openstudio-load-flexibility-measures/version.rb`
-* Create PR to master, after tests and reviews complete, then merge
-* Locally - from the master branch, run rake release
-* Release via github
-* 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.
-
-## TODO
-
-- [ ] Update documentation pdf's to reflect revised measure names
+# Openstudio Load Flexibility Measures Gem
+
+This gem contains measures for thermal energy storage for building cooling and domestic hot water heating.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openstudio-load-flexibility-measures'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install 'openstudio-load-flexibility-measures'
+
+## Usage
+
+The openstudio-load-flexibility-measures gem contains measures to apply thermal load flexibility to a building model. The current version contains the following:
+* Add [HPHW](https://github.com/NREL/openstudio-load-flexibility-measures-gem/tree/master/lib/measures/add_hpwh) (Heat Pump Hot Water Heater)
+* Add [Central Ice Storage](https://github.com/NREL/openstudio-load-flexibility-measures-gem/tree/master/lib/measures/add_central_ice_storage) (for plant loops)
+* Add [Packaged Ice Storage](https://github.com/NREL/openstudio-load-flexibility-measures-gem/tree/master/lib/measures/add_packaged_ice_storage) (for rooftop units)
+
+Detailed instructions for usage are included in each measure's respective README.md and docs folder. 
+
+# Compatibility Matrix
+
+|OpenStudio Load Flexibility Measures Gem|OpenStudio|Ruby|
+|:--------------:|:----------:|:--------:|
+| 0.5  | 3.4      | 2.7    |
+| 0.4  | 3.2      | 2.7    |
+| 0.3.2  | 3.2      | 2.7    |
+| 0.2.0 - 0.2.1  | 3.1      | 2.5    |
+| 0.1.1 - 0.1.3  | 3.0      | 2.5    |
+
+
+# Contributing 
+
+Please review the [OpenStudio Contribution Policy](https://openstudio.net/openstudio-contribution-policy) if you would like to contribute code to this gem.
+
+# Releasing
+
+* Update `CHANGELOG.md`
+* Run `rake rubocop:auto_correct`
+* Run `rake openstudio:update_copyright`
+* Run `rake openstudio:update_measures` (this has to be done last since prior tasks alter measure files)
+* Update version in `readme.md`
+* Update version in `openstudio-load-flexibility.gemspec`
+* Update version in `/lib/openstudio/load-flexibility/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

@@ -1,15 +1,15 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new
-
-# Load in the rake tasks from the base openstudio-extension gem
-require 'openstudio/extension/rake_task'
-require 'openstudio/load_flexibility_measures'
-os_extension = OpenStudio::Extension::RakeTask.new
-os_extension.set_extension_class(OpenStudio::LoadFlexibilityMeasures::LoadFlexibilityMeasures)
-
-task default: :spec
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+# Load in the rake tasks from the base openstudio-extension gem
+require 'openstudio/extension/rake_task'
+require 'openstudio/load_flexibility_measures'
+os_extension = OpenStudio::Extension::RakeTask.new
+os_extension.set_extension_class(OpenStudio::LoadFlexibilityMeasures::LoadFlexibilityMeasures)
+
+task default: :spec

data/doc_templates/LICENSE.md

@@ -1,27 +1,27 @@
-OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted 
-provided that the following conditions are met:
-
-(1) Redistributions of source code must retain the above copyright notice, this list of conditions 
-and the following disclaimer.
-
-(2) 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.
-
-(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse 
-or promote products derived from this software without specific prior written permission from the 
-respective party.
-
-(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other 
-derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar 
-designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
-
-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, THE UNITED STATES GOVERNMENT, 
-OR ANY 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 
+OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted 
+provided that the following conditions are met:
+
+(1) Redistributions of source code must retain the above copyright notice, this list of conditions 
+and the following disclaimer.
+
+(2) 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.
+
+(3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse 
+or promote products derived from this software without specific prior written permission from the 
+respective party.
+
+(4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other 
+derivative works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar 
+designation without specific prior written permission from Alliance for Sustainable Energy, LLC.
+
+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, THE UNITED STATES GOVERNMENT, 
+OR ANY 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

@@ -1,42 +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(", ") %>
+<%#= 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

@@ -1,36 +1,36 @@
-<%
-  # *******************************************************************************
-  # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
-  # All rights reserved.
-  # Redistribution and use in source and binary forms, with or without
-  # modification, are permitted provided that the following conditions are met:
-  #
-  # (1) Redistributions of source code must retain the above copyright notice,
-  # this list of conditions and the following disclaimer.
-  #
-  # (2) 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.
-  #
-  # (3) Neither the name of the copyright holder nor the names of any contributors
-  # may be used to endorse or promote products derived from this software without
-  # specific prior written permission from the respective party.
-  #
-  # (4) Other than as required in clauses (1) and (2), distributions in any form
-  # of modifications or other derivative works may not use the "OpenStudio"
-  # trademark, "OS", "os", or any other confusingly similar designation without
-  # specific prior written permission from Alliance for Sustainable Energy, LLC.
-  #
-  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
-  # UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
-  # THEIR EMPLOYEES, 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.
-  # *******************************************************************************
+<%
+  # *******************************************************************************
+  # OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+  # All rights reserved.
+  # Redistribution and use in source and binary forms, with or without
+  # modification, are permitted provided that the following conditions are met:
+  #
+  # (1) Redistributions of source code must retain the above copyright notice,
+  # this list of conditions and the following disclaimer.
+  #
+  # (2) 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.
+  #
+  # (3) Neither the name of the copyright holder nor the names of any contributors
+  # may be used to endorse or promote products derived from this software without
+  # specific prior written permission from the respective party.
+  #
+  # (4) Other than as required in clauses (1) and (2), distributions in any form
+  # of modifications or other derivative works may not use the "OpenStudio"
+  # trademark, "OS", "os", or any other confusingly similar designation without
+  # specific prior written permission from Alliance for Sustainable Energy, LLC.
+  #
+  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
+  # UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+  # THEIR EMPLOYEES, 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

@@ -1,4 +1,4 @@
-/* @preserve
- * OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
- * Use of this source code is governed by a BSD-style license that can be found at openstudio.net/license.
+/* @preserve
+ * OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC. All rights reserved.
+ * Use of this source code is governed by a BSD-style license that can be found at openstudio.net/license.
 */

data/doc_templates/copyright_ruby.txt

@@ -1,34 +1,34 @@
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
-# All rights reserved.
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# (1) Redistributions of source code must retain the above copyright notice,
-# this list of conditions and the following disclaimer.
-#
-# (2) 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.
-#
-# (3) Neither the name of the copyright holder nor the names of any contributors
-# may be used to endorse or promote products derived from this software without
-# specific prior written permission from the respective party.
-#
-# (4) Other than as required in clauses (1) and (2), distributions in any form
-# of modifications or other derivative works may not use the "OpenStudio"
-# trademark, "OS", "os", or any other confusingly similar designation without
-# specific prior written permission from Alliance for Sustainable Energy, LLC.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
-# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
-# THEIR EMPLOYEES, 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.
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) 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.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, 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.
 # *******************************************************************************