Installation and First Steps

Install BattMo by cloning the git repository using --recurse-submodules to also install the MRST dependencies.

First, open a terminal and navigate to the directory where you would like to install BattMo. Then, clone the repository using the following command:

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

Start MATLAB and in the directory battmo where you cloned the repository. In the MATLAB Command Window run:

startupBattMo

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

runBatteryP2D

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 alread have installed BattMo and you want to update to the latest version. As usual in git, you will do that by runnin

git pull

In addition to that, the dependencies that are given through git submodules. To update those you need to run in addition to the previous command,

git submodule update --recursive