openstudio-calibration 0.1.3 → 0.5.0

data/lib/measures/TimeseriesObjectiveFunction/measure.xml

@@ -1,9 +1,10 @@
+<?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
   <name>timeseries_objective_function</name>
   <uid>6804217d-4737-45f3-82df-b81393c29ce3</uid>
-  <version_id>cd719981-451c-476a-b4d9-bec827cb0b9b</version_id>
-  <version_modified>20200331T151749Z</version_modified>
+  <version_id>bdebe708-959f-448c-bcfe-085253520b90</version_id>
+  <version_modified>20210423T201838Z</version_modified>
   <xml_checksum>FFE04372</xml_checksum>
   <class_name>TimeseriesObjectiveFunction</class_name>
   <display_name>TimeSeries Objective Function</display_name>
@@ -15,33 +16,43 @@
       <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>
@@ -67,21 +78,27 @@
           <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 => mm:dd:yy or mm:dd (true/false)</description>
+      <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>
@@ -95,12 +112,15 @@
           <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 => hh:mm:ss or hh:mm (true/false)</description>
+      <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>
@@ -114,32 +134,42 @@
           <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>
@@ -166,39 +196,51 @@
           <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>
@@ -212,12 +254,15 @@
           <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>
@@ -231,12 +276,15 @@
           <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>
@@ -250,21 +298,27 @@
           <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>
@@ -278,12 +332,15 @@
           <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>
@@ -297,12 +354,15 @@
           <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>
@@ -316,12 +376,15 @@
           <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>
@@ -335,6 +398,8 @@
           <display_name>false</display_name>
         </choice>
       </choices>
+      <min_value></min_value>
+      <max_value></max_value>
     </argument>
   </arguments>
   <outputs>
@@ -342,39 +407,49 @@
       <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>
-  <provenances/>
+  <provenances />
   <tags>
     <tag>Reporting.QAQC</tag>
   </tags>
@@ -406,13 +481,13 @@
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>3F176FE0</checksum>
+      <checksum>7DE1F2CF</checksum>
     </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>E0468DD6</checksum>
+      <checksum>A21A3ED2</checksum>
     </file>
     <file>
       <version>
@@ -423,13 +498,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>5DF37720</checksum>
+      <checksum>98EED533</checksum>
     </file>
     <file>
       <filename>report.html.erb</filename>
       <filetype>erb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>0BA3EB44</checksum>
+      <checksum>6113CF65</checksum>
     </file>
   </files>
 </measure>

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:
@@ -37,6 +37,11 @@
 
 
 
+
+
+
+
+
 <!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
-ReportingMeasure
+ModelMeasure
 
 ## Taxonomy
 
@@ -19,38 +19,8 @@ ReportingMeasure
 ## 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:

data/lib/measures/TimeseriesPlot/measure.xml

@@ -1,9 +1,10 @@
+<?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
   <name>timeseries_plot</name>
   <uid>6804217d-4737-45f3-82df-b81393c29ce7</uid>
-  <version_id>eaeb6d82-5b2c-47df-b17a-5bc25079efde</version_id>
-  <version_modified>20200331T151749Z</version_modified>
+  <version_id>c5ed3fd0-c97b-418b-9af6-3b960508699e</version_id>
+  <version_modified>20210423T201838Z</version_modified>
   <xml_checksum>FFE04372</xml_checksum>
   <class_name>TimeseriesPlot</class_name>
   <display_name>Timeseries Plot</display_name>
@@ -15,13 +16,19 @@
       <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>
@@ -55,28 +62,36 @@
           <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/>
-  <provenances/>
+  <outputs />
+  <provenances />
   <tags>
     <tag>Reporting.QAQC</tag>
   </tags>
@@ -98,12 +113,6 @@
     </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>
@@ -114,7 +123,13 @@
       <filename>README.md</filename>
       <filetype>md</filetype>
       <usage_type>readme</usage_type>
-      <checksum>A3A04D6D</checksum>
+      <checksum>0B68E96D</checksum>
+    </file>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>A21A3ED2</checksum>
     </file>
     <file>
       <version>
@@ -125,13 +140,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>76613086</checksum>
+      <checksum>B9530362</checksum>
     </file>
     <file>
       <filename>report.html.erb</filename>
       <filetype>erb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>8A46D937</checksum>
+      <checksum>B15A43C9</checksum>
     </file>
   </files>
 </measure>

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:
@@ -37,6 +37,11 @@
 
 
 
+
+
+
+
+
 <!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: