teehr.evaluation.metrics.Metrics.add_calculated_fields

Metrics.add_calculated_fields(cfs: CalculatedFieldBaseModel | List[CalculatedFieldBaseModel])

Add calculated fields to the joined timeseries DataFrame before running metrics.

Parameters:

cfs (Union[CalculatedFieldBaseModel, List[CalculatedFieldBaseModel]]) – The CFs to apply to the DataFrame.

Returns:

self – The Metrics object with the CFs applied to the DataFrame.

Examples

>>> import teehr
>>> from teehr import RowLevelCalculatedFields as rcf
>>> ev.join_timeseries.add_calculated_fields([
>>>     rcf.Month()
>>> ]).write()