How stanford-developers/steer-opencell-design works
This package models lithium- and sodium-ion battery cells through a composable hierarchy, from materials to complete cell formats. The principal workflow is to define material blends and electrodes, arrange them in a layup, wrap that layup in an assembly, and place it in a cell with electrolyte and encapsulation. The README also documents electrochemical curves, cost and mass roll-ups, visualization, serialization, and database loading. Some branches reflect documented capabilities whose detailed wiring was not present in the sampled source.
Main entry points: Cells/Base.py Cell Formats · Layups/Base.py Electrode Layups · Electrodes.py Electrodes · OpenCellDataManager.py OpenCell Data Manager
Components 20
Materials and Recipes
- Active Materials
steer_opencell_design/Materials/ActiveMaterials.py - Auxiliary Materials
steer_opencell_design/Materials/Binders.py - Formulations
steer_opencell_design/Materials/Formulations.py
Cell Components
- Electrodes
steer_opencell_design/Components/Electrodes.py - Current Collectors
steer_opencell_design/Components/CurrentCollectors/Base.py - Separators
steer_opencell_design/Components/Separators.py - Electrolyte
steer_opencell_design/Materials/Electrolytes.py - Cell Containers
steer_opencell_design/Components/Containers/Base.py
Cell Construction
- Electrode Layups
steer_opencell_design/Constructions/Layups/Base.py - Laminate Layup
steer_opencell_design/Constructions/Layups/Laminate.py - Wound Assemblies
steer_opencell_design/Constructions/ElectrodeAssemblies/JellyRolls.py - Stacked Assemblies
steer_opencell_design/Constructions/ElectrodeAssemblies/Stacks.py - Cell Formats
steer_opencell_design/Constructions/Cells/Base.py - Format Geometry
steer_opencell_design/Constructions/Cells/CylindricalCell.py
Data Access
- OpenCell Data Manager
steer_opencell_design/Data/OpenCellDataManager.py - Reference Data
Model Outputs
- Cell Performance
steer_opencell_design/Constructions/Cells/Base.py - Interactive Views
steer_opencell_design/Constructions/Cells/Base.py - Cell Serialization
steer_opencell_design/Constructions/Cells/Base.py
Other components
- Cell Designer
Connections 23
- Cell Designer → Active Materials: defines materials
- Active Materials → Formulations: blends into
- Auxiliary Materials → Formulations: blends into
- Formulations → Electrodes: formulates
- Current Collectors → Electrodes: equips
- Cell Designer → Electrodes: configures
- Electrodes → Electrode Layups: arranged in
- Separators → Electrode Layups: layered with
- Electrode Layups → Laminate Layup: specializes as
- Laminate Layup → Wound Assemblies: wound into
- Electrode Layups → Stacked Assemblies: stacked into
- Cell Designer → Cell Containers: selects
- Wound Assemblies → Cell Formats: assembled into
- Stacked Assemblies → Cell Formats: assembled into
- Cell Containers → Cell Formats: encapsulates
- Electrolyte → Cell Formats: fills
- Cell Formats → Format Geometry: uses format
- Cell Formats → Cell Performance: calculates
- Cell Formats → Interactive Views: provides views
- Cell Formats → Cell Serialization: serializes
- Cell Designer → OpenCell Data Manager: loads designs
- OpenCell Data Manager → Reference Data: reads reference data
- OpenCell Data Manager → Cell Formats: loads cell designs