fenics/dev-env repository overview

⁠Docker for FEniCS

This repository contains the scripts for building various Docker images for FEniCS⁠. The built images are available at quay.io⁠. These images are built with Python 3, using fenicsproject's official dev-env image⁠

For fenicsproject's officialstable and dev images, which are built with Python 2, visit quay.io⁠.

⁠Introduction

To install Docker for your platform (Windows, macOS, Linux, cloud platforms, etc.), follow the instructions at docker.com⁠.

Once you have Docker installed, you can run any of the images below using the following command:

docker run -ti quay.io/fenics/<image-name>:latest

To start with you probably want to try the stable:latest image which includes a full stable version of FEniCS with PETSc, SLEPc, petsc4py and slepc4py already compiled.

docker run -ti quay.io/fenics/stable:latest

If you want to share your current working directory into the container use the following command:

docker run -ti -v $(pwd):/home/fenics/shared quay.io/fenics/<image-name>:latest

Users with SELinux-enabled Linux distributions (Redhat, Fedora, CentOS, and others) will need to add the :z flag to the volume mount, e.g.:

docker run -ti -v $(pwd):/home/fenics/shared:z quay.io/fenics/<image-name>:latest

⁠Documentation

More extensive documentation, including suggested workflows, is available at https://fenics-containers.readthedocs.org/⁠. Note that when using these images, you need to replace quay.io/fenicsproject/ by quay.io/fenics/ in the commands.

⁠Tagging policies of stable images

You can view the tags on the stable image here:

https://quay.io/repository/fenics/stable/tags/⁠

The tagging policy for stable image is as follows:

• The :latest (default) tag refers to the latest image. The prior :latest image is automatically deleted unless it has been assigned another tag.
• When we release a new stable version of FEniCS the last :latest image is tagged xxxx.x.x for permanent archival. This could be useful if you want to compile an old version of FEniCS.

⁠Development images

We also provide a set of unsupported images containing the output of all builds produced during our continuous integration and testing.

These images are not guaranteed to work. They may be of use to developers and contributors for debugging issues in pull requests or trying out bleeding edge features.

Pushing a new commit to a branch will re-build the image.

⁠Authors

• Jack S. Hale ([email protected]⁠)
• Lizao Li ([email protected]⁠)
• Garth N. Wells ([email protected]⁠)

Edited by Xiangmin Jiao (<xiangmin.jiao.stonybrook.edu>)