Tutorials

The tutorials are based upon Jupyter notebooks. Please browse through the links below and study the webpages. However, they are created from the notebooks automatically, i.e. you get the full experience only by studying the notebooks. Start with the getting started notebook below, which checks that your machine is ready for all the other tutorials.

Getting started

Build Peano with ExaHyPE 2 enabled as described in the installation instructions first. Then create a virtual environment in Peano's root directory, install the Python requirements into it, and launch Jupyter from within this environment:

python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt
cd tutorials/exahype2
jupyter lab 00_getting-started.ipynb

The notebooks set the path to Peano's Python API themselves, so you do not have to set any PYTHONPATH. When you come back later, reactivate the environment with source .venv/bin/activate before you launch Jupyter. If you prefer to start Jupyter from somewhere else, register the environment as a kernel via python -m ipykernel install --user --name peano and pick this kernel within Jupyter.

Overview

• ExaHyPE 2 - Getting prepared
• Modelling a PDE with ExaHyPE 2
  • A first advection problem with the Euler equations
  • A tsunami simulation with source code injection, SymPy, material parameters, non-conservative fluxes, and external files
• Modifying the numerics and the implementation scheme
  • Higher-order solvers: Runge Kutta and Finite Differences
  • The Euler equations with adaptive mesh refinement: a point explosion
  • Additional solver steps: postprocessing the solution after each update
• Running large parallel codes
  • Domain decomposition with an off-the-shelf heuristic
  • Offline load balancing
  • Checkpointing large parallel runs
• Coupling
  • Advanced VTK postprocessing
  • Localisation and combination of solvers
  • Coupling of various solvers
• ExaGRyPE (numerical relativity extension built on top of ExaHyPE)
  • Configure ExaGRyPE
  • ExaGRyPE standard benchmarks
    • The gauge wave: A first numerical relativity experiment with ExaGRyPE
    • A single black hole with ExaGRyPE: a first (too) trivial setup
    • Higher-order FD schemes similar to GRChombo
  • Visualization of ExaGRyPE Output
  • Run ExaGRyPE on Clusters
  • Advanced Usage of ExaGRyPE
    • Binary Black Hole Merger
    • Adding New Physics Scenarios
    • Postprocessing on-the-fly
    • Particles as Probes and Tracers
    • Coupling Multiple Numerical Schemes (Solvers)
  • Troubleshooting
• ExaSeis 2 (seismology extension built on top of ExaHyPE)
  • The shallow water equations with ADER-DG and AMR
• HPC
  
  • Working with solvers that support tasking
  • GPU support
  • Read the comments on ExaHyPE's bespoke runtime analysis features besides generic profiling
  • Consult ExaHyPE's performance optimisation recommendations
  • Implementing New Kernels
• Adding features
  • Adding your own compute kernels
  • tutorials_exahype2_additional_mesh_sweeps

How to add your own tutorial

All of ExaHyPE's tutorials follow the same tutorial conventions.