Jupyter notebooks as documentation

The big picture

Jupyter notebooks can be placed in Tests/Data along regular benchmarks. See Notebook testing for details on how to setup ogs execution (especially input data path handling) inside the notebook. See also the SimpleMechanics.ipynb-notebook as an example.

Add web meta information

Similar to regular web documentation pages the notebook requires to have a frontmatter with some meta information as the first cell in the notebook:

  • Add a new cell and move it to the first position in the notebook

  • Change the cell type to raw!

  • Add meta information, conclude with a end-of-file marker (<!--eofm-->) e.g.:

    title = "SimplePETSc"
    date = "2021-11-09"
    author = "Lars Bilke"
    notebook = "Mechanics/Linear/SimpleMechanics.ipynb"
    image = "optional_gallery_image.png"
    web_subsection = "small-deformations"
    <!--eofm-->

Static images e.g. for the gallery image or to be used in Markdown cells have to located in either images- or figures-subdirectories beneath the Notebook file! Otherwise they will not show up in the web site.

General advice

Python cells

  • Do not use machine-specific or absolute paths!
  • Assume that ogs and other tools are in the PATH.

Markdown cells

  • Do not use HTML inside Markdown blocks.

  • For image captions add a title in quotation marks after the image path, e.g.

    ![Alt text](figures/my_image.png "This will be the image caption.")
  • Please use images- or figures-subdirectories!

  • Please note that in merge request web previews images are not shown at all.


This article was written by Lars Bilke. If you are missing something or you find an error please let us know.
Generated with Hugo 0.101.0 in CI job 262272 | Last revision: October 24, 2022
Commit: [web] Update docs on notebook testing and web conversion. 1cb932f  | Edit this page on