simvia/opentelemac repository overview

⁠openTELEMAC Docker Images

This repository provides Docker images for running openTELEMAC⁠ and its associated tools such as QGIS⁠ and the Q4TS⁠ plugin, in a reproducible and portable environment.

⁠📦 Image Variants and Tag Naming Convention

All images follow the naming pattern:

simvia/opentelemac:<variant>-<version>

Where:

• <variant> indicates the tools included:
  • core or : basic OpenTelemac installation
  • qgis: includes QGIS and Q4TS for graphical interaction
• <version> follows OpenTelemac release naming

⁠✅ Examples

⁠🚀 How to Run the Image

⁠🧪 Minimal use (CLI only, headless)

This will mount your current directory as /home/user inside the container:

docker run -it -v $(pwd):/home/user simvia/opentelemac:v8p5r1

⁠🖥️ Full use with GUI (QGIS, Q4ST)

If you want to use the image with graphical tools (like QGIS), run the container with X11 forwarding:

docker run -it \
  --env DISPLAY=$DISPLAY \
  --env XAUTHORITY=$XAUTHORITY \
  -v /tmp/.X11-unix:/tmp/.X11-unix \
  -v $XAUTHORITY:$XAUTHORITY \
  --user $(id -u):$(id -g) \
  --env QT_X11_NO_MITSHM=1 \
  --env QT_QPA_PLATFORM=xcb \
  --env NO_AT_BRIDGE=1 \
  --net=host \
  -v $(pwd):/home/user/data \
  simvia/opentelemac:qgis-v8p5r1

📌 Make sure that your host allows X11 connections (you might need xhost +local:).

⁠Executing examples

Inside the container, all of the telemac files can be found in the /opt/open_telemac folder. The python paths are already prepared, so feel free to run some of the telemac examples studies by running

python3 /opt/open_telemac/scripts/python3/telemac2d.py [t2d steering file.cas]

Note that you can run telemac3d and mascaret similarly. You must first copy from the /opt/open_telemac/examples folder the study files in a local folder before being able to execute the examples.

⁠📄 Notes

• By default, the user inside the container is non-root
• Output files will appear in your current working directory.

⁠🧰 Maintainer

These images are maintained by the Simvia⁠ team !