Model API#

API definition for the aging model

class basd.simulation.model_api.BasdModelAPI[source]#

Model API of basd

abstract get_initial_state_vector(system_design: dict) → Any[source]#

abstract method to get the state vector

Parameters:

system_design – the system design as dictionary extracted from the report

Returns:

a custom defined state vector for the models should be returned

abstract cyclic_aging(state_vector: Any, profile: DataFrame, ambient_temperature: float, system_design: dict) → dict[source]#

abstract method for the cyclic aging model

Parameters:

  • state_vector – one specific state vector

  • profile – a profile as pandas DataFrame

  • ambient_temperature – the ambient temperature during the usage of the battery cell

  • system_design – the system design as dictionary extracted from the report

abstract calendric_aging(state_vector: Any, duration: int, ambient_temperature: float) → dict[source]#

abstract method for the calendric aging model

Parameters:

  • state_vector – one specific state vector

  • duration – the storage duration in days

  • ambient_temperature – the ambient temperature during the storage of the battery cell