Results Formulas

setup_results_formulas!(config, data)

Sets up the results formulas from config[:results_formulas_file], if provided, or loads a default set of formulas. See summarize_table(::Val{:results_formulas}).

summarize_table(::Val{:results_formulas})

filter_results_formulas!(data)

Filters any results formulas that depend on columns that do not exist.

add_results_formula!(data, table_name::Symbol, result_name::Symbol, formula::String, unit::Type{<:Unit}, description::String)

Adds a formula that can be used to compute results. See compute_result. This is also used by AggregationTemplate and YearlyTable.

Arguments:

• data
• table_name - the name of the table that the result is calculated from, either directly or as a combination of other results
• result_name - the name of the result being calculated. Cannot be a column name within the table.
• formula - formula can take two different forms.
  • it can be a combination of columns to be aggregated directly from table_name. I.e. "SumHourly(vom, egen)". See Sum, SumHourly, SumYearly, AverageYearly, MinHourly. Note that the columns here can either be column names or variable names stored with data, like dam_co2
  • it can also be a combination of other results. I.e. "(vom_cost + fuel_cost) / egen_total".
• unit - the Unit of the resulting number
• description - a short description of the calculation.

get_results_formulas(data)

Returns a dictionary mapping (table_name, result_name) to ResultsFormula.

get_results_formulas(data, table_name)

Returns only the results formulas corresponding to table table_name.

get_results_formula(data, table_name, result_name) -> rf::ResultsFormula

compute_result(data, table_name, result_name, idxs=(:), yr_idxs=(:), hr_idxs=(:))

Computes result result_name for table table_name for table indexes idxs, year indexes yr_idxs and hour indexes hr_idxs. See add_results_formula! to add other results formulas for computing results.

Note that this will recursively compute results for any derived result, as needed.

If any result is computed to be NaN, returns 0.0 instead, so that the NaN does not "infect" other results.

struct ResultsFormula

This is a type used to store a formula for computing a result.

Sum(cols...) <: Function

Function used in results formulas. Computes the sum of the product of the column for each index in idxs

\[\sum_{i \in \text{idxs}} \prod_{c \in \text{cols}} \text{table}[i, c]\]

SumYearly(cols...) <: Function

Function used in results formulas. This is a function that adds up the product of each of the values given to it for each year given.

\[\sum_{i \in \text{idxs}} \sum_{y \in \text{yr\_idxs}} \prod_{c \in \text{cols}} \text{table}[i, c][y]\]

AverageYearly(cols...) <: Function

Function used in results formulas. Computes the sum of the products of the columns for each index in idxs for each year, divided by the number of years.

\[\frac{\sum_{i \in \text{idxs}} \sum_{y \in \text{yr\_idxs}} \prod_{c \in \text{cols}} \text{table}[i, c][y]}{\text{length(yr\_idxs)}}\]

MinYearly(cols...) <: Function

This function returns the minimum yearly value.

\[\min_{y \in \text{yr\_idxs}} \sum_{i \in \text{idxs}, h \in \text{hr\_idxs}} \prod_{c \in \text{cols}} \text{table}[i, c][y, h]\]

MaxYearly(cols...) <: Function

This function returns the maximum yearly value.

\[\max_{y \in \text{yr\_idxs}} \sum_{i \in \text{idxs}, h \in \text{hr\_idxs}} \prod_{c \in \text{cols}} \text{table}[i, c][y, h]\]

SumHourly(cols...) <: Function

This is a function that adds up the product of each of the values given to it for each of the years and hours given.

\[\sum_{i \in \text{idxs}} \sum_{y \in \text{yr\_idxs}} \sum_{h \in \text{hr\_idxs}} \prod_{c \in \text{cols}} \text{table}[i, c][y, h]\]

SumHourlyWeighted(cols...) <: Function

This is a function that adds up the product of each of the values given to it times the hour weight for each of the years and hours given.

\[\sum_{i \in \text{idxs}} \sum_{y \in \text{yr\_idxs}} \sum_{h \in \text{hr\_idxs}} w_{h} \prod_{c \in \text{cols}} \text{table}[i, c][y, h]\]

AverageHourly(cols...) <: Function

Function used in results formulas. Computes the sum of the products of the columns for each index in idxs for each year and hour, divided by the number of hours.

\[\frac{\sum_{i \in \text{idxs}} \sum_{y \in \text{yr\_idxs}} \prod_{c \in \text{cols}} \text{table}[i, c][y]}{\sum_{y \in \text{yr\_idxs}, h \in \text{hr\_idxs}} w_{h}}\]

AverageHourlyWeighted(cols...) <: Function

Function used in results formulas. Computes the sum of the products of the columns for each index in idxs for each year and hour weighted by the number of hours, divided by the total number of hours.

\[\frac{\sum_{i \in \text{idxs}} \sum_{y \in \text{yr\_idxs}} \sum_{h \in \text{hr\_idxs}} \prod_{c \in \text{cols}} \text{table}[i, c][y]}{\sum_{y \in \text{yr\_idxs}}\sum{h \in \text{hr\_idxs}} w_{h}}\]

MinHourly(cols...) <: Function

This function returns the minimum hourly value.

\[\min_{y \in \text{yr\_idxs}, h \in \text{hr\_idxs}} \sum_{i \in \text{idxs}} \prod_{c \in \text{cols}} \text{table}[i, c][y, h]\]

MaxHourly(cols...) <: Function

This function returns the maximum aggregated hourly value. Sums up all values for that hour over the given idxs, then takes the maximum. Suited for results like load where you want to know the maximum of the regional load.

\[\max_{y \in \text{yr\_idxs}, h \in \text{hr\_idxs}} \sum_{i \in \text{idxs}} \prod_{c \in \text{cols}} \text{table}[i, c][y, h]\]

SumMinHourly(cols...) <: Function

This function returns the sum of each of the minimum hourly values.

\[\sum_{i \in \text{idxs}} \min_{y \in \text{yr\_idxs}, h \in \text{hr\_idxs}} \prod_{c \in \text{cols}} \text{table}[i, c][y, h]\]

SumMaxHourly(cols...) <: Function

This function returns the sum of each of the maximum hourly values.

\[\sum_{i \in \text{idxs}} \max_{y \in \text{yr\_idxs}, h \in \text{hr\_idxs}} \prod_{c \in \text{cols}} \text{table}[i, c][y, h]\]

CostOfServiceRebate(table_name) <: Function

This is a special function that computes the sum of the net total revenue times the regulatory factor reg_factor. This only works for the gen table and storage table.