Tutorial template#

Author: Your Name

Here is some short text about what the tutorial will cover (3-4 sentences). More details can be included below.

Include this note block at the top of every code page:

Note

You can run this code directly in your browser by clicking on the rocket logo ( ) at the top of the page, and clicking ‘Binder’. This will open a Jupyter Notebook in a Binder environment which is set up to contain everything you need to run the code. Don’t forget to save a local copy if you make any changes!

If you prefer, you can download the Jupyter Notebook file to run locally, by clicking the download logo ( ) at the top of the page and selecting ‘.ipynb’.

If you are new to using Jupyter Notebooks, this guide will help you get started.

Prerequisites#

All tutorials should have a prerequisites section; just say “none” if none are required. If the prerequisites exist on the knowledgebase, please include links to them (e.g. earlier tutorials, necessary core concepts, etc.). If the prerequisites do not exisit on the knowledgebase, please raise a GitHub Issue to ensure they get added in the future (and consider contributing them yourself!).

None.

Introduction#

Explain the background and details of the tutorial here. Please provide as much context as you can, and use concrete examples rather than abstract concepts wherever possible. Figures and animations are particularly welcomed!

Setup#

You can include anything here that has been explained in previous lessons, load data, libraries, etc. Each notebook file should run without additional dependencies, so use this section to ensure all necessary setup is complete.

import matplotlib.pyplot as plt
from scipy.io.wavfile import write
import numpy as np

Note that we recommend all tutorials include visual and audio output wherever possible.

Basic example#

The aim with all our tutorials is to introduce a basic working example as early as possible, so that new users can see the value right away. You can then build upon this to introduce more complex ideas as you go on.

# Simple example code

More details#

Once you have introduced the basic example, you can begin to build upon it however you like. Try to keep these sections relatively short. More, shorter sections is better than fewer, longer ones. Note the automatically-generated table on contents on the right hand side: try to make the section headings informative so that they can be used for navigation.

Here’s some more details and code relating to a specific aspect.

# And here is some more code

Links and references#

To include an external link to a website, use standard md hyperlink format:

[Link text to click on](www.link-url.com)

If you want to link to another page within the knowledgebase, best practice is to replace the url above with the relative path to the .md or .ipynb file, without the extension. For example,

[Link to FEM tutorials](../tutorials/fem/fem-tutorials-main)

appears as Link to FEM tutorials.

To reference a specific equation, follow these instructions.

To include a reference:

Add the bibtex entry to the references.bib, with some tag, e.g. mytag
In your .ipynb or .md file, write {cite}`mytag` where you would like your citation to appear
The full reference will appear in reference/bibliography.md

Embedding code, images, math…#

There’s lots of information about how to embed code, images, etc. into Jupyter Notebooks in the Jupyter Books documentation. MyST markdown is used in both the .md and .ipynb files throughout the Jupyter Book. For more information about MyST markdown, check out the MyST guide in Jupyter Book, or see the MyST markdown documentation.

The most common things you might want to do are embed images, like so:

Or \(add_{math}\) and

\[ math^{blocks} \]

using LaTeX formatting, like so…

\[\begin{split} \begin{aligned} \mbox{mean} la_{tex} \\ \\ math blocks \end{aligned} \end{split}\]

Summary#

Please include a few summary bullets describing the main take-aways from the tutorial. Include links to subsequent tutorials if available.

Bullet 1
Bullet 2
Bullet 3

Tutorial template

Contents