Skip to content

Commit 7559720

Browse files
authored
Update README.md
1 parent ed99179 commit 7559720

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1+
[![Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://battmoteam.github.io/BattMo.jl/dev/)
2+
[![Build Status](https://github.com/battmoteam/BattMo.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/battmoteam/BattMo.jl/actions/workflows/CI.yml?query=branch%3Amain)
3+
14
# BattMo.jl is a framework for continuum modelling of lithium-ion batteries written in Julia
5+
> [!TIP]
6+
> Please see the docs for more details, tutorials and examples: https://battmoteam.github.io/BattMo.jl/dev/
7+
8+
29

310
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. This is currently a early release that implements a subset of features from the [MATLAB version of BattMo](https://github.com/BattMoTeam/BattMo) with improved numerical performance. **BattMo.jl** is based on [Jutul.jl](https://github.com/sintefmath/Jutul.jl) and uses finite-volume discretizations and automatic differentiation to simulate models in 1D, 2D and 3D.
411

512
The current implementation has two options for setting up simulation cases:
613

714
- You can read in input data prepared in the MATLAB version of BattMo (general 3D grids)
8-
- Or you can use the common BattMo JSON format to run cases (primarily 1D grids)
15+
- Or you can use the common BattMo JSON format to run cases
916

1017
<img src="docs/src/assets/battmologo_text.png" style="margin-left: 5cm" width="300px">
1118

0 commit comments

Comments
 (0)