openstudio-calibration 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7194dfd20a78327be74f86f736c0bf86d7d13a63e8a6efbd27b962d711c11553
-  data.tar.gz: d05a98095f956bcd2951f66d8e7f22c697e4744ad3a1c308587c7ffb1626e687
+  metadata.gz: eac9bb4d41324eb6e242acc9992c8537d6e04c0e5070f0f05295b629c3042174
+  data.tar.gz: 5a35325a01b65f110289464da004c64d50643442171d50d4c3123ba38afe9f45
 SHA512:
-  metadata.gz: 1d343cc7da0a62b54e7509e014bd88c1bcea4477c624580f8425c4610b7b750ef7ae83254e876241161986253f807536e4791abb0430672f7aec27429d15f8f4
-  data.tar.gz: 471684d460cc78da4319df65734f3268148f215c0394643e15beaf1f9b4c389dfe0938dd695d76b04c620f455f14893de153f2ec9f008161be9613840f073f8b
+  metadata.gz: 653b1de03b3e0487e3f4bad95b259f4408da04b7d24387cbed05cdcf1755821111ce4939735521de243bf83248c2df429bcb731cade49a99c056999985ca86f2
+  data.tar.gz: fbca18aea610444d1fcc04437ea33b12f8ef17849008d0f9b0d555ae434f1f163746d528fb38f7c35638649523c8c31811310d102a74d52f4c3689fcda2754d7

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
   Exclude:
     - 'spec/test_measures/**/*'
+
+require: rubocop-performance
 inherit_from:
-  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v3.yml
+    - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v4.yml

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # OpenStudio Calibration Measures Gem
 
+## Version 0.5.0
+* Support for OpenStudio 3.3 (upgrade to extension gem 0.5.1 and standards gem 0.2.15)
+- Fixed [#35]( https://github.com/NREL/openstudio-calibration-gem/pull/35 ), adding compatibility matrix and contribution policy
+- Fixed [#38]( https://github.com/NREL/openstudio-calibration-gem/pull/38 ), Add hoo var method argment to change hours of operation measure
+
 ## Version 0.4.0
 
 * Support Ruby ~> 2.7

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.
+// Build for PR to develop branch only. 
 if ((env.CHANGE_ID) && (env.CHANGE_TARGET) ) { // check if set
 
   openstudio_extension_gems()
+    
+}
 
-}

data/README.md

@@ -20,9 +20,20 @@ Or install it yourself as:
 
     $ gem install 'openstudio-calibration'
 
-## Usage
+# Compatibility Matrix
+
+|OpenStudio Calibration Gem|OpenStudio|Ruby|
+|:--------------:|:----------:|:--------:|
+| 0.5.0  | 3.3      | 2.7    |
+| 0.4.0 - 0.4.2  | 3.2      | 2.7    |
+| 0.3.0 - 0.3.1  | 3.1      | 2.5    |
+| 0.2.0   | 3.0      | 2.5    |
+| 0.1.4 and below | 2.9 and below      | 2.2.4    |
+
+# Contributing 
+
+Please review the [OpenStudio Contribution Policy](https://openstudio.net/openstudio-contribution-policy) if you would like to contribute code to this gem.
 
-To be filled out later.
 
 # Releasing
 

data/lib/measures/CalibrationReports/measure.xml

@@ -1,7 +1,6 @@
 <?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
-  <error>wrong number of arguments (given 1, expected 0)</error>
   <name>calibration_reports</name>
   <uid>2baede0a-65f3-47ec-b5f6-9c21d0f91aff</uid>
   <version_id>63aaeb4e-fd54-483b-92f4-7a5d893986bd</version_id>

data/lib/measures/TimeseriesObjectiveFunction/measure.xml

@@ -1,7 +1,6 @@
 <?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
-  <error>wrong number of arguments (given 1, expected 0)</error>
   <name>timeseries_objective_function</name>
   <uid>6804217d-4737-45f3-82df-b81393c29ce3</uid>
   <version_id>bdebe708-959f-448c-bcfe-085253520b90</version_id>

data/lib/measures/TimeseriesPlot/measure.xml

@@ -1,7 +1,6 @@
 <?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
-  <error>wrong number of arguments (given 1, expected 0)</error>
   <name>timeseries_plot</name>
   <uid>6804217d-4737-45f3-82df-b81393c29ce7</uid>
   <version_id>c5ed3fd0-c97b-418b-9af6-3b960508699e</version_id>

data/lib/measures/inspect_and_edit_parametric_schedules/measure.xml

@@ -74,12 +74,6 @@
     </attribute>
   </attributes>
   <files>
-    <file>
-      <filename>.gitkeep</filename>
-      <filetype>gitkeep</filetype>
-      <usage_type>doc</usage_type>
-      <checksum>00000000</checksum>
-    </file>
     <file>
       <filename>example_parametric_model.osm</filename>
       <filetype>osm</filetype>

data/lib/measures/shift_hours_of_operation/README.md

@@ -118,6 +118,19 @@ This determine what fraction of occupancy be considered operating conditions. Th
 
 
 
+### Hours of Operation Variable Method for Scheudle Profile Formula.
+If dynamically generate parametric schedules from current ruleset scheudles is selected ,this argument is used to determine if the schedule profile formulas define time of points in a profile as a a specific delta from the star, middle, or end of the horus of operation, or if the delta is fractaionl percentate of the horus fo operation ro non-operation/vacant time.
+**Name:** hoo_var_method,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+
+**Choice Display Names** ["fractional", "hours"]
+
+
+
 ### Use model hours of operation as target
 The default behavior is for this to be false. This can not be used unless Dynamically generate parametric schedules from current ruleset schedules is set to false and if the schedules in the model already have parametric profiles. When changed to true all of the hours of operation start and duration values will be ignored as the bool to treat those values as relative or absolute. Instead the hours of operation schedules for the model will be used.
 **Name:** target_hoo_from_model,

data/lib/measures/shift_hours_of_operation/measure.rb

@@ -143,6 +143,16 @@ class ShiftHoursOfOperation < OpenStudio::Measure::ModelMeasure
     fraction_of_daily_occ_range.setUnits('Hours')
     args << fraction_of_daily_occ_range
 
+    # argument to choose hour of operation variable method
+    choices = OpenStudio::StringVector.new
+    choices << 'fractional'
+    choices << 'hours'
+    hoo_var_method = OpenStudio::Measure::OSArgument.makeChoiceArgument('hoo_var_method', choices, true)
+    hoo_var_method.setDisplayName('Hours of Operation Variable Method for Scheudle Profile Formula.')
+    hoo_var_method.setDescription('If dynamically generate parametric schedules from current ruleset scheudles is selected ,this argument is used to determine if the schedule profile formulas define time of points in a profile as a a specific delta from the star, middle, or end of the horus of operation, or if the delta is fractaionl percentate of the horus fo operation ro non-operation/vacant time.')
+    hoo_var_method.setDefaultValue('fractional')
+    args << hoo_var_method
+
     # make an argument for target_hoo_from_model
     # Should only be true when infer_parametric_schedules is false
     target_hoo_from_model = OpenStudio::Measure::OSArgument.makeBoolArgument('target_hoo_from_model', true)
@@ -359,10 +369,13 @@ class ShiftHoursOfOperation < OpenStudio::Measure::ModelMeasure
           end
         else
           new_hoo_start = hoo_start_dows
-          if hoo_start_dows + hoo_dur_dows <= 24.0
-            new_hoo_end = hoo_start_dows + hoo_dur_dows
-          else
-            new_hoo_end = hoo_start_dows + hoo_dur_dows - 24.0
+          target_dur = hoo_dur_dows
+          if new_hoo_start + target_dur < 24.0
+            new_hoo_end = new_hoo_start + target_dur
+          elsif new_hoo_start + target_dur == 24.0
+            new_hoo_end = 0.0
+          else # greater than 24
+            new_hoo_end = new_hoo_start + target_dur - 24.0
           end
         end
 
@@ -443,11 +456,10 @@ class ShiftHoursOfOperation < OpenStudio::Measure::ModelMeasure
       end
 
       # model_setup_parametric_schedules
-      # todo - there should be arg here that can have formula based on fraction of day and no hours is argument to gather_inputs_parametric_schedules method. need to update high level methods in standards to support input for this
-      standard.model_setup_parametric_schedules(model, gather_data_only: false)
+      standard.model_setup_parametric_schedules(model, gather_data_only: false, hoo_var_method: args['hoo_var_method'])
     end
 
-    # report final condition of model
+    # report initial condition of model
     hoo_summary_hash = hoo_summary(model, runner, standard)
     if !hoo_summary_hash[:zero_hoo].empty?
       runner.registerInitialCondition("Across the building the non-zero hours of operation range from #{hoo_summary_hash[:final_hoo_dur_range].min} hours to #{hoo_summary_hash[:final_hoo_dur_range].max} hours. Start of hours of operation range from #{hoo_summary_hash[:final_hoo_start_range].min} to #{hoo_summary_hash[:final_hoo_start_range].max}. One or more hours of operation schedules used contain a profile with 0 hours of operation.")
@@ -497,7 +509,7 @@ class ShiftHoursOfOperation < OpenStudio::Measure::ModelMeasure
       runner.registerFinalCondition("Across the building the hours of operation range from #{hoo_summary_hash[:final_hoo_dur_range].min} hours to #{hoo_summary_hash[:final_hoo_dur_range].max} hours. Start of hours of operation range from #{hoo_summary_hash[:final_hoo_start_range].min} to #{hoo_summary_hash[:final_hoo_start_range].max}.")
     end
 
-    # get log messages (if debut in setup is true this will fail for error)
+    # get log messages (if debug in setup is true this will fail for error)
     OsLib_HelperMethods.log_msgs
 
     # TODO: - adding hours of operation to a schedule that doesn't have them to start with, like a sunday, can be problematic

data/lib/measures/shift_hours_of_operation/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>shift_hours_of_operation</name>
   <uid>e8ae02a4-4be2-45c3-b85b-2a1d94662653</uid>
-  <version_id>e49fc9ef-be88-4958-aa01-5c25c5ac37a2</version_id>
-  <version_modified>20210423T201850Z</version_modified>
+  <version_id>25f89d69-3628-4e9f-9cc0-23ed036f451d</version_id>
+  <version_modified>20211016T194722Z</version_modified>
   <xml_checksum>4098406A</xml_checksum>
   <class_name>ShiftHoursOfOperation</class_name>
   <display_name>Shift Hours of Operation</display_name>
@@ -119,6 +119,25 @@
       <model_dependent>false</model_dependent>
       <default_value>0.25</default_value>
     </argument>
+    <argument>
+      <name>hoo_var_method</name>
+      <display_name>Hours of Operation Variable Method for Scheudle Profile Formula.</display_name>
+      <description>If dynamically generate parametric schedules from current ruleset scheudles is selected ,this argument is used to determine if the schedule profile formulas define time of points in a profile as a a specific delta from the star, middle, or end of the horus of operation, or if the delta is fractaionl percentate of the horus fo operation ro non-operation/vacant time.</description>
+      <type>Choice</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>fractional</default_value>
+      <choices>
+        <choice>
+          <value>fractional</value>
+          <display_name>fractional</display_name>
+        </choice>
+        <choice>
+          <value>hours</value>
+          <display_name>hours</display_name>
+        </choice>
+      </choices>
+    </argument>
     <argument>
       <name>target_hoo_from_model</name>
       <display_name>Use model hours of operation as target</display_name>
@@ -192,12 +211,6 @@
     </attribute>
   </attributes>
   <files>
-    <file>
-      <filename>.gitkeep</filename>
-      <filetype>gitkeep</filetype>
-      <usage_type>doc</usage_type>
-      <checksum>00000000</checksum>
-    </file>
     <file>
       <filename>example_model.osm</filename>
       <filetype>osm</filetype>
@@ -210,12 +223,6 @@
       <usage_type>readmeerb</usage_type>
       <checksum>232D0477</checksum>
     </file>
-    <file>
-      <filename>delta_values_false.osm</filename>
-      <filetype>osm</filetype>
-      <usage_type>test</usage_type>
-      <checksum>21CE90F0</checksum>
-    </file>
     <file>
       <filename>target_hoo_from_model.osm</filename>
       <filetype>osm</filetype>
@@ -228,23 +235,23 @@
       <usage_type>test</usage_type>
       <checksum>F2778476</checksum>
     </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>88FAD40B</checksum>
-    </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
       <checksum>A21A3ED2</checksum>
     </file>
+    <file>
+      <filename>delta_values_false.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>03619D54</checksum>
+    </file>
     <file>
       <filename>shift_hours_of_operation_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>F983E36E</checksum>
+      <checksum>B59FCB5E</checksum>
     </file>
     <file>
       <version>
@@ -255,7 +262,19 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>FAF9D893</checksum>
+      <checksum>09ED4734</checksum>
+    </file>
+    <file>
+      <filename>.gitkeep</filename>
+      <filetype>gitkeep</filetype>
+      <usage_type>doc</usage_type>
+      <checksum>00000000</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>46CEB194</checksum>
     </file>
   </files>
 </measure>

data/lib/openstudio/calibration/version.rb

@@ -35,6 +35,6 @@
 
 module OpenStudio
   module Calibration
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

data/openstudio-calibration.gemspec

@@ -30,8 +30,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '~> 2.7.0'
 
   spec.add_dependency 'bundler', '~> 2.1'
-  spec.add_dependency 'openstudio-extension', '~> 0.4.2'
-  spec.add_dependency 'openstudio-standards', '~> 0.2.13'
+  spec.add_dependency 'openstudio-extension', '~> 0.5.1'
+  spec.add_dependency 'openstudio-standards', '~> 0.2.15'
 
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-calibration
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Brian Ball
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,28 +31,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: openstudio-standards
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.13
+        version: 0.2.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.13
+        version: 0.2.15
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -296,7 +296,7 @@ licenses: []
 metadata:
   bug_tracker_uri: https://github.com/NREL/openstudio-calibration-gem/issues
   changelog_uri: https://github.com/NREL/openstudio-calibration-gem/blob/develop/CHANGELOG.md
-  source_code_uri: https://github.com/NREL/openstudio-calibration-gem/tree/v0.4.0
+  source_code_uri: https://github.com/NREL/openstudio-calibration-gem/tree/v0.5.0
 post_install_message: 
 rdoc_options: []
 require_paths: