Tutorials & Examples

Note: please check you’re referencing the intended version of the documentation. This documentation is in reference to v3 of the code, which is currently under beta-release. Documentation for v2 (the latest on PyPI) can be accessed through the sidebar.

Tutorial Notebooks

This tutorial on using Dedalus consists of four short IPython notebooks, which can be downloaded and ran interactively, or viewed on-line through the links below.

These notebooks cover the basics of setting up and interacting with the primary facets of the code, culminating in the setup and simulation of the 1D KdV-Burgers equation.

• Tutorial 1: Coordinates, Distributors, and Bases
• Tutorial 2: Fields and Operators
• Tutorial 3: Problems and Solvers
• Tutorial 4: Analysis and Post-processing

Example Scripts

A range of examples are available under the examples subdirectory of the main code repository, which you can browse here and preview below. These example scripts can be copied to any working directory with the command python3 -m dedalus get_examples. These examples cover a wide range of use cases, including multidimensional problems designed for parallel execution. Basic post-processing and plotting scripts are also provided with many problems. These simulation and processing scripts may be useful as a starting point for implementing different problems and equation sets.

Cartesian examples

Mathieu functions (1D EVP)

Waves on a string (1D EVP)

KdV-Burgers equation (1D IVP)

Rayleigh-Benard convection (2D IVP)

Periodic shear flow (2D IVP)

Poisson equation (2D LBVP)

Curvilinear examples

Librational instability (disk IVP)

Spherical shallow water (sphere IVP)

Spherical shell convection (shell IVP)

Internally heated convection (ball IVP)

Lane-Emden equation (ball NLBVP)