cideMOD.cell

This module provides cell classes and functions to read/process battery related information

Functions

register_cell_component(name[, parser_cls, ...])

This method allows to register new cell components
cideMOD.cell.register_cell_component(name: str, parser_cls: BaseComponentParser | dict | None = None, component_cls: BaseCellComponent | dict | None = None, tags: List[str] | str | None = None, root: str | None = None)[source]

This method allows to register new cell components

Parameters:

  • name (str) – Name of the component. It must be a valid identifier.

  • parser_cls (Optional[Union[BaseComponentParser, dict]]) – Object where component parameters are parsed. If not provided or the class dictionary is provided instead, then the class is created dinamically.

  • component_cls (Optional[Union[BaseCellComponent, dict]]) – Object where component parameters are preprocessed and stored. If not provided or the class dictionary is provided instead, then the class is created dinamically.

  • tags (Optional[Union[List[str], str]]) – Allowed tags for the component. Used to differenciate the component instances.

  • root (Optional[List[str], str]) – Name of the root component.

Modules

cideMOD.cell.components

cell_components creates and initializes the corresponding battery components attributes.

cideMOD.cell.dimensional_analysis

cideMOD.cell.equations

cideMOD.cell.parameters

cideMOD.cell.parser

cideMOD.cell.variables

cideMOD.cell.warehouse