Skip to content

Latest commit

 

History

History
147 lines (112 loc) · 4.25 KB

README.md

File metadata and controls

147 lines (112 loc) · 4.25 KB
Raw

mfem Docker

We provide a Dockerfile.base to build an ubuntu base image, and a Dockerfile to build a smaller one with a multi-stage build. You can use this image for a demo of using mfem! 🎉️

Updated containers are built and deployed on merges to the main branch and releases. If you want to request a build on demand, you can manually run the workflow thanks to the workflow dispatch event.

Usage

Here is how to build the container. Note that we build so it belongs to the same namespace as the repository here. "ghcr.io" means "GitHub Container Registry" and is the GitHub packages registry that supports Docker images and other OCI artifacts. From the root of the repository:

$ docker build -f config/docker/Dockerfile -t ghcr.io/mfem/mfem-ubuntu .
$ docker build -f config/docker/Dockerfile.base -t ghcr.io/mfem/mfem-ubuntu-base .

Shell Ubuntu

To shell into the container:

$ docker run -it ghcr.io/mfem/mfem-ubuntu

This smaller image has a view where everything is installed.

$ ls
bin  etc  include  lib  libexec  sbin  share  var
  • Examples are in share/mfem/examples
  • Examples are in share/mfem/miniapps

You can read more about interaction with these examples and miniapps below.

Shell Ubuntu Base

To shell into the container:

$ docker run -it ghcr.io/mfem/mfem-ubuntu-base bash

Off the bat, you can see mfem libraries are in your path so you can jump into development:

env | grep mfem
PKG_CONFIG_PATH=/opt/mfem-env/.spack-env/view/lib/pkgconfig:/opt/mfem-env/.spack-env/view/share/pkgconfig:/opt/mfem-env/.spack-env/view/lib64/pkgconfig
PWD=/opt/mfem-env
MANPATH=/opt/mfem-env/.spack-env/view/share/man:/opt/mfem-env/.spack-env/view/man:
CMAKE_PREFIX_PATH=/opt/mfem-env/.spack-env/view
SPACK_ENV=/opt/mfem-env
ACLOCAL_PATH=/opt/mfem-env/.spack-env/view/share/aclocal
LD_LIBRARY_PATH=/opt/mfem-env/.spack-env/view/lib:/opt/mfem-env/.spack-env/view/lib64
PATH=/opt/mfem-env/.spack-env/view/bin:/opt/view/bin:/opt/spack/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin

Examples and MiniApps

If you want to develop a tool that uses mfem, you can find the built libraries in:

$ ls /opt/mfem-env/.spack-env/view/
bin  etc  include  lib  libexec  sbin  share  var

And yes, this is the working directory when you shell into the container! You can find the examples here:

cd share/mfem/examples
$ ./ex0
Options used:
   --mesh ../data/star.mesh
   --order 1
Number of unknowns: 101
   Iteration :   0  (B r, r) = 0.184259
   Iteration :   1  (B r, r) = 0.102754
   Iteration :   2  (B r, r) = 0.00558141
   Iteration :   3  (B r, r) = 1.5247e-05
   Iteration :   4  (B r, r) = 1.13807e-07
   Iteration :   5  (B r, r) = 6.27231e-09
   Iteration :   6  (B r, r) = 3.76268e-11
   Iteration :   7  (B r, r) = 6.07423e-13
   Iteration :   8  (B r, r) = 4.10615e-15
Average reduction factor = 0.140201

Try running a few, and look at the associated .cpp file for the source code! You can also explore the "mini apps," also in share/mfem, but under miniapps.

# This is run from the examples directory
$ cd ../miniapps
$ ls
CMakeLists.txt  common            meshing  nurbs        shifted  toys
adjoint         electromagnetics  mtop     parelag      solvers
autodiff        gslib             navier   performance  tools

And an example in "toys"

cd toys
$ ./automata -no-vis
Options used:
   --num-steps 16
   --rule 90
   --no-visualization

Rule:
 111 110 101 100 011 010 001 000
  0   1   0   1   1   0   1   0

Applying rule...done.

Have fun!

Your own App

If you want to develop with your own code base (and mfem as is in the container) you can bind to somewhere else in the container (e.g., src)

$ docker run -it ghcr.io/mfem/mfem-ubuntu-base -v $PWD:/src bash

In the above, we can pretend your project is in the present working directory (PWD) and we are binding to source. You can then use the mfem in the container for development, and if you want to distribute your library or app in a container, you can use the mfem container as the base.