Skip to content

templated reports (e.g. convergence reports)

Florian Zill requested to merge FZill/ogstools:templated_reports into main

Purpose

Added functionality to setup parametrized jupytext templates which can be run as jupyternotebooks. The templates are good for continuous integration and the rendered notebooks are good for reports. The same pipeliene basically happens when sphinx-gallery converts the jupytext-scripts to examples for the web-page. With the added functions we can do the same with more freedom.

Commit-wise review recommended.

Features

propertylib

  • renamed classes to Scalar, Vector and Matrix
  • removed PropertyCollections
  • renamed defaults to presets

meshplotlib

  • allow colorbars per axis
  • clamped aspect ratios for axes (aspect ratios got a bit broken and went unnoticed, this fixes it)
  • colorbar limits now on the colorbar itself not seperated
  • fixed levels

templated reports

  • jupytext_to_jupyterallows for parametrized jupytext templates to be converted to and run as jupyter notebooks. These in turn can be used as is or rendered as HTML with jupyter_to_html.
  • removed previous benchmark files, calculated on the fly with ogs6py
  • spatial convergence example now uses the template
  • added temporal convergence example
  • different markers for richardson extrapolation values

Example

Have a look at this MR's documentation -> examples -> studies

Edited by Florian Zill

Merge request reports

Loading