openstudio-load-flexibility-measures 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26b919673f7ce4c202f5126df385ad569a77079965c62d15dbcef6b04e0b90dd
-  data.tar.gz: d8a422fab203371546a6031c4c01d1084fb26a64536a4a578de387b5592dbcb5
+  metadata.gz: b827295300d90067bd7a9664a6fa935f432896caf922871fb2d1638efd8e5f69
+  data.tar.gz: 319fbb0cd35c79b8ff9911322e651dc6db7502c6f1b7a4d479865da8e029d123
 SHA512:
-  metadata.gz: 294fdcd9d4242a5aa1e4731563440a33936606cda1c1a5c80ec59bd9ef3ff4a9a27ca1856874a5cd36fe85ebaa73686dbffe3e5d00f992104741221fb94b118b
-  data.tar.gz: 3b4f529c7a8a20be1ed134d397355cdaa1f93fd1197df2a7d77256a79d98fe051a20ed9fb780e3e547c78a2ea8470aaa669b3e2a9987e7ac0c7a3aa71ef73d03
+  metadata.gz: dd8f8b850c7aaa337ea306e9992123e2f2fe000156e269105674f3d9a97eadb5d3f3af8e572d9a8e5c14703a6b32506d1c9f3d96498749761b274ccfa1837219
+  data.tar.gz: edc05b3d56f4fe2accfff8320ea7974f50ed3db03d1d8389dbeb04f5b1f1292716623e23f2f08c5eb1ae7a2f74194727e57eb00ed21a1df98ce0039e319c30c7

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # OpenStudio Load Flexibility Measures Gem
 
+## Version 0.10.0
+- Support for OpenStudio 3.9 (upgrade to standards gem 0.7.0, extension gem 0.8.1)
+
+## Version 0.9.0
+- Updating dependencies and licenses for OpenStudio 3.8 (upgrade to standards gem 0.6.0)
+
 ## Version 0.8.0
 - Updating dependencies and licenses for OpenStudio 3.7 (upgrade to standards gem 0.5.0, extension gem 0.7.0)
 - Fix field indexes for CoilCoolingDXTwoSpeed in add_packaged_ice_storage

data/Gemfile

@@ -1,5 +1,6 @@
 source 'http://rubygems.org'
 
+# Specify your gem's dependencies in openstudio-model-articulation.gemspec
 gemspec
 
 # Local gems are useful when developing and integrating the various dependencies.
@@ -10,29 +11,9 @@ gemspec
 # checkout the latest version (develop) from github.
 allow_local = ENV['FAVOR_LOCAL_GEMS']
 
-
-# Delete when these branchesa are merged and released
-#gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'v0.6.0-rc1'
-#gem 'openstudio-standards', '= 0.2.17.rc1', :github => 'NREL/openstudio-standards', :ref => '3.5.0_changes'
-
-
-
-# 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,6 +1,6 @@
-//Jenkins pipelines are stored in shared libraries. Please see: https://github.com/NREL/cbci_jenkins_libs
+//Jenkins pipelines are stored in shared libaries. Please see: https://github.com/NREL/cbci_jenkins_libs
  
-@Library('cbci_shared_libs') _
+@Library('cbci_shared_libs@developExtension') _
 
 // Build for PR to develop branch only. 
 if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) { // check if set
@@ -8,4 +8,3 @@ if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) { // check if set
   openstudio_extension_gems()
     
 }
-

data/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008, 2023 Alliance for Sustainable Energy, LLC.
+OpenStudio(R), Copyright (c) 2008, 2024 Alliance for Sustainable Energy, LLC.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

data/README.md

@@ -31,6 +31,8 @@ Detailed instructions for usage are included in each measure's respective README
 
 |OpenStudio Load Flexibility Measures Gem|OpenStudio|Ruby|
 |:--------------:|:----------:|:--------:|
+| 0.10.0| 3.9      | 3.2.2  |
+| 0.9.0| 3.8      | 3.2.2  |
 | 0.8.0| 3.7      | 2.7    |
 | 0.7.0| 3.6      | 2.7    |
 | 0.6 - 0.6.1 | 3.5      | 2.7    |

data/lib/measures/PeakPeriodSchedulesShift/LICENSE.md

@@ -0,0 +1,13 @@
+OpenStudio(R), Copyright (c) 2008, 2024 Alliance for Sustainable Energy, LLC.
+
+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. 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 “OpenStudio®”. Except to comply with the foregoing, the term “OpenStudio®”, 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.
+
+4. The name of the copyright holder(s), any contributors, the United States Government, the United States Department of Energy, or any of their employees may not be used to endorse or promote products derived from this software without specific prior written permission from the respective party.
+
+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/lib/measures/PeakPeriodSchedulesShift/README.md

@@ -0,0 +1,140 @@
+
+
+###### (Automatically generated documentation)
+
+# PeakPeriodSchedulesShift
+
+## Description
+Shifts select weekday (or weekday/weekend) schedules out of a peak period.
+
+## Modeler Description
+Enter a peak period window, a delay value, and any applicable ScheduleRuleset or ScheduleFile schedules. Shift all schedule values falling within the peak period to after the end (offset by delay) of the peak period. Optionally prevent stacking of schedule values by only allowing shifts to all-zero periods. Optionally apply schedule shifts to weekend days.
+
+## Measure Type
+ModelMeasure
+
+## Taxonomy
+Whole Building.Whole Building Schedules
+
+___
+## Table of Contents
+- [Measure Overview](#measure-overview)<br/>
+- [Other Examples](#other-examples)<br/>
+- [Automatically Generated Argument List](#arguments)<br/>
+
+## Measure Overview
+
+The intent of this measure is to give the user the ability to shift schedules, thereby giving some control over the timing of energy use.
+A daily peak period is defined using a start and end hour of the day.
+This represents a peak demand window for which customers, e.g., might be penalized for running home appliances.
+Schedule values falling within the peak period are then shifted back in time, to start at the end of the peak period.
+An optional delay value can be specified to control how many hours after the peak period final hour the load shift should begin.
+By default, only schedule values occuring during weekdays can be shifted.
+However, an optional argument can be supplied to additionally enable schedule shifts for weekend days.
+Users also have the ability to disallow overlapping of shifted schedules onto any existing events.
+By default, however, schedules are shifted to periods that already have non-zero schedule values.
+In terms of specifying which schedules may be shifted, the user may provide comma-separated lists of schedule names for both ScheduleRuleset and ScheduleFile object types.
+Any schedule whose name is not listed is not available to receive any schedule shifts.
+
+The following illustrates a simple shift that has been applied to a refrigerator schedule.
+The first 5 weekdays of the year show the appliance load shifted back to start at the end of the peak period.
+The peak period does not apply to weekends, and so the final 2 weekend days does not show any shifted schedules.
+
+![Overview](./docs/measures-overview.png?raw=true)
+
+It's important to note that although this measure has been written generically to support any schedules of either the ScheduleRuleset of ScheduleFile type, it has only been tested in the context of residential workflows (i.e, ResStock).
+Users applying this measure in other (untested) workflows should use caution.
+
+## Other Examples
+
+Below are additional examples illustrating various scenarios for changing values supplied to measure arguments.
+
+### Shorter peak period
+
+*Peak Period*: 5pm - 7pm |
+*Delay*: None |
+*Weekdays Only*: Yes
+
+![Shorter Peak Period](./docs/other-examples1.png?raw=true)
+
+### Non-zero delay value
+
+*Peak Period*: 3pm - 7pm |
+*Delay*: 1hr |
+*Weekdays Only*: Yes
+
+![Nonzero Delay Value](./docs/other-examples2.png?raw=true)
+
+### Applied to weekends
+
+*Peak Period*: 3pm - 7pm |
+*Delay*: None |
+*Weekdays Only*: No
+
+![Applied To Weekends](./docs/other-examples3.png?raw=true)
+
+___
+
+*(Automatically generated argument information follows)*
+
+## Arguments
+
+
+### Schedules: Peak Period
+Specifies the peak period. Enter a time like "15 - 18" (start hour can be 0 through 23 and end hour can be 1 through 24).
+**Name:** schedules_peak_period,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+### Schedules: Peak Period Delay
+The number of hours after peak period end.
+**Name:** schedules_peak_period_delay,
+**Type:** Integer,
+**Units:** hr,
+**Required:** true,
+**Model Dependent:** false
+
+
+### Schedules: Peak Period Allow Stacking
+Whether schedules can be shifted to periods that already have non-zero schedule values. Defaults to true. Note that the schedule type limits upper value is increased to 2.0 when allowing stacked schedule values.
+**Name:** schedules_peak_period_allow_stacking,
+**Type:** Boolean,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+
+### Schedules: Peak Period Weekdays Only
+Whether schedules can be shifted for weekdays only, or weekends as well. Defaults to true.
+**Name:** schedules_peak_period_weekdays_only,
+**Type:** Boolean,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+
+### Schedules: Peak Period Schedule Rulesets Names
+Comma-separated list of Schedule:Ruleset object names corresponding to schedules to shift during the specified peak period.
+**Name:** schedules_peak_period_schedule_rulesets_names,
+**Type:** String,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+
+### Schedules: Peak Period Schedule Files Column Names
+Comma-separated list of column names, referenced by Schedule:File objects, corresponding to schedules to shift during the specified peak period.
+**Name:** schedules_peak_period_schedule_files_column_names,
+**Type:** String,
+**Units:** ,
+**Required:** false,
+**Model Dependent:** false
+
+
+
+
+
+

data/lib/measures/PeakPeriodSchedulesShift/README.md.erb

@@ -0,0 +1,106 @@
+<%#= 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 %>
+
+___
+## Table of Contents
+- [Measure Overview](#measure-overview)<br/>
+- [Other Examples](#other-examples)<br/>
+- [Automatically Generated Argument List](#arguments)<br/>
+
+## Measure Overview
+
+The intent of this measure is to give the user the ability to shift schedules, thereby giving some control over the timing of energy use.
+A daily peak period is defined using a start and end hour of the day.
+This represents a peak demand window for which customers, e.g., might be penalized for running home appliances.
+Schedule values falling within the peak period are then shifted back in time, to start at the end of the peak period.
+An optional delay value can be specified to control how many hours after the peak period final hour the load shift should begin.
+By default, only schedule values occuring during weekdays can be shifted.
+However, an optional argument can be supplied to additionally enable schedule shifts for weekend days.
+Users also have the ability to disallow overlapping of shifted schedules onto any existing events.
+By default, however, schedules are shifted to periods that already have non-zero schedule values.
+In terms of specifying which schedules may be shifted, the user may provide comma-separated lists of schedule names for both ScheduleRuleset and ScheduleFile object types.
+Any schedule whose name is not listed is not available to receive any schedule shifts.
+
+The following illustrates a simple shift that has been applied to a refrigerator schedule.
+The first 5 weekdays of the year show the appliance load shifted back to start at the end of the peak period.
+The peak period does not apply to weekends, and so the final 2 weekend days does not show any shifted schedules.
+
+![Overview](./docs/measures-overview.png?raw=true)
+
+It's important to note that although this measure has been written generically to support any schedules of either the ScheduleRuleset of ScheduleFile type, it has only been tested in the context of residential workflows (i.e, ResStock).
+Users applying this measure in other (untested) workflows should use caution.
+
+## Other Examples
+
+Below are additional examples illustrating various scenarios for changing values supplied to measure arguments.
+
+### Shorter peak period
+
+*Peak Period*: 5pm - 7pm |
+*Delay*: None |
+*Weekdays Only*: Yes
+
+![Shorter Peak Period](./docs/other-examples1.png?raw=true)
+
+### Non-zero delay value
+
+*Peak Period*: 3pm - 7pm |
+*Delay*: 1hr |
+*Weekdays Only*: Yes
+
+![Nonzero Delay Value](./docs/other-examples2.png?raw=true)
+
+### Applied to weekends
+
+*Peak Period*: 3pm - 7pm |
+*Delay*: None |
+*Weekdays Only*: No
+
+![Applied To Weekends](./docs/other-examples3.png?raw=true)
+
+___
+
+*(Automatically generated argument information follows)*
+
+## 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] %>
+<% if argument[:type] == "Choice" && !argument[:model_dependent]%>
+**Choice Display Names** <%= argument[:choice_display_names] %>
+<% end %>
+<% 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 %>