Installation instruction and requirements

BattMo is based on MRST which provides a general unstructured grid format, generic MATLAB automatic differentiation tools and Newton solvers.

The MRST code source can be installed directlu using git submodules:

git clone --recurse-submodules

Then start Matlab and in the directory battmo where you cloned the repo, run:


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


For large models, iterative solvers are necessary. The open source version from 2012 of the AGMG iterative solver from 2012 is provided as a submodule. We plan to integrate newer open source iterative solvers such as AMGCL