Data

Tools

Indexes

Applications

Experiments

Open Source Science

battmo

Continuum modelling for electrochemical devices.

https://github.com/battmoteam/battmo

Science Score: 64.0%

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

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    1 of 11 committers (9.1%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.2%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Continuum modelling for electrochemical devices.

Basic Info
Statistics
  • Stars: 49
  • Watchers: 4
  • Forks: 13
  • Open Issues: 9
  • Releases: 5
Created over 4 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

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

Owner

  • Name: BatteryModel.com
  • Login: BattMoTeam
  • Kind: organization
  • Email: simon.clark@sintef.no
  • Location: Norway

Models for batteries and electrochemical devices.

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

GitHub Events

Total
  • Issues event: 1
  • Watch event: 14
  • Delete event: 8
  • Issue comment event: 3
  • Member event: 1
  • Push event: 309
  • Pull request event: 15
  • Fork event: 3
  • Create event: 29
Last Year
  • Issues event: 1
  • Watch event: 14
  • Delete event: 8
  • Issue comment event: 3
  • Member event: 1
  • Push event: 311
  • Pull request event: 15
  • Fork event: 3
  • Create event: 29

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 3,987
  • Total Committers: 11
  • Avg Commits per committer: 362.455
  • Development Distribution Score (DDS): 0.185
Past Year
  • Commits: 360
  • Committers: 6
  • Avg Commits per committer: 60.0
  • Development Distribution Score (DDS): 0.175
Top Committers
Name Email Commits
Xavier Raynaud x****d@g****m 3,250
August Johansson a****n@s****o 441
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
Committer Domains (Top 20 + Academic)
sintef.no: 6 pop-os.localdomain: 1 polytechnique.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 14
  • Total pull requests: 25
  • Average time to close issues: 5 months
  • Average time to close pull requests: 16 days
  • Total issue authors: 6
  • Total pull request authors: 5
  • Average comments per issue: 0.14
  • Average comments per pull request: 0.08
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 1
  • Pull requests: 20
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 days
  • Issue authors: 1
  • Pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 1
View more stats
Top Authors
Issue Authors
  • jsimonclark (6)
  • xavierr (3)
  • augustjohansson (2)
  • aykharal (1)
  • bska (1)
  • sksintef (1)
Pull Request Authors
  • xavierr (12)
  • sksintef (8)
  • jsimonclark (3)
  • FrancescaWatson (1)
  • dependabot[bot] (1)
Top Labels
Issue Labels
enhancement (4) bug (3)
Pull Request Labels
dependencies (1) python (1)

Packages

  • Total packages: 2
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 10
proxy.golang.org: github.com/battmoteam/battmo
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
proxy.golang.org: github.com/BattMoTeam/BattMo
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago