openstudio-calibration 0.4.0 → 0.6.0

data/lib/measures/TimeseriesObjectiveFunction/measure.xml

@@ -1,11 +1,10 @@
 <?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>
-  <version_modified>20210423T201838Z</version_modified>
+  <version_id>300a1bda-e79c-4290-bbd9-bd1fe843264a</version_id>
+  <version_modified>20220223T012006Z</version_modified>
   <xml_checksum>FFE04372</xml_checksum>
   <class_name>TimeseriesObjectiveFunction</class_name>
   <display_name>TimeSeries Objective Function</display_name>
@@ -17,43 +16,33 @@
       <display_name>Path to CSV file for the metered data</display_name>
       <description>Path to CSV file including file name.</description>
       <type>String</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>../../../lib/resources/mtr.csv</default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>csv_time_header</name>
       <display_name>CSV Time Header</display_name>
       <description>CSV Time Header Value. Used to determine the timestamp column in the CSV file</description>
       <type>String</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>Date/Time</default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>csv_var</name>
       <display_name>CSV variable name</display_name>
       <description>CSV variable name. Used to determine the variable column in the CSV file</description>
       <type>String</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>Whole Building:Facility Total Electric Demand Power [W](TimeStep)</default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>convert_data</name>
       <display_name>Convert Units</display_name>
       <description>Convert Units in Metered Data</description>
       <type>Choice</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>None</default_value>
@@ -79,27 +68,21 @@
           <display_name>None</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>csv_var_dn</name>
       <display_name>CSV variable display name</display_name>
       <description>CSV variable display name. Not yet Implemented</description>
       <type>String</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value></default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>year</name>
       <display_name>Year in csv data timestamp</display_name>
       <description>Is the Year in the csv data timestamp =&gt; mm:dd:yy or mm:dd (true/false)</description>
       <type>Boolean</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>true</default_value>
@@ -113,15 +96,12 @@
           <display_name>false</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>seconds</name>
       <display_name>Seconds in csv data timestamp</display_name>
       <description>Is the Seconds in the csv data timestamp =&gt; hh:mm:ss or hh:mm (true/false)</description>
       <type>Boolean</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>true</default_value>
@@ -135,42 +115,32 @@
           <display_name>false</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>key_value</name>
       <display_name>SQL key value</display_name>
       <description>SQL key value for the SQL query to find the variable in the SQL file</description>
       <type>String</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value></default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>timeseries_name</name>
       <display_name>TimeSeries Name</display_name>
       <description>TimeSeries Name for the SQL query to find the variable in the SQL file</description>
       <type>String</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>Facility Total Electric Demand Power</default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>reporting_frequency</name>
       <display_name>Reporting Frequency</display_name>
       <description>Reporting Frequency for SQL Query</description>
       <type>Choice</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
-      <default_value></default_value>
       <choices>
         <choice>
           <value>Detailed</value>
@@ -197,51 +167,39 @@
           <display_name>RunPeriod</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>environment_period</name>
       <display_name>Environment Period</display_name>
       <description>Environment Period for SQL query</description>
       <type>String</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>RUN PERIOD 1</default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>norm</name>
       <display_name>Norm of the difference of csv and sql</display_name>
       <description>Norm of the difference of csv and sql. 1 is absolute value. 2 is euclidean distance. 3 is raw difference.</description>
       <type>Double</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>1</default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>scale</name>
       <display_name>Scale factor to apply to the difference</display_name>
       <description>Scale factor to apply to the difference (1 is no scale)</description>
       <type>Double</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>1</default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>find_avail</name>
       <display_name>Find Available data in the SQL file</display_name>
       <description>Will RegisterInfo all the 'EnvPeriod', 'ReportingFrequencies', 'VariableNames', 'KeyValues' in the SQL file.  Useful for debugging SQL issues.</description>
       <type>Boolean</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>true</default_value>
@@ -255,15 +213,12 @@
           <display_name>false</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>algorithm_download</name>
       <display_name>algorithm_download</display_name>
       <description>Make JSON data available for algorithm_download (true/false)</description>
       <type>Boolean</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>false</default_value>
@@ -277,15 +232,12 @@
           <display_name>false</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>plot_flag</name>
       <display_name>plot_flag timeseries data</display_name>
       <description>Create plot of timeseries data (true/false)</description>
       <type>Boolean</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>true</default_value>
@@ -299,27 +251,21 @@
           <display_name>false</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>plot_name</name>
       <display_name>Plot name</display_name>
       <description>Name to include in reporting file name.</description>
       <type>String</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value></default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>verbose_messages</name>
       <display_name>verbose_messages</display_name>
       <description>verbose messages.  Useful for debugging but MAJOR Performance Hit.</description>
       <type>Boolean</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>false</default_value>
@@ -333,15 +279,12 @@
           <display_name>false</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>warning_messages</name>
       <display_name>warning_messages</display_name>
       <description>Warn on missing data.</description>
       <type>Boolean</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>true</default_value>
@@ -355,15 +298,12 @@
           <display_name>false</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>add_first_zero_for_plots</name>
       <display_name>add_first_zero_for_plots</display_name>
       <description>Add a point of zero value to the plot at the beginning of the runperiod.</description>
       <type>Boolean</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>false</default_value>
@@ -377,15 +317,12 @@
           <display_name>false</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>add_last_zero_for_plots</name>
       <display_name>add_last_zero_for_plots</display_name>
       <description>Add a point of zero value to the plot at the end of the runperiod.</description>
       <type>Boolean</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>false</default_value>
@@ -399,8 +336,6 @@
           <display_name>false</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
   </arguments>
   <outputs>
@@ -408,45 +343,35 @@
       <name>diff</name>
       <display_name>diff</display_name>
       <short_name>diff</short_name>
-      <description></description>
       <type>Double</type>
-      <units></units>
       <model_dependent>false</model_dependent>
     </output>
     <output>
       <name>simdata</name>
       <display_name>simdata</display_name>
       <short_name>simdata</short_name>
-      <description></description>
       <type>Double</type>
-      <units></units>
       <model_dependent>false</model_dependent>
     </output>
     <output>
       <name>csvdata</name>
       <display_name>csvdata</display_name>
       <short_name>csvdata</short_name>
-      <description></description>
       <type>Double</type>
-      <units></units>
       <model_dependent>false</model_dependent>
     </output>
     <output>
       <name>cvrmse</name>
       <display_name>cvrmse</display_name>
       <short_name>cvrmse</short_name>
-      <description></description>
       <type>Double</type>
-      <units></units>
       <model_dependent>false</model_dependent>
     </output>
     <output>
       <name>nmbe</name>
       <display_name>nmbe</display_name>
       <short_name>nmbe</short_name>
-      <description></description>
       <type>Double</type>
-      <units></units>
       <model_dependent>false</model_dependent>
     </output>
   </outputs>
@@ -478,12 +403,6 @@
       <usage_type>readmeerb</usage_type>
       <checksum>703C9964</checksum>
     </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>7DE1F2CF</checksum>
-    </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
@@ -499,13 +418,19 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>98EED533</checksum>
+      <checksum>70C9D9FB</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>3F176FE0</checksum>
     </file>
     <file>
       <filename>report.html.erb</filename>
       <filetype>erb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>6113CF65</checksum>
+      <checksum>4D36345D</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/TimeseriesPlot/README.md

@@ -2,16 +2,16 @@
 
 ###### (Automatically generated documentation)
 
-# 
+# Timeseries Plot
 
 ## Description
-
+Creates an interactive timeseries plot of selected variable.
 
 ## Modeler Description
-
+NOTE: This will load and respond slowly in the OS app, especially if you select * on a variable with many possible keys or you select timestep data.  Suggest you open it in a web browser like Chrome instead.
 
 ## Measure Type
-ModelMeasure
+ReportingMeasure
 
 ## Taxonomy
 
@@ -19,8 +19,38 @@ ModelMeasure
 ## Arguments
 
 
+### Enter Variable Name.
+Valid values can be found in the eplusout.rdd file after a simulation is run.
+**Name:** variable_name,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Reporting Frequency.
+
+**Name:** reporting_frequency,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Enter Key Name.
+Enter * for all objects or the full name of a specific object to.
+**Name:** key_value,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### availableEnvPeriods
+availableEnvPeriods
+**Name:** env,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
 
 
-This measure does not have any user arguments
 
 

data/lib/measures/TimeseriesPlot/measure.rb

@@ -56,7 +56,7 @@ class TimeseriesPlot < OpenStudio::Measure::ReportingMeasure
   end
 
   # define the arguments that the user will input
-  def arguments
+  def arguments(model = nil)
     args = OpenStudio::Measure::OSArgumentVector.new
 
     # make an argument for the variable name

data/lib/measures/TimeseriesPlot/measure.xml

@@ -1,11 +1,10 @@
 <?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>
-  <version_modified>20210423T201838Z</version_modified>
+  <version_id>f98dc824-7042-4ea0-be6d-200a24b5757e</version_id>
+  <version_modified>20220223T012006Z</version_modified>
   <xml_checksum>FFE04372</xml_checksum>
   <class_name>TimeseriesPlot</class_name>
   <display_name>Timeseries Plot</display_name>
@@ -17,19 +16,13 @@
       <display_name>Enter Variable Name.</display_name>
       <description>Valid values can be found in the eplusout.rdd file after a simulation is run.</description>
       <type>String</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
-      <default_value></default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>reporting_frequency</name>
       <display_name>Reporting Frequency.</display_name>
-      <description></description>
       <type>Choice</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>Hourly</default_value>
@@ -63,32 +56,24 @@
           <display_name>Runperiod</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>key_value</name>
       <display_name>Enter Key Name.</display_name>
       <description>Enter * for all objects or the full name of a specific object to.</description>
       <type>String</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>*</default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
     <argument>
       <name>env</name>
       <display_name>availableEnvPeriods</display_name>
       <description>availableEnvPeriods</description>
       <type>String</type>
-      <units></units>
       <required>true</required>
       <model_dependent>false</model_dependent>
       <default_value>RUN PERIOD 1</default_value>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
   </arguments>
   <outputs />
@@ -120,12 +105,6 @@
       <usage_type>readmeerb</usage_type>
       <checksum>703C9964</checksum>
     </file>
-    <file>
-      <filename>README.md</filename>
-      <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>0B68E96D</checksum>
-    </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
@@ -141,13 +120,19 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>B9530362</checksum>
+      <checksum>210E98F2</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>A3A04D6D</checksum>
     </file>
     <file>
       <filename>report.html.erb</filename>
       <filetype>erb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>B15A43C9</checksum>
+      <checksum>279ABA14</checksum>
     </file>
   </files>
 </measure>

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