3.0
timeseries_objective_function
6804217d-4737-45f3-82df-b81393c29ce3
8ef8945d-1fb3-4f48-afbb-8c13e023a976
20221115T231441Z
FFE04372
TimeseriesObjectiveFunction
TimeSeries Objective Function
Creates Objective Function from Timeseries Data
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.
csv_name
Path to CSV file for the metered data
Path to CSV file including file name.
String
true
false
../../../lib/resources/mtr.csv
csv_time_header
CSV Time Header
CSV Time Header Value. Used to determine the timestamp column in the CSV file
String
true
false
Date/Time
csv_var
CSV variable name
CSV variable name. Used to determine the variable column in the CSV file
String
true
false
Whole Building:Facility Total Electric Demand Power [W](TimeStep)
convert_data
Convert Units
Convert Units in Metered Data
Choice
true
false
None
F to C
F to C
WH to J
WH to J
CFM to m3/s
CFM to m3/s
PSI to Pa
PSI to Pa
None
None
csv_var_dn
CSV variable display name
CSV variable display name. Not yet Implemented
String
true
false
year
Year in csv data timestamp
Is the Year in the csv data timestamp => mm:dd:yy or mm:dd (true/false)
Boolean
true
false
true
true
true
false
false
seconds
Seconds in csv data timestamp
Is the Seconds in the csv data timestamp => hh:mm:ss or hh:mm (true/false)
Boolean
true
false
true
true
true
false
false
key_value
SQL key value
SQL key value for the SQL query to find the variable in the SQL file
String
true
false
timeseries_name
TimeSeries Name
TimeSeries Name for the SQL query to find the variable in the SQL file
String
true
false
Facility Total Electric Demand Power
reporting_frequency
Reporting Frequency
Reporting Frequency for SQL Query
Choice
true
false
Detailed
Detailed
Timestep
Timestep
Hourly
Hourly
Daily
Daily
Monthly
Monthly
RunPeriod
RunPeriod
environment_period
Environment Period
Environment Period for SQL query
String
true
false
RUN PERIOD 1
norm
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.
Double
true
false
1
scale
Scale factor to apply to the difference
Scale factor to apply to the difference (1 is no scale)
Double
true
false
1
find_avail
Find Available data in the SQL file
Will RegisterInfo all the 'EnvPeriod', 'ReportingFrequencies', 'VariableNames', 'KeyValues' in the SQL file. Useful for debugging SQL issues.
Boolean
true
false
true
true
true
false
false
algorithm_download
algorithm_download
Make JSON data available for algorithm_download (true/false)
Boolean
true
false
false
true
true
false
false
plot_flag
plot_flag timeseries data
Create plot of timeseries data (true/false)
Boolean
true
false
true
true
true
false
false
plot_name
Plot name
Name to include in reporting file name.
String
true
false
verbose_messages
verbose_messages
verbose messages. Useful for debugging but MAJOR Performance Hit.
Boolean
true
false
false
true
true
false
false
warning_messages
warning_messages
Warn on missing data.
Boolean
true
false
true
true
true
false
false
add_first_zero_for_plots
add_first_zero_for_plots
Add a point of zero value to the plot at the beginning of the runperiod.
Boolean
true
false
false
true
true
false
false
add_last_zero_for_plots
add_last_zero_for_plots
Add a point of zero value to the plot at the end of the runperiod.
Boolean
true
false
false
true
true
false
false
Reporting.QAQC
Intended Software Tool
OpenStudio Application
string
Intended Software Tool
Parametric Analysis Tool
string
Measure Type
ReportingMeasure
string
README.md.erb
erb
readmeerb
703C9964
README.md
md
readme
3F176FE0
LICENSE.md
md
license
64FFEBDE
OpenStudio
2.1.0
2.1.0
measure.rb
rb
script
9C10E3CE
report.html.erb
erb
resource
169BF9E9