openstudio-calibration 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eac9bb4d41324eb6e242acc9992c8537d6e04c0e5070f0f05295b629c3042174
-  data.tar.gz: 5a35325a01b65f110289464da004c64d50643442171d50d4c3123ba38afe9f45
+  metadata.gz: ae5db57508794a73f423c8ea2defcfce9d8b4b51dc3344903d1070cded32f93a
+  data.tar.gz: cdc258f217d2ab55a0c98c0ef25b59b433be718b3ac1874fdadfe4e416b768ff
 SHA512:
-  metadata.gz: 653b1de03b3e0487e3f4bad95b259f4408da04b7d24387cbed05cdcf1755821111ce4939735521de243bf83248c2df429bcb731cade49a99c056999985ca86f2
-  data.tar.gz: fbca18aea610444d1fcc04437ea33b12f8ef17849008d0f9b0d555ae434f1f163746d528fb38f7c35638649523c8c31811310d102a74d52f4c3689fcda2754d7
+  metadata.gz: c48a1b3eecdf942d97b2eb21cbaf24b44b7e8b7843cae02d6266c318e6b0a83c6a9201317f92a2163725da4c3aaeba3639c01f3403ceee8da688073069b00934
+  data.tar.gz: 251482fc84d48c19a23a41c13c90c853b55b3df22c57bb0e0c35236fe01434df4a44bce48a28470d0383ff96e90726e3458715988a5c3c90ccbefb40dca0a90b

data/.gitignore

@@ -28,3 +28,4 @@
 lib/measures/.rubocop.yml
 lib/test/*
 test_results/
+/lib/measures/*/output/

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # OpenStudio Calibration Measures Gem
 
+## Version 0.5.1
+* Fixed [#24]( https://github.com/NREL/openstudio-calibration-gem/pull/24 ), HardSizeHvac: undefined method `runSizingRun'
+* Fixed [#42]( https://github.com/NREL/openstudio-calibration-gem/pull/42 ), Update reporting measures in repo to pass in model = nil
+* Fixed [#43]( https://github.com/NREL/openstudio-calibration-gem/pull/43 ), Check all measures in this repo for multiple tags
+
 ## 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

data/lib/measures/ExteriorWallThermalPropertiesMultiplier/measure.xml

@@ -3,9 +3,9 @@
   <schema_version>3.0</schema_version>
   <name>exterior_wall_thermal_properties_multiplier</name>
   <uid>6ab39cf2-1f9e-4570-a797-360a814aaa74</uid>
-  <version_id>f6eb026d-b992-42cc-a11e-f6d8f2794127</version_id>
-  <version_modified>20210304T152734Z</version_modified>
-  <xml_checksum>31085437</xml_checksum>
+  <version_id>cc91b451-1ab1-4b68-9bef-d4e7575e6500</version_id>
+  <version_modified>20220223T012552Z</version_modified>
+  <xml_checksum>EB1A0C08</xml_checksum>
   <class_name>ExteriorWallThermalPropertiesMultiplier</class_name>
   <display_name>Exterior Wall Thermal Properties Multiplier</display_name>
   <description>Change exterior walls by altering the thermal resistance, density, and solar absorptance of the wall constructions by a Multiplier</description>
@@ -40,7 +40,6 @@
   <provenances />
   <tags>
     <tag>Envelope.Opaque</tag>
-    <tag>Calibration</tag>
   </tags>
   <attributes>
     <attribute>

data/lib/measures/ExteriorWallThermalPropertiesPercentChange/measure.xml

@@ -3,9 +3,9 @@
   <schema_version>3.0</schema_version>
   <name>exterior_wall_thermal_properties_percent_change</name>
   <uid>6ab39cf2-1f9e-4570-a797-360a814aaa64</uid>
-  <version_id>90e96c89-f488-4f6a-a12d-1f15e0c3f304</version_id>
-  <version_modified>20210304T152734Z</version_modified>
-  <xml_checksum>31085437</xml_checksum>
+  <version_id>900fc466-62cd-4726-8917-164d0e5c670f</version_id>
+  <version_modified>20220223T012552Z</version_modified>
+  <xml_checksum>EB1A0C08</xml_checksum>
   <class_name>ExteriorWallThermalPropertiesPercentChange</class_name>
   <display_name>Exterior Wall Thermal Percent Change</display_name>
   <description>Change exterior walls by altering the thermal resistance, density, and solar absorptance of the wall constructions by a Percent Change</description>
@@ -40,7 +40,6 @@
   <provenances />
   <tags>
     <tag>Envelope.Opaque</tag>
-    <tag>Calibration</tag>
   </tags>
   <attributes>
     <attribute>

data/lib/measures/HardSizeHvac/measure.rb

@@ -66,13 +66,15 @@ class HardSizeHVAC < OpenStudio::Measure::ModelMeasure
   def run(model, runner, user_arguments)
     super(model, runner, user_arguments)
 
-    # Require the HVAC sizing library
-    # require_relative 'resources/HVACSizing.Model'
+    # Make the standard applier
+    standard = Standard.build('90.1-2004') # template choice doesn't matter
 
-    # Run a sizing run and attach the resulting
-    # sql file to the model.  Hard sizing methods
-    # won't work unless the model has a sql file.
-    model.runSizingRun(Dir.pwd.to_s)
+    # Perform a sizing run (2.5.1 and later)
+    sizing_run_path = OpenStudio::Path.new(File.dirname(__FILE__) + '/output/SR1').to_s
+    runner.registerInfo("Performing sizing run at #{sizing_run_path}.")
+    if standard.model_run_sizing_run(model, sizing_run_path) == false
+      return false
+    end
 
     # Hard sizing every object in the model.
     model.applySizingValues

data/lib/measures/HardSizeHvac/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <name>hard_size_hvac</name>
   <uid>d7da749f-6318-4077-b502-25994a713b27</uid>
-  <version_id>962f9f66-5795-4157-a3ee-7a335d81b576</version_id>
-  <version_modified>20210304T152734Z</version_modified>
+  <version_id>0647d2b3-e8b0-4529-962f-dbb85d4945fa</version_id>
+  <version_modified>20220223T145950Z</version_modified>
   <xml_checksum>2B526343</xml_checksum>
   <class_name>HardSizeHVAC</class_name>
   <display_name>Hard Size HVAC</display_name>
@@ -71,12 +71,24 @@
       <version>
         <software_program>OpenStudio</software_program>
         <identifier>1.5.0</identifier>
-        <min_compatible>1.5.0</min_compatible>
+        <min_compatible>2.5.1</min_compatible>
       </version>
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>63C57B08</checksum>
+      <checksum>0920138B</checksum>
+    </file>
+    <file>
+      <filename>small_office.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>0FB2ACC8</checksum>
+    </file>
+    <file>
+      <filename>hard_size_hvac_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>FA5BB28D</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/RoofThermalPropertiesMultiplier/measure.xml

@@ -3,9 +3,9 @@
   <schema_version>3.0</schema_version>
   <name>roof_thermal_properties_multiplier</name>
   <uid>6c4eb22b-770f-456c-bcd1-084cfad89eeb</uid>
-  <version_id>9bd50108-91e3-43b5-a78e-8ccc0217b3af</version_id>
-  <version_modified>20210304T152739Z</version_modified>
-  <xml_checksum>31085437</xml_checksum>
+  <version_id>5fbeb5c9-bf38-4798-876e-ec5f23962ef0</version_id>
+  <version_modified>20220223T012552Z</version_modified>
+  <xml_checksum>EB1A0C08</xml_checksum>
   <class_name>RoofThermalPropertiesMultiplier</class_name>
   <display_name>Roof Thermal Properties Multiplier</display_name>
   <description>Change Roof by altering the thermal resistance, density, and solar absorptance of the wall constructions by a Multiplier</description>
@@ -40,7 +40,6 @@
   <provenances />
   <tags>
     <tag>Envelope.Opaque</tag>
-    <tag>Calibration</tag>
   </tags>
   <attributes>
     <attribute>

data/lib/measures/RoofThermalPropertiesPercentChange/measure.xml

@@ -3,9 +3,9 @@
   <schema_version>3.0</schema_version>
   <name>roof_thermal_properties_percent_change</name>
   <uid>07516685-60fd-4da8-9872-1154a995047d</uid>
-  <version_id>aa00c9cc-3008-44d9-90c8-a50bac1cec43</version_id>
-  <version_modified>20210304T152739Z</version_modified>
-  <xml_checksum>31085437</xml_checksum>
+  <version_id>19d0d728-74c8-4344-94ea-af1f1e406f16</version_id>
+  <version_modified>20220223T012552Z</version_modified>
+  <xml_checksum>EB1A0C08</xml_checksum>
   <class_name>RoofThermalPropertiesPercentChange</class_name>
   <display_name>Roof Thermal Properties Percent Change</display_name>
   <description>Change Roof by altering the thermal resistance, density, and solar absorptance of the wall constructions by a Percent Change</description>
@@ -40,7 +40,6 @@
   <provenances />
   <tags>
     <tag>Envelope.Opaque</tag>
-    <tag>Calibration</tag>
   </tags>
   <attributes>
     <attribute>

data/lib/measures/TimeseriesObjectiveFunction/README.md

@@ -2,16 +2,16 @@
 
 ###### (Automatically generated documentation)
 
-# 
+# TimeSeries Objective Function
 
 ## Description
-
+Creates Objective Function from Timeseries Data
 
 ## Modeler Description
-
+Creates Objective Function from Timeseries Data.  The measure applies a Norm at each timestep between the difference of CSV metered data and SQL model data. A timeseries plot can also be created.  Possible outputs are 'cvrmse', 'nmbe', 'simdata' = sum of the simulated data, 'csvdata' = sum of metered data, 'diff' = P Norm between the metered and simulated data if Norm is 1 or 2, else its just the Difference.
 
 ## Measure Type
-ModelMeasure
+ReportingMeasure
 
 ## Taxonomy
 
@@ -19,9 +19,175 @@ ModelMeasure
 ## Arguments
 
 
+### Path to CSV file for the metered data
+Path to CSV file including file name.
+**Name:** csv_name,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### CSV Time Header
+CSV Time Header Value. Used to determine the timestamp column in the CSV file
+**Name:** csv_time_header,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### CSV variable name
+CSV variable name. Used to determine the variable column in the CSV file
+**Name:** csv_var,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Convert Units
+Convert Units in Metered Data
+**Name:** convert_data,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### CSV variable display name
+CSV variable display name. Not yet Implemented
+**Name:** csv_var_dn,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Year in csv data timestamp
+Is the Year in the csv data timestamp => mm:dd:yy or mm:dd (true/false)
+**Name:** year,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Seconds in csv data timestamp
+Is the Seconds in the csv data timestamp => hh:mm:ss or hh:mm (true/false)
+**Name:** seconds,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### SQL key value
+SQL key value for the SQL query to find the variable in the SQL file
+**Name:** key_value,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### TimeSeries Name
+TimeSeries Name for the SQL query to find the variable in the SQL file
+**Name:** timeseries_name,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Reporting Frequency
+Reporting Frequency for SQL Query
+**Name:** reporting_frequency,
+**Type:** Choice,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Environment Period
+Environment Period for SQL query
+**Name:** environment_period,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Norm of the difference of csv and sql
+Norm of the difference of csv and sql. 1 is absolute value. 2 is euclidean distance. 3 is raw difference.
+**Name:** norm,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Scale factor to apply to the difference
+Scale factor to apply to the difference (1 is no scale)
+**Name:** scale,
+**Type:** Double,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Find Available data in the SQL file
+Will RegisterInfo all the 'EnvPeriod', 'ReportingFrequencies', 'VariableNames', 'KeyValues' in the SQL file.  Useful for debugging SQL issues.
+**Name:** find_avail,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### algorithm_download
+Make JSON data available for algorithm_download (true/false)
+**Name:** algorithm_download,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### plot_flag timeseries data
+Create plot of timeseries data (true/false)
+**Name:** plot_flag,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### Plot name
+Name to include in reporting file name.
+**Name:** plot_name,
+**Type:** String,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### verbose_messages
+verbose messages.  Useful for debugging but MAJOR Performance Hit.
+**Name:** verbose_messages,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### warning_messages
+Warn on missing data.
+**Name:** warning_messages,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### add_first_zero_for_plots
+Add a point of zero value to the plot at the beginning of the runperiod.
+**Name:** add_first_zero_for_plots,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
+
+### add_last_zero_for_plots
+Add a point of zero value to the plot at the end of the runperiod.
+**Name:** add_last_zero_for_plots,
+**Type:** Boolean,
+**Units:** ,
+**Required:** true,
+**Model Dependent:** false
 
 
-This measure does not have any user arguments
 
 
 

data/lib/measures/TimeseriesObjectiveFunction/measure.rb

@@ -59,7 +59,7 @@ class TimeseriesObjectiveFunction < OpenStudio::Measure::ReportingMeasure
   end
 
   # define the arguments that the user will input
-  def arguments
+  def arguments(model = nil)
     args = OpenStudio::Measure::OSArgumentVector.new
 
     # the name of the sql file

data/lib/measures/TimeseriesObjectiveFunction/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <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>
@@ -16,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>
@@ -78,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>
@@ -112,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>
@@ -134,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>
@@ -196,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>
@@ -254,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>
@@ -276,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>
@@ -298,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>
@@ -332,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>
@@ -354,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>
@@ -376,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>
@@ -398,8 +336,6 @@
           <display_name>false</display_name>
         </choice>
       </choices>
-      <min_value></min_value>
-      <max_value></max_value>
     </argument>
   </arguments>
   <outputs>
@@ -407,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>
@@ -477,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>
@@ -498,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

@@ -3,8 +3,8 @@
   <schema_version>3.0</schema_version>
   <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>
@@ -16,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>
@@ -62,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 />
@@ -119,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>
@@ -140,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/openstudio/calibration/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-calibration
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Brian Ball
 - Nicholas Long
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-10 00:00:00.000000000 Z
+date: 2022-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -276,7 +276,6 @@ files:
 - 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/.gitkeep
 - 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
@@ -296,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.5.0
-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
@@ -313,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.