openstudio-calibration 0.1.3 → 0.5.0

data/lib/measures/CalibrationReportsEnhanced21/README.md

@@ -1,109 +0,0 @@
-
-
-###### (Automatically generated documentation)
-
-# Calibration Reports Enhanced
-
-## Description
-This measure is intended for calibibration of modeled results against user entered utility bill.
-
-## Modeler Description
-Measure looks at consumption for electricity and natural gas, and demand for electricity. It is inteneded to be used with no more than one gas an electric bills. Each bill can have multiple billing periods. Make sure ot use an AMY matching the utility data time frame.
-
-## Measure Type
-ReportingMeasure
-
-## Taxonomy
-
-
-## Arguments
-
-
-### Electric NMBE limit (%)
-
-**Name:** electric_nmbe_limit,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Electric CVRMSE limit (%)
-
-**Name:** electric_cvrmse_limit,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Gas NMBE limit (%)
-
-**Name:** gas_nmbe_limit,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-### Gas CVRMSE limit (%)
-
-**Name:** gas_cvrmse_limit,
-**Type:** Double,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-
-
-
-
-## Outputs
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-electricity_consumption_actual, electricity_consumption_modeled, electricity_consumption_cvrmse, electricity_consumption_nmbe, electricity_sum_of_squares, electricity_dof, electricity_rmse, electricity_peak_demand_nmbe, electricity_peak_demand_actual, electricity_peak_demand_modeled, natural_gas_consumption_actual, natural_gas_consumption_modeled, natural_gas_consumption_cvrmse, natural_gas_consumption_nmbe, natural_gas_sum_of_squares, natural_gas_dof, natural_gas_rmse, total_sum_of_squares, total_dof, total_rmse, electricity_cvrmse_within_limit, electricity_nmbe_within_limit, natural_gas_cvrmse_within_limit, natural_gas_nmbe_within_limit

data/lib/measures/CalibrationReportsEnhanced21/README.md.erb

@@ -1,42 +0,0 @@
-<%#= README.md.erb is used to auto-generate README.md. %>
-<%#= To manually maintain README.md throw away README.md.erb and manually edit README.md %>
-###### (Automatically generated documentation)
-
-# <%= name %>
-
-## Description
-<%= description %>
-
-## Modeler Description
-<%= modelerDescription %>
-
-## Measure Type
-<%= measureType %>
-
-## Taxonomy
-<%= taxonomy %>
-
-## Arguments
-
-<% arguments.each do |argument| %>
-### <%= argument[:display_name] %>
-<%= argument[:description] %>
-**Name:** <%= argument[:name] %>,
-**Type:** <%= argument[:type] %>,
-**Units:** <%= argument[:units] %>,
-**Required:** <%= argument[:required] %>,
-**Model Dependent:** <%= argument[:model_dependent] %>
-<% end %>
-
-<% if arguments.size == 0 %>
-<%= "This measure does not have any user arguments" %>
-<% end %>
-
-<% if outputs.size > 0 %>
-## Outputs
-<% output_names = [] %>
-<% outputs.each do |output| %>
-<% output_names << output[:display_name] %>
-<% end %>
-<%= output_names.join(", ") %>
-<% end %>