windkit.get_uncertainty_table

windkit.get_uncertainty_table(table_name='dtu_default')

Get the wind and energy uncertainty DataFrame from the supported uncertainty tables.

The uncertainty table contains information about various types of uncertainties. Mandatory fields of an uncertainty table are: names and values of the uncertainties (as a percentage of total energy [%]). Optional fields are: category, lower and upper bounds, default values, and descriptions.

Parameters:

table_name (str) – The name of the uncertainty table to get. Default is ‘dtu_default’.

Returns:

DataFrame containing both wind and energy uncertainties.

Return type:

DataFrame

Raises:

ValueError – If the table_name is not one of the supported tables.

Notes

This function merges the wind and energy uncertainty dictionary tables into a single DataFrame.

Examples

>>> get_uncertainty_table('dtu_default')