Skip to content
Snippets Groups Projects
Commit 83e445a1 authored by Chris Cantwell's avatar Chris Cantwell
Browse files

Merge branch 'add_readme' into 'master'

Add README.md

See merge request !18
parents 2f79a27b 1c15d8ac
No related branches found
Tags v4.3.4
1 merge request!18Add README.md
# How to install redesign-prototye
## Build Nektar++ e.g. on current master
- See README.md under [Nektar++ repository](https://gitlab.nektar.info/nektar/nektar)
- For development, the `Debug` option is recommended
- Note that the SIMD options have to be turned off, if you want to use CUDA support (Should be by default).
## Build Nektar++ redesign-prototype
In main directory of the redesign, create a `build` directory `cd` into it, configure and build via:
```bash
mkdir build
cd build
cmake ../ -DNektar++_DIR=~/code/nektarMaster/build/dist/lib64/nektar++/cmake -DCMAKE_BUILD_TYPE=Debug
make
```
If boost is not available on system, build boost (e.g. v1.71.1)
- One option is via the Ubuntu package manager `sudo apt install libboost-all-dev`
- Another option is to download boost and install it manually
After installing boost, run again:
```bash
cmake ../ -DNektar++_DIR=~/code/nektarMaster/build/dist/lib64/nektar++/cmake -DCMAKE_BUILD_TYPE=Debug
make
```
When the installation was successful, check it via tests:
```bash
ctest --output-on-failure
```
## Build Nektar++ redesign-prototype with CUDA
To build the redesign project with CUDA:
- The CUDA option must be turned on
- The SIMD option must be turned off
This can be obtained by using the following command
```bash
cmake ../ -DNektar++_DIR=~/code/nektarMaster/build/dist/lib64/nektar++/cmake -DCMAKE_BUILD_TYPE=Debug -DNEKTAR_USE_CUDA=ON -DNEKTAR_USE_SIMD=OFF
make
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment