ebm.model.dataframemodels module

class EnergyNeedYearlyImprovements(*args, **kwargs)

Bases: DataFrameModel

building_category: Series[str] = 'building_category'

building_code: Series[str] = 'building_code'

purpose: Series[str] = 'purpose'

value: Series[float] = 'value'

start_year: Series[int] | None = 'start_year'

function: Series[str] = 'function'

end_year: Series[int] | None = 'end_year'

class Config

Bases: object

unique = ['building_category', 'building_code', 'purpose', 'start_year', 'function', 'end_year']

name = 'EnergyNeedYearlyImprovements'

class YearlyReduction(*args, **kwargs)

Bases: DataFrameModel

building_category: Series[str] = 'building_category'

building_code: Series[str] = 'building_code'

purpose: Series[str] = 'purpose'

start_year: Series[int] = 'start_year'

end_year: Series[int] = 'end_year'

yearly_efficiency_improvement: Series[float] = 'yearly_efficiency_improvement'

class Config

Bases: object

unique = ['building_category', 'building_code', 'purpose', 'start_year', 'function', 'end_year']

name = 'YearlyReduction'

static from_energy_need_yearly_improvements(en_yearly_improvement: DataFrameBase[EnergyNeedYearlyImprovements] | EnergyNeedYearlyImprovements) → DataFrameBase[YearlyReduction]

Transforms a EnergyNeedYearlyImprovement DataFrame into a EnergyNeedYearlyReduction DataFrame.

Parameters

en_yearly_improvement : DataFrame[EnergyNeedYearlyImprovements]

Returns

DataFrameBase[YearlyReduction]

Raises

pa.errors.SchemaError

When the resulting dataframe fails to validate

pa.errors.SchemaErrors

When the resulting dataframe fails to validate

class PolicyImprovement(*args, **kwargs)

Bases: DataFrameModel

building_category: Series[str] = 'building_category'

building_code: Series[str] = 'building_code'

purpose: Series[str] = 'purpose'

start_year: Series[int] = 'start_year'

end_year: Series[int] = 'end_year'

improvement_at_end_year: Series[float] = 'improvement_at_end_year'

class Config

Bases: object

unique = ['building_category', 'building_code', 'purpose', 'start_year', 'end_year']

name = 'PolicyImprovement'

classmethod start_year_before_end_year(df: DataFrame) → Series[bool]

static from_energy_need_yearly_improvements(energy_need_improvements: DataFrameBase[EnergyNeedYearlyImprovements] | EnergyNeedYearlyImprovements) → DataFrameBase[PolicyImprovement]