Installation

Release installation

The latest release version of BattMo is available as a zip file. We expect it to work on MATLAB version R2022a or newer.

The latest release version of BattMo is available here as a zip file.

Create a directory where you want BattMo to be installed. Then, download battmo.zip in this directory and unzip the file
Start MATLAB and run the file startupBattMo which is located at the root of your BattMo installation directory
```
startupBattMo
```

BattMo is now installed. You can check that your installation is setup correctly by running one of the example scripts, directly from Matlab command line.

runBatteryP2D

Installation from git

To install the development version of BattMo from git, follow the installation instructions in the repository README. These cover Git LFS setup, cloning with submodules, and starting BattMo in MATLAB.

Here is video which guides you through the installation in details

For a detailed guided installation of git, you can consult this video

Update existing installation

In the case where we already have installed BattMo and you want to update to the latest version. As usual in git, you will do that by running

git pull

In addition to that, the dependencies that are given through git submodules. The are not updated often but, if it is the case, you will need to run in addition to the previous command,

git submodule update --recursive

Contributing

To contribute, please see contributing.rst.