Installation requirements are automatically handled during the setup. In order to run the tutorials you may need to install one of the supported finite element backends, namely dolfinx and firedrake.

Installation and usage

Simply clone the viskex public repository:

git clone

and install the package by typing

cd viskex
python3 -m pip install '.[tutorials]'

External libraries used for plotting

1D plots are provided by plotly, while 2D/3D plots are rendered with pyvista using trame. The default pyvista backend is client when running in JupyterLab, and html when running on Google Colab or Kaggle. Users can customize the active pyvista backend by exporting the environment variable VISKEX_PYVISTA_BACKEND: such operation is typically not required, with the only notable exceptions being testing different pyvista backends on CI, or exporting notebooks to html via nbconvert.

Compatibility with upstream releases

The main branch of viskex targets the main branch of dolfinx and firedrake, which may contain API changes compared to the latest release of the finite element backend. A new viskex version is not necessarily tagged alongside dolfinx or firedrake releases. Users willing to work with a fixed release of the finite element backend are encouraged to look for a viskex commit close to the upstream release date, and do a

git checkout {commit SHA}

before installing viskex.