BattMo

The Battery Modelling Toolbox (BattMo) is a resource for continuum modelling of electrochemical devices in MATLAB.
https://github.com/BattMoTeam/BattMo

Category: Energy Storage
Sub Category: Battery

Keywords from Contributors

automatic-differentiation blackoil co2-sequestration compositional finite-volume multiscale porous-media-flow reservoir-simulation

Last synced: about 9 hours ago
JSON representation

Repository metadata

Continuum modelling for electrochemical devices.

• Host: GitHub
• URL: https://github.com/BattMoTeam/BattMo
• Owner: BattMoTeam
• License: gpl-3.0
• Created: 2021-09-24T15:03:02.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-12-11T20:56:24.000Z (14 days ago)
• Last Synced: 2025-12-22T02:35:21.115Z (4 days ago)
• Language: MATLAB
• Homepage: https://battmoteam.github.io/BattMo/
• Size: 124 MB
• Stars: 51
• Watchers: 4
• Forks: 14
• Open Issues: 11
• Releases: 5
• Metadata Files:
  • Readme: readme.rst
  • License: COPYING
  • Citation: CITATION.cff

readme.rst

          ==========================================================================
 BattMo is a framework for continuum modelling of electrochemical devices.
==========================================================================

.. |zenodo| image:: https://zenodo.org/badge/410005581.svg
   :target: https://zenodo.org/badge/latestdoi/410005581

.. |runGitHubTests| image:: https://github.com/BattMoTeam/BattMo/actions/workflows/runGitHubTests.yml/badge.svg

.. |doc| image:: https://github.com/BattMoTeam/BattMo/actions/workflows/doc.yml/badge.svg

|zenodo| |runGitHubTests| |doc|

The Battery Modelling Toolbox (**BattMo**) is a resource for continuum modelling of electrochemical devices in MATLAB. The initial development features a pseudo X-dimensional (PXD) framework for the Doyle-Fuller-Newman model of lithium-ion battery cells. However, the development plan for BattMo includes extensions to other battery chemistries (e.g. metal-air) and eventually hydrogen systems (i.e. electrolyzers and fuel cells).

**BattMo** offers users a flexible framework for building fully coupled electrochemical-thermal simulations of electrochemical devices using 1D, 2D, or 3D geometries. **BattMo** is implemented in MATLAB and builds on the open-source MATLAB Reservoir Simulation Toolbox (`MRST `_) developed at SINTEF. MRST provides a solid basis for finite volume grid generation of complex geometries and advanced numerical solvers that enable fast simulations for large systems.

For the latest information including video tutorials and project gallery, please visit the project webpage:
`https://batterymodel.com `_

The documentation is found at the `documentation webpage `_. We try to do our best to keep it up-to-date.

.. raw:: html

   

Installation
------------

Before cloning this reposity you must make sure you have **Git LFS** installed. See `https://git-lfs.com` for instructions on downloading and installation.

BattMo is based on `MRST `_, which provides a general unstructured grid format,
generic MATLAB automatic differentiation tools and Newton solvers. The MRST source code wil be installed directly via
**git submodules**. To install BattMo, you have therefore to clone this repository with the submodule option
``--recurse-submodules``, as follows:

``git clone --recurse-submodules https://github.com/BattMoTeam/BattMo.git``

Then start MATLAB and in the directory where you cloned the repository, run:

``startupBattMo``

You can check that that your installation is setup correctly by running one of the example scripts:

``runBatteryP2D``

Update
------

To update you code after you installed it as described above, use the standard :code:`git pull` command.

If your initial installation has been done before November 7th 2024, we recommend to start the installation all over
again.

Iterative solvers
-----------------

Iterative solvers are needed to solve large problems with many degrees
of freedom. The 2012 **open source** version of the `AGMG
`_ iterative solver is provided as a
`submodule `_, as well as `AMGCL
`_ are supported.

Tutorials
---------

Tutorials are presented in `documentation `_.

Acknowledgements
-----------------
BattMo has received funding from the European Union’s Horizon 2020 innovation program under grant agreement numbers:

* 875527 HYDRA
* 957189 BIG-MAP
* 101104013 BATMAX
* 101103997 DigiBatt 
* 101069765 IntelLiGent

        

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
title: "BattMo: The Battery Modelling Toolbox"
version: 0.3.0
date-released: 2024-02-08
url: "https://github.com/BattMoTeam/BattMo"
doi: "10.5281/zenodo.10633682"
authors:
  - given-names: Simon
    family-names: Clark
  - given-names: Eibar
    family-names: Flores
  - given-names: Lorena
    family-names: Hendrix
  - given-names: August
    family-names: Johansson
  - given-names: Sridevi
    family-names: Krishnamurthi
  - given-names: Halvor
    family-names: Moll Nilsen
  - given-names: Xavier
    family-names: Raynaud
  - given-names: Francesca
    family-names: Watson

---

Owner metadata

• Name: BatteryModel.com
• Login: BattMoTeam
• Email: simon.clark@sintef.no
• Kind: organization
• Description: Models for batteries and electrochemical devices.
• Website: www.batterymodel.com
• Location: Norway
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/91334501?v=4
• Repositories: 19
• Last ynced at: 2024-04-17T14:04:27.608Z
• Profile URL: https://github.com/BattMoTeam

---

GitHub Events

Total

• Issues event: 1
• Watch event: 15
• Delete event: 8
• Issue comment event: 3
• Member event: 1
• Push event: 348
• Pull request event: 17
• Fork event: 3
• Create event: 34

Last Year

• Issues event: 1
• Watch event: 4
• Delete event: 8
• Issue comment event: 3
• Member event: 1
• Push event: 269
• Pull request event: 16
• Fork event: 2
• Create event: 30

---

Committers metadata

Last synced: about 19 hours ago

Name	Email	Commits
Xavier Raynaud	x****d@s****o	3494
August Johansson	a****n@s****o	444
hnil	H****n@s****o	58
Francesca Watson	f****n@s****o	54
Lorena Hendrix	l****3@g****m	52
Simon Clark	s****k@s****o	48
Sridevi Krishnamurthi	s****i@s****o	26
Timothee-deB	t****y@p****u	17
Andreas Solheim	s****m@p****n	15
Erasdna	s****s@g****m	13
hnil	h****n@s****o	13
zbre2	v****5@g****m	12

Committer domains:

• sintef.no: 7
• pop-os.localdomain: 1
• polytechnique.edu: 1

---

Issue and Pull Request metadata

Last synced: 13 days ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/BattMoTeam/BattMo

---

---

---

Package metadata

• Total packages: 2
• Total downloads: unknown
• Total dependent packages: 0 (may contain duplicates)
• Total dependent repositories: 0 (may contain duplicates)
• Total versions: 10

Score: -Infinity