diff --git a/readme.rst b/readme.rst index 58901e5f..c143f0d1 100644 --- a/readme.rst +++ b/readme.rst @@ -1,9 +1,10 @@ ======================================================================== - BattMo is framework for continuum modelling of electrochemical devices. + BattMo is a framework for continuum modelling of electrochemical devices. ======================================================================== .. image:: https://zenodo.org/badge/410005581.svg :target: https://zenodo.org/badge/latestdoi/410005581 +[![MATLAB Build](https://github.com/BattMoTeam/BattMo/actions/workflows/ci.yml/badge.svg)](https://github.com/BattMoTeam/BattMo/actions/workflows/ci.yml) 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). @@ -22,7 +23,7 @@ preliminary stage, you may be interested in having a look at it. 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. +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 code source wil be installed directly via @@ -54,24 +55,24 @@ Tutorials are presented in `documentation