diff --git a/Setup/README.md b/Setup/README.md index 1b84f8fce9204eb029ab96a0019192cea5dc0503..867757f16989ac197086c3dc313d4aa32e41849e 100644 --- a/Setup/README.md +++ b/Setup/README.md @@ -1,13 +1,18 @@ -# Numerical experiments for LDD-TPR -This project provides a Fenics based 2D domain decomposition code implementing an LDD solver for two-phase flow systems. -Two-phase flow systems means, that each subdomain can either adopt the full two-phase flow equations or the Richards/Richardson. -Flexible domain substructurings are possible so long as each subdomain has polygonal boundary. +# Setup and installation instructions +The setup constists of cloning this repository, installing `Fenics`, installing a few python modules that are not shipped with the standard distributions and hack away. ## Manual how to set up latest fenix image in Docker -Pull the latest fenics Docker image +Pull the latest `Fenics` Docker image docker pull quay.io/fenicsproject/stable:latest +This code as been tested on the latest docker version, which is as of October 2020 `Fenics 2019`. The above explains how to pull the latest `Fenics` docker image. Drastic changes to Fenics are envisioned for the next release, notably abandoning the mesh tool `mshr` which this code heavily relies on. Therefore, before even starting, check on the `Fenics` [website](https://fenicsproject.org/download/) if another version of has come out. +If yes, you are free to check whether or not this code still works under the latest version, but things might have broken. +In that case, the code needs to be adapted first. +Alternatively, look on [the release cite](https://quay.io/repository/fenicsproject/stable?tab=tags) for the latest 2019 tag and pull that image. +So assuming `2019.1.0` was the latest tag, you would run + + docker pull quay.io/fenicsproject/stable:2019.1.0 ## Create docker container named LDD-TPR with graphical display, share folder `pwd`