taskbjorn/foamycli repository overview

⁠Quick Reference

• Maintained by: taskbjorn⁠

• Where to get help: GitHub⁠

⁠Supported tags and respective Dockerfile links

• OpenFOAM⁠ (OpenFOAM Foundation Inc.)
  • latest, vanilla-latest, vanilla-8, 8
  • 7, vanilla-7
  • 6, vanilla-6
• OpenFOAM⁠ (OpenCFD Ltd.)
  • plus-latest, plus-v2006, v2006
  • plus-v1906, v1906
• FOAM-Extend⁠ (Wikki Ltd.)
  • extend-latest, extend-4.1, 4.1

⁠Quick reference (cont.)

⁠What is Foamy CLI?

Foamy CLI is a minimal Docker container for OpenFOAM.

The container is based on a minimal Debian image and only includes command-line tools. It does not include Paraview. It is meant to be used on a Windows host using the native version of ParaView for postprocessing.

OpenFOAM is compiled with the following third-party tools in addition to the ones included with the ThirdParty release repo of the chosen version:

• CGAL⁠
• Metis⁠

The following system tools are added to the Debian Slim image:

• Zsh shell with Oh My Zsh⁠
• tmux⁠, a terminal multiplexer
• htop⁠, an interactive process viewer
• Ranger⁠, a console file manager with VI key bindings
• Python 3⁠ with package installer pip⁠
• pyFoam⁠, a library to support working with OpenFOAM

⁠How to use this image

A sample Compose file is provided below. Substitute {HOST-IP} with the IP of the Docker host running an X server and launch the project with docker-compose up -d.

version: "3.7"

services:
  foamycli:
    container_name: foamycli-vanilla
    environment:
      - "DISPLAY={HOST-IP}:0.0"
    image: taskbjorn/foamycli:latest
    network_mode: none
    stdin_open: true
    tty: true
    user: 1000:1000
    volumes:
      - cases:/home/openfoam/cases

volumes:
  cases:
    name: openfoam_cases

⁠Caveats

The container runs under user openfoam (UID 1000) and group openfoam (GID 1000). The OpenFOAM build is stored under /opt/OpenFOAM with permissions 775. It is my suggestion to store cases under ~/Cases as all images (foamycli, foamycli-plus and foamycli-extend) run under the same user, making it easy to share case files between containers without facing permissions issues.

⁠Build

For more info on building your own image refer to the official Git repo⁠.

⁠License

This image is licensed under GNU General Public License v3.0⁠

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.