API Reference¶

All public classes are re-exported from the top-level namespace for convenience:

import steer_opencell_design as ocd
cell = ocd.CylindricalCell(...)

The package is organized into three layers that mirror the battery cell modeling hierarchy:

Materials¶

Raw material definitions and electrode formulations — the foundation of every cell.

Page	Key Classes
Active Materials	`CathodeMaterial`, `AnodeMaterial`
Binders	`Binder`
Conductive Additives	`ConductiveAdditive`
Electrolytes	`Electrolyte`
Other Materials	`SeparatorMaterial`, `CurrentCollectorMaterial`, `TapeMaterial`, `InsulationMaterial`, `PrismaticContainerMaterial`, `LaminateMaterial`, `FlexFrameMaterial`
Formulations	`CathodeFormulation`, `AnodeFormulation`

Physical parts built from materials.

Page	Key Classes
Electrodes	`Cathode`, `Anode`
Separators	`Separator`
Current Collectors	`NotchedCurrentCollector`, `TabWeldedCurrentCollector`, `PunchedCurrentCollector`, `TablessCurrentCollector`
Containers	`CylindricalCanister`, `PrismaticCanister`, `PouchEncapsulation`, `FlexFrameEncapsulation`, ...

Higher-level assemblies and complete cells.

Page	Key Classes
Layups	`Laminate`, `MonoLayer`, `ZFoldMonoLayer`
Electrode Assemblies	`WoundJellyRoll`, `FlatWoundJellyRoll`, `PunchedStack`, `ZFoldStack`
Cells	`CylindricalCell`, `PrismaticCell`, `PouchCell`, `FlexFrameCell`

Page	Contents
Utilities	Decorators and helper functions