Commit 13dfc9f0 authored by niklas.baumgarten's avatar niklas.baumgarten
Browse files

upodated readme

parent 2704ca50
## Getting Started
M++ is a parallel PDE solving software requiring some preinstalled
packages. This guide hopefully walks you through the installation
process.
### Prerequisites
This version of M++ uses CMake as building tool. If you haven't
installed CMake Version 3.5.1 or higher, find out about the installation
process on https://cmake.org/download/. Alternatively, if you use a
Unix based system run: ```sudo apt install cmake```
Furthermore, you need the packages BLAS (Basic Linear Algebra
Subroutines) and LAPACK (Linear Algebra PACKage). Find out more on
https://www.netlib.org/blas/ and https://www.netlib.org/lapack/.
On Unix based systems run: ```sudo apt install libblas-dev
liblapack-dev```
Most importantly, M++ is a is a parallel PDE solving software. In order
to distribute your computations on parallel processes you need to have
Open MPI (Massage Passing Interface) installed. If not installed, get
a version of Open MPI (e.g. 2.1) on
https://www.open-mpi.org/software/ompi/v2.1/ and follow the installation
instructions. Again, using APT: ```sudo apt install openmpi-bin
libopenmpi-dev```
### Installing M++
To install M++ simply clone this git repository with
```git clone https://git.scc.kit.edu/yq8188/mpp.git```. Then change into
the project root, create a new build folder ```mkdir build``` and run in
the build folder ```cmake ..```. CMake generates a Makefile tailored to
your system. Run ```make -j``` to finally build the project.
### Additional branch related installations
M++ is used as a submodule in different applications:
* MLMC: https://git.scc.kit.edu/yq8188/mlmc
* Tutorial: https://git.scc.kit.edu/yq8188/tutorial
* Cardmech:
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment