Battery Simulation Blocks for PathSim
Project description
Battery simulation blocks for PathSim
Documentation • PathSim Homepage • GitHub
PathSim-Batt extends the PathSim simulation framework with battery cell blocks using PyBaMM as the electrochemical backend. All blocks follow the standard PathSim block interface and can be connected into simulation diagrams.
Install
pip install pathsim-batt
Blocks
| Block | Description | Key Parameters |
|---|---|---|
CellElectrothermal |
Coupled electrical + thermal cell (PathSim integrates PyBaMM ODE incl. temperature) | model, parameter_values, initial_soc |
CellElectrical |
Electrical only, isothermal; wire to LumpedThermal for external thermal coupling |
model, parameter_values, initial_soc |
LumpedThermal |
Single-node thermal model for external thermal coupling | mass, Cp, UA, T0 |
Cell is an alias for CellElectrothermal.
PyBaMM integration
The cell blocks wrap PyBaMM models behind the PathSim block interface. PyBaMM discretises the electrochemistry equations at construction time, then PathSim's numerical integrator advances the state vector using the exported ODE right-hand side.
Only models that yield a pure ODE after discretisation are supported — currently SPMe and SPM. Models such as DFN that produce a DAE system (algebraic variables) will raise NotImplementedError at construction time.
- ODE-type PyBaMM models (SPMe, SPM) can be injected via the
modelparameter - Any parameter set can be used via
parameter_values(defaults toChen2020) - Immediate initialisation — the PyBaMM model is discretised during block construction
import pybamm
model = pybamm.lithium_ion.SPMe(options={"thermal": "lumped"})
params = pybamm.ParameterValues("Mohtat2020")
cell = CellElectrothermal(model=model, parameter_values=params)
Thermal coupling modes
| Mode | Block | Owns cell temperature | Use when |
|---|---|---|---|
| Internal | CellElectrothermal |
PyBaMM | Single-cell simulations, quick setup |
| External | CellElectrical + LumpedThermal |
PathSim | Multi-cell packs, custom cooling models |
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pathsim_batt-0.1.0.tar.gz.
File metadata
- Download URL: pathsim_batt-0.1.0.tar.gz
- Upload date:
- Size: 31.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
637e1775ec6089d52cda76e9cd6e2a57e5b9ff4d002be134f0ec5809f97ba88e
|
|
| MD5 |
20da7f1ac458940c6fb7c567b545fb2b
|
|
| BLAKE2b-256 |
b7cc4e454eab7d43412b667840627eeaf758d15227bdb250dbce51e8d4caec35
|
Provenance
The following attestation bundles were made for pathsim_batt-0.1.0.tar.gz:
Publisher:
pypi_deployment.yml on pathsim/pathsim-batt
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pathsim_batt-0.1.0.tar.gz -
Subject digest:
637e1775ec6089d52cda76e9cd6e2a57e5b9ff4d002be134f0ec5809f97ba88e - Sigstore transparency entry: 1437451411
- Sigstore integration time:
-
Permalink:
pathsim/pathsim-batt@066cce159d858355a1daed113aae4d9f0e409b2f -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/pathsim
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi_deployment.yml@066cce159d858355a1daed113aae4d9f0e409b2f -
Trigger Event:
release
-
Statement type:
File details
Details for the file pathsim_batt-0.1.0-py3-none-any.whl.
File metadata
- Download URL: pathsim_batt-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8e52d97d274f1993cd12f355a9f5c7fba381696f808462f71a72637d9e871d44
|
|
| MD5 |
33a11e70eabe14700851bfcb3f85edba
|
|
| BLAKE2b-256 |
bb7d06aab71186b6804fce8f92268b72ebf90d0d3a775f537dedc896e066436e
|
Provenance
The following attestation bundles were made for pathsim_batt-0.1.0-py3-none-any.whl:
Publisher:
pypi_deployment.yml on pathsim/pathsim-batt
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pathsim_batt-0.1.0-py3-none-any.whl -
Subject digest:
8e52d97d274f1993cd12f355a9f5c7fba381696f808462f71a72637d9e871d44 - Sigstore transparency entry: 1437451484
- Sigstore integration time:
-
Permalink:
pathsim/pathsim-batt@066cce159d858355a1daed113aae4d9f0e409b2f -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/pathsim
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi_deployment.yml@066cce159d858355a1daed113aae4d9f0e409b2f -
Trigger Event:
release
-
Statement type: