mpet


Namempet JSON
Version 0.1.9 PyPI version JSON
download
home_pagehttps://bitbucket.org/bazantgroup/mpet
SummaryMultiphase porous electrode theory
upload_time2023-01-27 21:22:28
maintainer
docs_urlNone
authorDan Cogswell
requires_python>=3.6
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Build](https://img.shields.io/github/actions/workflow/status/TRI-AMDD/mpet/mpet-regression-test.yml?branch=development)](https://github.com/TRI-AMDD/mpet/actions/workflows/mpet-regression-test.yml)
[![Coverage Status](https://coveralls.io/repos/github/TRI-AMDD/mpet/badge.svg?branch=development)](https://coveralls.io/github/TRI-AMDD/mpet?branch=development)
[![readthedocs](https://readthedocs.org/projects/mpet/badge/?version=latest)](https://mpet.readthedocs.io)
[![release](https://img.shields.io/github/v/release/TRI-AMDD/mpet)](https://github.com/TRI-AMDD/mpet/releases)

# 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`](http://www.cchem.berkeley.edu/jsngrp/fortran.html) 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](https://doi.org/10.1149/2.0171711jes), 2017, 164 (11) E3291-E3310, [arXiv preprint](https://arxiv.org/abs/1702.08432).

## Documentation

Documentation is available here ([https://mpet.readthedocs.io](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.

            

Raw data

            {
    "_id": null,
    "home_page": "https://bitbucket.org/bazantgroup/mpet",
    "name": "mpet",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Dan Cogswell",
    "author_email": "cogswell@mit.edu",
    "download_url": "https://files.pythonhosted.org/packages/a3/0b/88db77ebbd35c50add066bef0a6cf7aa09b9705b06bed486b560e667fb45/mpet-0.1.9.tar.gz",
    "platform": null,
    "description": "[![Build](https://img.shields.io/github/actions/workflow/status/TRI-AMDD/mpet/mpet-regression-test.yml?branch=development)](https://github.com/TRI-AMDD/mpet/actions/workflows/mpet-regression-test.yml)\n[![Coverage Status](https://coveralls.io/repos/github/TRI-AMDD/mpet/badge.svg?branch=development)](https://coveralls.io/github/TRI-AMDD/mpet?branch=development)\n[![readthedocs](https://readthedocs.org/projects/mpet/badge/?version=latest)](https://mpet.readthedocs.io)\n[![release](https://img.shields.io/github/v/release/TRI-AMDD/mpet)](https://github.com/TRI-AMDD/mpet/releases)\n\n# MPET -- Multiphase Porous Electrode Theory\n\nThis 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`](http://www.cchem.berkeley.edu/jsngrp/fortran.html) 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.\n\nIf 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:\n\nSmith, R. B., and Bazant M. Z., Multiphase Porous Electrode Theory, [Journal of the Electrochemical Society](https://doi.org/10.1149/2.0171711jes), 2017, 164 (11) E3291-E3310, [arXiv preprint](https://arxiv.org/abs/1702.08432).\n\n## Documentation\n\nDocumentation is available here ([https://mpet.readthedocs.io](https://mpet.readthedocs.io)) for installing, running, and analyzing results with mpet.\n\n\n## Troubleshooting\n\nPlease use the Issues section of of this repository to ask questions or file bug reports with the software.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Multiphase porous electrode theory",
    "version": "0.1.9",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2f78c810cb58597f1ee3cfe34c6f81cde3a53d61abcdc21a6ce2858183b17d77",
                "md5": "700a5e487a4e1b745cf57e68223d33fb",
                "sha256": "3e2d811537d782bd388aa0113730344b8466b655d31c7fe0024b8316660680a7"
            },
            "downloads": -1,
            "filename": "mpet-0.1.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "700a5e487a4e1b745cf57e68223d33fb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 80608,
            "upload_time": "2023-01-27T21:22:26",
            "upload_time_iso_8601": "2023-01-27T21:22:26.076600Z",
            "url": "https://files.pythonhosted.org/packages/2f/78/c810cb58597f1ee3cfe34c6f81cde3a53d61abcdc21a6ce2858183b17d77/mpet-0.1.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a30b88db77ebbd35c50add066bef0a6cf7aa09b9705b06bed486b560e667fb45",
                "md5": "ab727ac7d271eb1df74a7d9618f8a1d4",
                "sha256": "d187ba3141b37d9385d3ecf5be319f2b229f89e4cd8875d1a9d6b2f423bdf8fa"
            },
            "downloads": -1,
            "filename": "mpet-0.1.9.tar.gz",
            "has_sig": false,
            "md5_digest": "ab727ac7d271eb1df74a7d9618f8a1d4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 63292,
            "upload_time": "2023-01-27T21:22:28",
            "upload_time_iso_8601": "2023-01-27T21:22:28.480332Z",
            "url": "https://files.pythonhosted.org/packages/a3/0b/88db77ebbd35c50add066bef0a6cf7aa09b9705b06bed486b560e667fb45/mpet-0.1.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-27 21:22:28",
    "github": false,
    "gitlab": false,
    "bitbucket": true,
    "bitbucket_user": "bazantgroup",
    "bitbucket_project": "mpet",
    "lcname": "mpet"
}
        
Elapsed time: 0.03215s