Getting started

Installation 🛠️

conda

The conda environment required to run the code can be extracted from the file environment.yml.

The environment file should look like this:

name: fenics
channels:
  - conda-forge
  - defaults
dependencies:
  - python=3.12.8
  - fenics=2019.1.0
  - meshio=5.3.5
  - scipy=1.14.1
  - pandas=2.2.3
  - control=0.10.1

It is important that python is installed with a version >=3.10 because dataclasses are being used. Also, it is important that the latest version of fenics is used (namely 2019.1.0).

The folders flowcontrol and utils in the root folder should be appended to Python module path, by example with conda develop or creating a conda.pth file in your environment site-packages.

Additional path tweaking is sometines required for FEniCS to be found through the dolfin module.

Docker 🐳

[coming soon]

Run examples

After the conda environment has been set-up correctly, you can test the installation from a Python terminal:

1. Try importing FEniCS with import dolfin
2. Run examples from the examples folder: examples/cylinder/cylinderflowsovler.py and examples/cavity/cavityflowsolver.py. The main method of these scripts should launch fast simulations, only for testing purposes.