Documentation of Ekin’s very cool code.

Contents:

• Installation
• Usage
• Cite
• Contribute

Quick Start

The CMake build framework is used in order to compile the vibrant code. To install it type the following in the root directory of the repository and make sure that you have a working GNU Fortran compiler (e.g. gfortran):

mkdir build && cd build
cmake ..
make -j 5

Optional: Test if the installation is working as expected by typing

ctest

in the build directory to run the regression tests.

For more a more fine-grained installation please refer to the documentation of vibrant.