Readme

The Ensign software framework facilitates the efficient implementation of dynamical low-rank algorithms both on multi-core CPU and GPUs. It provides many primitives to make the implementation of such schemes easier and can work easily with both methods based on the projector splitting and the unconventional integrator. For more details on the dynamical low-rank method and in particular the problems implemented in the examples folder see

F. Cassini, L. Einkemmer. Efficient 6D Vlasov simulation using the dynamical low-rank framework Ensign.

First clone the repository

git clone https://github.com/leinkemmer/Ensign.git

To build the software the following are needed

• CMake
• C++11 compatible C++ compiler
• Fortran compiler (if the included OpenBLAS is used)
• CUDA (if GPU support is desired)
• NetCDF (optinal, required for writing snapshots to disk)

To build the example programs and tests execute

mkdir build
cd build
cmake -DCUDA_ENABLED=ON ..
make

If you prefer to use Intel MKL as the BLAS and LAPACK backend set

mkdir build
cd build
export MKLROOT=/opt/intel/mkl
cmake -DMKL_ENABLED=ON -DCUDA_ENABLED=ON ..
make