ebm.model.scurve module

class SCurve(earliest_age: int | None = None, average_age: int | None = None, last_age: int | None = None, rush_years: int | None = None, rush_share: float | None = None, never_share: float | None = None, building_lifetime: int = 130, building_category: str | None = 'unknown', condition: str | None = 'unknown', s: Series | None = None, df: Series | None = None)

Bases: object

__init__(earliest_age: int | None = None, average_age: int | None = None, last_age: int | None = None, rush_years: int | None = None, rush_share: float | None = None, never_share: float | None = None, building_lifetime: int = 130, building_category: str | None = 'unknown', condition: str | None = 'unknown', s: Series | None = None, df: Series | None = None)

calc_scurve() → DataFrame

get_rates_per_year_over_building_lifetime() → Series

Create a series that holds the yearly measure rates over the building lifetime.

This method defines the periods in the S-curve, adds the yearly measure rates to the corresponding periods, and stores them in a pandas Series.

Returns

pd.Series

A Series containing the yearly measure rates over the building lifetime with an index representing the age from 1 to the building lifetime.