reV.utilities.cli_functions.compile_descriptions

compile_descriptions(cols=None)

Compile a meta table with reV column descriptions.

Descriptions are pulled from the SupplyCurveField enum, which contains the known reV supply curve field descriptions. Columns which do not have a known description are excluded from the output.

Parameters:

cols (iterable, optional) – Optional iterable of column names to include in the output. By default, None, which compiles all known reV supply curve field descriptions.

Returns:

pd.DataFrame – Pandas DataFrame containing column names, corresponding units, and descriptions for each column. Only columns that have a known description are included in the output.