Installation instructions

Necessary tools and library dependencies

ryujin requires deal.II version 9.2.0 or newer compiled with enabled support for MPI and P4est. On Debian and Ubuntu you can conveniently install all necessary libraries and tools with apt.

For Debian testing:

Run as root user:

apt install libdeal.ii-dev cmake make g++ ninja-build git

For Debian stable:

In order to enable buster-backports https://backports.debian.org and install all necessary packages run as root user:

mkdir -p /etc/apt/sources.list.d/
echo deb http://deb.debian.org/debian buster-backports main > /etc/apt/sources.list.d/buster-backports.conf
apt update
 
apt install libdeal.ii-dev/buster-backports libp4est-dev/buster-backports

Also make sure to have numdiff, cmake, g++, ninja and git installed:

sudo apt install numdiff
apt install cmake make g++ ninja-build git ca-certificates

For Ubuntu LTS 20.04:

In order to add the backports PPA issue the following commands:

sudo add-apt-repository ppa:ginggs/deal.ii-9.3.0-backports
sudo apt update
sudo apt install libdeal.ii-dev

Also make sure to have numdiff, cmake, g++, ninja and git installed:

sudo apt install numdiff
sudo apt install cmake make g++ ninja-build git ca-certificates

Manual compilation and installation

Instructions how to manyally compile and install deal.II can be found on the deal.II homepage, the README, and on the deal.II wiki. Make sure that deal.II is configured with MPI and P4est support and that the following additional tools are in your path: git, numdiff, cmake, make.

Retrieving and compiling ryujin

Simply check out the repository and run make:

git clone https://github.com/conservation-laws/ryujin
cd ryujin
git submodule init
git submodule update
make release

Note

The Makefile found in the repository only contains a number of convenience targets and its use is entirely optional. It will create a subdirectory build and run cmake to configure the project. The executable will be located in build/run. The convenience Makefile contains the following additional targets:

make debug       -  switch to debug build and compile program
make release     -  switch to release build and compile program
make edit_cache  -  runs ccmake in the build directory
make edit        -  open build/run/ryujin.prm in default editor
make run         -  run the program (with default config file build/run/ryujin.prm)