openstudio-calibration 0.3.1 → 0.5.1

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>6cfcc6b3-3ced-42c1-9424-be644defa7f3</version_id>
-  <version_modified>20200512T180515Z</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>
@@ -481,7 +407,7 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
+      <checksum>A21A3ED2</checksum>
     </file>
     <file>
       <version>
@@ -492,20 +418,19 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>D0ED8BFA</checksum>
+      <checksum>70C9D9FB</checksum>
     </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>7DE1F2CF</checksum>
+      <checksum>3F176FE0</checksum>
     </file>
     <file>
       <filename>report.html.erb</filename>
       <filetype>erb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>40F6235C</checksum>
+      <checksum>4D36345D</checksum>
     </file>
   </files>
 </measure>
-<error>wrong number of arguments (given 1, expected 0)</error>

data/lib/measures/TimeseriesObjectiveFunction/resources/report.html.erb

@@ -1,6 +1,6 @@
 <%
   # *******************************************************************************
-  # 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:
@@ -39,6 +39,9 @@
 
 
 
+
+
+
 <!DOCTYPE html>
 <meta charset="utf-8">
 <style>

data/lib/measures/TimeseriesPlot/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+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/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

@@ -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:
@@ -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>32a66bf1-1f5f-4586-9675-0f0ee7c603c3</version_id>
-  <version_modified>20200512T180515Z</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 />
@@ -113,18 +99,18 @@
     </attribute>
   </attributes>
   <files>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
-    </file>
     <file>
       <filename>README.md.erb</filename>
       <filetype>erb</filetype>
       <usage_type>readmeerb</usage_type>
       <checksum>703C9964</checksum>
     </file>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>A21A3ED2</checksum>
+    </file>
     <file>
       <version>
         <software_program>OpenStudio</software_program>
@@ -134,20 +120,19 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>76613086</checksum>
+      <checksum>210E98F2</checksum>
     </file>
     <file>
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>0B68E96D</checksum>
+      <checksum>A3A04D6D</checksum>
     </file>
     <file>
       <filename>report.html.erb</filename>
       <filetype>erb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>90E993CA</checksum>
+      <checksum>279ABA14</checksum>
     </file>
   </files>
 </measure>
-<error>wrong number of arguments (given 1, expected 0)</error>

data/lib/measures/TimeseriesPlot/resources/report.html.erb

@@ -1,6 +1,6 @@
 <%
   # *******************************************************************************
-  # 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:
@@ -39,6 +39,9 @@
 
 
 
+
+
+
 <!DOCTYPE html>
 <meta charset="utf-8">
 <style>

data/lib/measures/WaterHeaterMixedMultiplier/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
+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/measures/WaterHeaterMixedMultiplier/measure.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: