TRANSP Docker manual

Running TRANSP in a Docker Container

1. Request a copy of TRANSP docker container

Request a copy to Docker container by completing this form.

After your request is approved, you will receive a link to download an archive with a Docker container. Once downloaded, you will need to unarchive the file using your preferred extraction tool up to the .tar level.

2. Install Docker

To use TRANSP in a Docker container, you need to install Docker:

Linux: Install Docker using your package manager.
Windows & Mac: Install Docker Desktop from Docker’s official site.

3. Load TRANSP Docker Container

Load previously downloaded and unarchived TRANSP docker container into Docker by running the following command:

docker load -i <file_name>

On Linux, run this in a terminal.
On Windows/Mac, use the terminal in Docker Desktop.

4. X11 Support for GUI Applications

TRANSP’s Docker container will open an X11 terminal by default. X11 support is required to run native TRANSP visualization tools like rplot.

Linux: Use the following options in your docker run command:
-v /tmp/.X11-unix:/tmp/.X11-unix:ro -e DISPLAY
Windows: Install and run Xming.
Mac: Install and run XQuartz.

For Windows and Mac, refer to the guide at: X11 with Docker.

5. Running TRANSP Without X11

X11 is optional. If you don’t need visualization tools, you can disable X11 by adding:

--env XDG_RUNTIME_DIR=/tmp --env QT_QPA_PLATFORM=offscreen

Example command:

docker run --env XDG_RUNTIME_DIR=/tmp --env QT_QPA_PLATFORM=offscreen -it --rm --privileged -e DISPLAY \
-v /tmp/.X11-unix:/tmp/.X11-unix:ro -v $HOME/work:/home/transp_user/work transp_v24.5.0 /usr/bin/bash

6. Mounting Local Filesystem

Ensure that you mount your local file system to Docker so that results persist after the container is closed. Example:

docker run --env XDG_RUNTIME_DIR=/tmp --env QT_QPA_PLATFORM=offscreen -it --rm --privileged -e DISPLAY \
-v /tmp/.X11-unix:/tmp/.X11-unix:ro -v $HOME/work:/home/transp_user/work transp_v24.5.0

7. Inside the TRANSP Container

When the container starts, navigate to your work directory:

cd work

Create a directory for your tokamak and run ID:

mkdir -p NSTX/123456A01
cd NSTX/123456A01

Place your input files here.

7.1 Preparing Input Data

pretr [MPI] <runid>
trdat <runid> wq
label <runid>
copy_expert_for <runid>
tr_build.py trexe <runid>

8. Running TRANSP

8.1 Serial Execution

<runid>TR.EXE <runid>

8.2 Parallel Execution

Set the number of cores in TR.DAT using NBI_NPROCS and PTR_NPROCS. Example for a 16-core run:

export NBI_NPROCS=16
export PTR_NPROCS=16
mpirun -np 16 <runid>TR.EXE <runid>

8.3 Restarting a Run

If the run was interrupted, restart it with:

Serial:
```
<runid>TR.EXE <runid>r
```

Parallel:

mpirun -np <number_of_cores> <runid>TR.EXE <runid>r

9. Post-processing Results

poplt2 <runid>
cdfcon <runid> 0

This generates <runid>.CDF, which can be visualized using:

rplot <runid>

Run rplot from an X11 terminal (xterm), or use Python’s matplotlib for visualization.

10. TRANSP Docker Versions

We release two Docker versions:

Standard TRANSP (no IMAS support)
TRANSP with IMAS (IMAS DD v.3.39)

IMAS-enabled TRANSP Docker is available only for organizations that have signed the user agreement with ITER, as it includes IMAS Data Dictionary, Access Layer libraries, and related tools.