simvia/salome_cfd repository overview

⁠SalomeCFD Docker Image

This repository provides Docker images that integrate the code_saturne⁠ CFD solver into the SALOME⁠ platform through the CFD_STUDY module so you can create studies/cases, edit and run computations, and visualize the results in ParaViS, all from a single GUI.

It bundles three layers in one image:

• SALOME (pre/post-processing platform)
• code_saturne (the CFD solver)
• CFDSTUDY (the salome_cfd extensions that couple the two)

⁠📦 Image Tag

The tag encodes both component versions:

simvia/salome_cfd:salome9.16.0-cs9.0.0

This corresponds to SALOME 9.16.0 + code_saturne 9.0.0.

⁠🚀 How to Run the Image

The container's default command is a shell; launch the SALOME desktop with salome.

⁠🖥️ Graphical interface (GUI mode)

Run with X11 forwarding and start SALOME:

  docker run --rm -it \
  --env DISPLAY=$DISPLAY \
  --env XAUTHORITY=$XAUTHORITY \
  -v /tmp/.X11-unix:/tmp/.X11-unix \
  -v $XAUTHORITY:$XAUTHORITY \
  --env QT_X11_NO_MITSHM=1 \
  --env QT_QPA_PLATFORM=xcb \
  --env NO_AT_BRIDGE=1 \
  --net=host \
  -v $(pwd):/home/user/data \
  simvia/salome_cfd:latest \
  salome

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

⁠🧩 Transparently using a shell function

Add this to your .bashrc or .zshrc:

function salome_cfd() {
    docker run --rm -it \
        --env DISPLAY=$DISPLAY \
        --env XAUTHORITY=$XAUTHORITY \
        -v /tmp/.X11-unix:/tmp/.X11-unix \
        -v $XAUTHORITY:$XAUTHORITY \
        --env QT_X11_NO_MITSHM=1 \
        --env QT_QPA_PLATFORM=xcb \
        --env NO_AT_BRIDGE=1 \
        --net=host \
        -v $(pwd):/home/user/data \
        simvia/salome_cfd:latest \
        salome "$@"
}

Then just run salome_cfd from a directory containing (or destined to hold) your study.

⁠🔧 Typical workflow (CFD_STUDY module)

1. Switch to the CFDSTUDY module in the toolbar.
2. Create / open a study under /home/user/data, then a case.
3. Put your mesh in the study's MESH/ folder; right-click it → Convert to MED to visualize it.
4. Edit the setup in the embedded code_saturne GUI, then run the case (serial or parallel).
5. Under the case's RESU/<run>/, right-click a result → Export in ParaViS to render it.

Everything — meshing, setup, run, visualization — stays inside the one SALOME session.

⁠📄 Notes

• The container runs as a non-root user by default.
• All inputs/outputs (studies, meshes, results) live in your local mounted directory.
• SALOME and code_saturne share the same Debian 12 / Python 3.11 / PyQt5 base, which is what lets code_saturne's Python drive the embedded GUI.
• Parallel runs work across the full session, including after visualizing in ParaViS.

⁠🧰 Maintainer

These images are maintained by the Simvia⁠ team!