openstudio-calibration 0.3.1 → 0.5.1

data/lib/measures/shift_hours_of_operation/measure.xml

@@ -0,0 +1,280 @@
+<?xml version="1.0"?>
+<measure>
+  <schema_version>3.0</schema_version>
+  <name>shift_hours_of_operation</name>
+  <uid>e8ae02a4-4be2-45c3-b85b-2a1d94662653</uid>
+  <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>
+  <description>This measure will infer the hours of operation for the building and then will shift the start of the hours of operation and change the duration of the hours of operation. In an alternate workflow you can directly pass in target start and duration rather than a shift and delta. Inputs can vary for weekday, Saturday, and Sunday. if a day does not have any hours of operation to start with increasing hours of operation may not have any impact as the auto generated data may not know what to do during operating hours. Future version may be able to borrow a profile formula but would probably require additional user arguments.</description>
+  <modeler_description>This will only impact schedule rulesets. It will use methods in openstudio-standards to infer hours of operation, develop a parametric formula for all of the ruleset schedules, alter the hours of operation inputs to that formula and then re-apply the schedules. Input is expose to set ramp frequency of the resulting schedules. If inputs are such that no changes are requested, bypass the measure with NA so that it will not be parameterized. An advanced option for this measure would be bool to use hours of operation from OSM schedule ruleset hours of operation instead of inferring from standards. This should allow different parts of the building to have different hours of operation in the seed model.</modeler_description>
+  <arguments>
+    <argument>
+      <name>hoo_start_weekday</name>
+      <display_name>Shift the weekday start of hours of operation.</display_name>
+      <description>Use decimal hours so an 1 hour and 15 minute shift would be 1.25. Positive value moves the hour of operation later</description>
+      <type>Double</type>
+      <units>Hours</units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>0</default_value>
+    </argument>
+    <argument>
+      <name>hoo_dur_weekday</name>
+      <display_name>Extend the weekday of hours of operation.</display_name>
+      <description>Use decimal hours so an 1 hour and 15 minute would be 1.25. Positive value makes the hour of operation longer.</description>
+      <type>Double</type>
+      <units>Hours</units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>0</default_value>
+    </argument>
+    <argument>
+      <name>hoo_start_saturday</name>
+      <display_name>Shift the saturday start of hours of operation.</display_name>
+      <description>Use decimal hours so an 1 hour and 15 minute shift would be 1.25. Positive value moves the hour of operation later</description>
+      <type>Double</type>
+      <units>Hours</units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>0</default_value>
+    </argument>
+    <argument>
+      <name>hoo_dur_saturday</name>
+      <display_name>Extend the saturday of hours of operation.</display_name>
+      <description>Use decimal hours so an 1 hour and 15 minute would be 1.25. Positive value makes the hour of operation longer.</description>
+      <type>Double</type>
+      <units>Hours</units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>0</default_value>
+    </argument>
+    <argument>
+      <name>hoo_start_sunday</name>
+      <display_name>Shift the sunday start of hours of operation.</display_name>
+      <description>Use decimal hours so an 1 hour and 15 minute shift would be 1.25. Positive value moves the hour of operation later</description>
+      <type>Double</type>
+      <units>Hours</units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>0</default_value>
+    </argument>
+    <argument>
+      <name>hoo_dur_sunday</name>
+      <display_name>Extend the sunday of hours of operation.</display_name>
+      <description>Use decimal hours so an 1 hour and 15 minute would be 1.25. Positive value makes the hour of operation longer.</description>
+      <type>Double</type>
+      <units>Hours</units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>0</default_value>
+    </argument>
+    <argument>
+      <name>delta_values</name>
+      <display_name>Hours of operation values treated as deltas</display_name>
+      <description>When this is true the hours of operation start and duration represent a delta from the original model values. When switched to false they represent absolute values.</description>
+      <type>Boolean</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>true</default_value>
+      <choices>
+        <choice>
+          <value>true</value>
+          <display_name>true</display_name>
+        </choice>
+        <choice>
+          <value>false</value>
+          <display_name>false</display_name>
+        </choice>
+      </choices>
+    </argument>
+    <argument>
+      <name>infer_parametric_schedules</name>
+      <display_name>Dynamically generate parametric schedules from current ruleset schedules.</display_name>
+      <description>When this is true the parametric schedule formulas and hours of operation will be generated from the existing model schedules. When false it expects the model already has parametric formulas stored.</description>
+      <type>Boolean</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>true</default_value>
+      <choices>
+        <choice>
+          <value>true</value>
+          <display_name>true</display_name>
+        </choice>
+        <choice>
+          <value>false</value>
+          <display_name>false</display_name>
+        </choice>
+      </choices>
+    </argument>
+    <argument>
+      <name>fraction_of_daily_occ_range</name>
+      <display_name>Fraction of Daily Occupancy Range.</display_name>
+      <description>This determine what fraction of occupancy be considered operating conditions. This fraction is normalized to expanded to range seen over the full year and does not necessary equal fraction of design occupancy. This value should be between 0 and 1.0 and is only used if dynamically generated parametric schedules are used.</description>
+      <type>Double</type>
+      <units>Hours</units>
+      <required>true</required>
+      <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>
+      <description>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.</description>
+      <type>Boolean</type>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>false</default_value>
+      <choices>
+        <choice>
+          <value>true</value>
+          <display_name>true</display_name>
+        </choice>
+        <choice>
+          <value>false</value>
+          <display_name>false</display_name>
+        </choice>
+      </choices>
+    </argument>
+  </arguments>
+  <outputs />
+  <provenances />
+  <tags>
+    <tag>Whole Building.Whole Building Schedules</tag>
+  </tags>
+  <attributes>
+    <attribute>
+      <name>Measure Type</name>
+      <value>ModelMeasure</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Apply Measure Now</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>OpenStudio Application</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Software Tool</name>
+      <value>Parametric Analysis Tool</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>Model Articulation</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>Calibration</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>Sensitivity Analysis</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>New Construction EE</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>Retrofit EE</value>
+      <datatype>string</datatype>
+    </attribute>
+  </attributes>
+  <files>
+    <file>
+      <filename>example_model.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>BE467EF8</checksum>
+    </file>
+    <file>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>232D0477</checksum>
+    </file>
+    <file>
+      <filename>target_hoo_from_model.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>3F74E693</checksum>
+    </file>
+    <file>
+      <filename>SimpleModel.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>F2778476</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>B59FCB5E</checksum>
+    </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>3.1.0</identifier>
+        <min_compatible>3.1.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <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/extension.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# 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:

data/lib/openstudio/calibration/version.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# 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:
@@ -35,6 +35,6 @@
 
 module OpenStudio
   module Calibration
-    VERSION = '0.3.1'.freeze
+    VERSION = '0.5.1'.freeze
   end
 end

data/lib/openstudio/calibration.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# 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:

data/lib/openstudio-calibration.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# 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:

data/openstudio-calibration.gemspec

@@ -27,11 +27,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '~> 2.5.0'
+  spec.required_ruby_version = '~> 2.7.0'
 
   spec.add_dependency 'bundler', '~> 2.1'
-  spec.add_dependency 'openstudio-extension', '~> 0.3.2'
-  spec.add_dependency 'openstudio-standards', '~> 0.2.12'
+  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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-calibration
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Brian Ball
 - Nicholas Long
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2022-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,28 +31,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.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.12
+        version: 0.2.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.12
+        version: 0.2.15
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -273,12 +273,18 @@ files:
 - lib/measures/WaterHeaterMixedPercentChange/README.md.erb
 - lib/measures/WaterHeaterMixedPercentChange/measure.rb
 - lib/measures/WaterHeaterMixedPercentChange/measure.xml
-- lib/measures/zone_report/LICENSE.md
-- lib/measures/zone_report/README.md
-- lib/measures/zone_report/README.md.erb
-- lib/measures/zone_report/measure.rb
-- lib/measures/zone_report/measure.xml
-- lib/measures/zone_report/resources/report.html.in
+- lib/measures/inspect_and_edit_parametric_schedules/LICENSE.md
+- lib/measures/inspect_and_edit_parametric_schedules/README.md
+- lib/measures/inspect_and_edit_parametric_schedules/README.md.erb
+- lib/measures/inspect_and_edit_parametric_schedules/docs/apply_measures_now.png
+- lib/measures/inspect_and_edit_parametric_schedules/measure.rb
+- lib/measures/inspect_and_edit_parametric_schedules/measure.xml
+- lib/measures/shift_hours_of_operation/LICENSE.md
+- lib/measures/shift_hours_of_operation/README.md
+- lib/measures/shift_hours_of_operation/README.md.erb
+- lib/measures/shift_hours_of_operation/docs/.gitkeep
+- lib/measures/shift_hours_of_operation/measure.rb
+- lib/measures/shift_hours_of_operation/measure.xml
 - lib/openstudio-calibration.rb
 - lib/openstudio/calibration.rb
 - lib/openstudio/calibration/extension.rb
@@ -289,8 +295,8 @@ 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.3.1
-post_install_message: 
+  source_code_uri: https://github.com/NREL/openstudio-calibration-gem/tree/v0.5.1
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -298,7 +304,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -306,7 +312,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: openstudio base gem for creating generic extensions with encapsulated data
   and measures.

data/lib/measures/zone_report/README.md

@@ -1,26 +0,0 @@
-
-
-###### (Automatically generated documentation)
-
-# 
-
-## Description
-
-
-## Modeler Description
-
-
-## Measure Type
-ModelMeasure
-
-## Taxonomy
-
-
-## Arguments
-
-
-
-
-This measure does not have any user arguments
-
-