Energy Conservation Measure

TimeSeries Objective Function

Name 
timeseries_objective_function
Display Name 
TimeSeries Objective Function
UID
6804217d-4737-45f3-82df-b81393c29ce3

Version ID
bdebe708-959f-448c-bcfe-085253520b90
Class Name 
TimeseriesObjectiveFunction
Version Modified 
20210423T201838Z
Schema Version 
3.0
Rating 
0
No votes yet
Attributes 
Intended Software ToolOpenStudio Application
Intended Software ToolParametric Analysis Tool
Measure TypeReportingMeasure

Details

DescriptionCreates Objective Function from Timeseries Data
Modeler DescriptionCreates 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.
Files 
README.md.erb
README.md
LICENSE.md
measure.rb
OpenStudio 2.1.0
Min Compatible Version: 2.1.0
report.html.erb
Content visibility 
Use group defaults
Download

Measure Arguments

NameDisplay NameShort NameDescriptionUnitsTypeRequiredModel DependentDefault ValueChoicesMin ValueMax Value
csv_namePath to CSV file for the metered data-Path to CSV file including file name.-Stringtruefalse../../../lib/resources/mtr.csv---
csv_time_headerCSV Time Header-CSV Time Header Value. Used to determine the timestamp column in the CSV file-StringtruefalseDate/Time---
csv_varCSV variable name-CSV variable name. Used to determine the variable column in the CSV file-StringtruefalseWhole Building:Facility Total Electric Demand Power [W](TimeStep)---
convert_dataConvert Units-Convert Units in Metered Data-ChoicetruefalseNoneF to C
WH to J
CFM to m3/s
PSI to Pa
None
--
csv_var_dnCSV variable display name-CSV variable display name. Not yet Implemented-Stringtruefalse----
yearYear in csv data timestamp-Is the Year in the csv data timestamp => mm:dd:yy or mm:dd (true/false)-Booleantruefalsetruetrue
false
--
secondsSeconds in csv data timestamp-Is the Seconds in the csv data timestamp => hh:mm:ss or hh:mm (true/false)-Booleantruefalsetruetrue
false
--
key_valueSQL key value-SQL key value for the SQL query to find the variable in the SQL file-Stringtruefalse----
timeseries_nameTimeSeries Name-TimeSeries Name for the SQL query to find the variable in the SQL file-StringtruefalseFacility Total Electric Demand Power---
reporting_frequencyReporting Frequency-Reporting Frequency for SQL Query-Choicetruefalse-Detailed
Timestep
Hourly
Daily
Monthly
RunPeriod
--
environment_periodEnvironment Period-Environment Period for SQL query-StringtruefalseRUN PERIOD 1---
normNorm 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.-Doubletruefalse1---
scaleScale factor to apply to the difference-Scale factor to apply to the difference (1 is no scale)-Doubletruefalse1---
find_availFind Available data in the SQL file-Will RegisterInfo all the 'EnvPeriod', 'ReportingFrequencies', 'VariableNames', 'KeyValues' in the SQL file. Useful for debugging SQL issues.-Booleantruefalsetruetrue
false
--
algorithm_downloadalgorithm_download-Make JSON data available for algorithm_download (true/false)-Booleantruefalsefalsetrue
false
--
plot_flagplot_flag timeseries data-Create plot of timeseries data (true/false)-Booleantruefalsetruetrue
false
--
plot_namePlot name-Name to include in reporting file name.-Stringtruefalse----
verbose_messagesverbose_messages-verbose messages. Useful for debugging but MAJOR Performance Hit.-Booleantruefalsefalsetrue
false
--
warning_messageswarning_messages-Warn on missing data.-Booleantruefalsetruetrue
false
--
add_first_zero_for_plotsadd_first_zero_for_plots-Add a point of zero value to the plot at the beginning of the runperiod.-Booleantruefalsefalsetrue
false
--
add_last_zero_for_plotsadd_last_zero_for_plots-Add a point of zero value to the plot at the end of the runperiod.-Booleantruefalsefalsetrue
false
--

Measure Outputs

NameDisplay NameShort NameDescriptionUnitsTypeModel Dependent
diffdiffdiff--Doublefalse
simdatasimdatasimdata--Doublefalse
csvdatacsvdatacsvdata--Doublefalse
cvrmsecvrmsecvrmse--Doublefalse
nmbenmbenmbe--Doublefalse