Skip to main content

Build Coverage Status readthedocs release

MPET -- Multiphase Porous Electrode Theory

This software is designed to run simulations of batteries with porous electrodes using porous electrode theory, which is a volume-averaged, multiscale approach to capture the coupled behavior of electrolyte and active material within electrodes. As a result, with physical parameter inputs and run protocols (specified current or voltage profiles), it makes predictions about the internal dynamics within a battery (electrolyte concentration and potential, solid phase concentrations, reaction rates, etc.) and also macroscopic, easily measurable electrochemical quantities such as total current and voltage. In this way, it is similar to the dualfoil code released by Newman and coworkers from Berkeley. This software has much of the functionality contained in dualfoil (it is currently missing, e.g., temperature dependence). However, beyond the standard porous electrode theory simulations, this software can also simulate electrodes in which the active materials phase separate using non-equilibrium thermodynamics within a phase field modeling framework. Such behavior is common in widely used electrode materials, including graphite and LiFePO4.

If you use this software in academic work, please cite the relevant references detailing its development as presented in the LICENSE file. For more details on the theory implemeneted in the code, see:

Smith, R. B., and Bazant M. Z., Multiphase Porous Electrode Theory, Journal of the Electrochemical Society, 2017, 164 (11) E3291-E3310, arXiv preprint.

Documentation

Documentation is available here (https://mpet.readthedocs.io) for installing, running, and analyzing results with mpet.

Troubleshooting

Please use the Issues section of of this repository to ask questions or file bug reports with the software.

Release files for mpet 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mpet 1.0.0
File Size Uploaded
mpet-1.0.0.tar.gz 94.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mpet 1.0.0
File Interpreter ABI Platform
mpet-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 208.1 kB

Release files / mpet-1.0.0.tar.gz

Download URL mpet-1.0.0.tar.gz
Size 94.6 kB
Tags Source
SHA-256 checksum
How to use checksums
e86ec9d87cda125f76588d39f3baa036108a90a3faba1b827c7612d86cde2f95
BLAKE2b-256 checksum
How to use checksums
3491fde504339cc0c11e1f6aeb934adbf79dbc661701282bd59806d5cb526cb6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.12

Release files / mpet-1.0.0-py3-none-any.whl

Download URL mpet-1.0.0-py3-none-any.whl
Size 113.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0ef6d9bd87a55f0d78b026b2fc99c979995c1469b24367dd3e4a61f036192756
BLAKE2b-256 checksum
How to use checksums
1b3effda2b54b66066111f24ee787b82ef165ed07fb628d5b651442fdf1fa159
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.12

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page