Documentation

InstallationInstall deal.II, then retrieve and compile ryujin.

UsageRun the solver, write parameter files, and tune the build.

API referenceGenerated Doxygen documentation for the source tree.

SourceThe repository, issue tracker, and contribution guide.

Getting started

Install deal.II 9.6.0 or newer with MPI and P4est support, then:

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

The executable ends up at build/run/ryujin, and takes a parameter file as its single optional argument:

cd build/run
DEAL_II_NUM_THREADS=2 mpirun -np 16 ryujin prm/benchmarks/euler-mach3-cylinder-2d.prm

See Installation for platform-specific instructions and Usage for parameter files, output formats, parallelism, and compile-time options.