mpet

MPET lithium-ion battery simulator

https://github.com/TRI-AMDD/mpet

Science Score: 46.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
    Links to: arxiv.org
  • Committers with academic emails
    13 of 22 committers (59.1%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.9%) to scientific vocabulary
Last synced: 7 months ago · JSON representation

Repository

MPET lithium-ion battery simulator

Basic Info
  • Host: GitHub
  • Owner: TRI-AMDD
  • License: other
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 30.6 MB
Statistics
  • Stars: 36
  • Watchers: 6
  • Forks: 9
  • Open Issues: 11
  • Releases: 5
Created over 5 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License

README.md

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.

Owner

  • Name: Toyota Research Institute - Accelerated Materials Design & Discovery (AMDD)
  • Login: TRI-AMDD
  • Kind: organization

GitHub Events

Total
  • Issues event: 4
  • Watch event: 12
  • Issue comment event: 1
  • Push event: 2
  • Fork event: 3
Last Year
  • Issues event: 4
  • Watch event: 12
  • Issue comment event: 1
  • Push event: 2
  • Fork event: 3

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 1,314
  • Total Committers: 22
  • Avg Commits per committer: 59.727
  • Development Distribution Score (DDS): 0.549
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Raymond Smith r****h@g****m 593
Dan Cogswell c****l@m****u 243
Leon Oostrum l****m@e****l 117
Debbie Zhuang d****g@m****u 89
Laura Ootes l****s@e****l 70
Victor Azizi v****r@l****u 59
Ombrini P****i@t****l 47
Edwin Khoo e****l@g****m 33
Dan Cogswell c****l@a****u 15
Ombrini P****1@t****l 12
Dan Cogswell 5****l@u****m 9
Tammo Schwietert t****t@t****l 9
Ombrini 9****i@u****m 5
Nicolas Renaud n****d@g****m 3
Supratim Das s****7@m****u 2
TR Ferguson t****f@m****u 2
Edwin Khoo e****l@m****u 1
Ombrini p****o@t****l 1
Spencer Patryck Delgado s****c@D****u 1
Victor Azizi b****t@l****u 1
alexandros A****s@t****l 1
unknown m****s@L****e 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 45
  • Total pull requests: 64
  • Average time to close issues: 8 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 11
  • Total pull request authors: 8
  • Average comments per issue: 1.38
  • Average comments per pull request: 2.86
  • Merged pull requests: 52
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 1
  • Average time to close issues: 23 days
  • Average time to close pull requests: 15 days
  • Issue authors: 2
  • Pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • d-cogswell (15)
  • lightningclaw001 (10)
  • loostrum (6)
  • NicoRenaud (3)
  • marbris (3)
  • v1kko (3)
  • Ombrini (1)
  • stephendkang (1)
  • laurasootes (1)
  • Yanisiqi (1)
  • vishank-u (1)
Pull Request Authors
  • d-cogswell (20)
  • lightningclaw001 (16)
  • Ombrini (8)
  • loostrum (7)
  • v1kko (6)
  • laurasootes (6)
  • NicoRenaud (1)
  • patrickherring-TRI (1)
Top Labels
Issue Labels
bug (14) enhancement (7) help wanted (6) question (1)
Pull Request Labels
documentation (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 28 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 7
  • Total maintainers: 1
pypi.org: mpet

Multiphase porous electrode theory

  • Versions: 7
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 28 Last month
Rankings
Dependent packages count: 10.0%
Dependent repos count: 21.7%
Average: 22.3%
Downloads: 35.1%
Maintainers (1)
Last synced: 7 months ago

Dependencies

setup.py pypi
  • configparser *
  • h5py *
  • matplotlib *
  • numpy *
  • pyQt5 *
  • schema *
  • scipy *
.github/workflows/mpet-code-style.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/mpet-regression-test.yml actions
  • actions/checkout v3 composite
  • conda-incubator/setup-miniconda v2 composite