Skip to content

AMReX-Codes/Amrvis-container

Repository files navigation

Amrvis-container

Docker

Screenshot 2025-05-23 at 1 34 06 PM

A short guide to Amrvis is available here.

The complete LaTeX-formatted documentation is available as a PDF.

Browser-based X11 (recommended)

Run Amrvis inside a browser-backed X11 session:

$ ./launch_amrvis_browser.sh [/path/to/data]

Your working directory (or the optional path you pass in) is bind-mounted into /home/vscode/data. The script prints a one-time password; open http://localhost:8080/ and paste it in.

An xterm window appears; launch either amrvis2d or amrvis3d from there:

Screenshot 2025-05-25 at 2 00 36 PM

Additional X11 tools included in the container: xfile (file browser), ximaging (image viewer), xpdf, xev, nedit, and xterm.

HPC / remote clusters (Apptainer)

If you have Apptainer on a cluster with SLURM, use the HPC-friendly launcher:

  1. On a login node (once), pull the image into this directory:
$ apptainer pull amrvis-container.sif docker://ghcr.io/amrex-codes/amrvis-container:main
  1. Start an interactive job (example) and switch to the compute node:
$ salloc -N 1 -t 01:00:00
  1. From the compute node, run the browser launcher and point it at your data:
$ ./launch_amrvis_browser_hpc.sh /path/to/data
  • The script detects SLURM, verifies a local SIF (or AMRVIS_APPTAINER_IMAGE), and prints the exact SSH tunnel command to run on your desktop (typically ssh -L 9999:<compute>:8080 $USER@<login>).
  1. On your desktop, create the tunnel and open http://localhost:9999. Paste the one-time password from the terminal, then launch amrvis2d or amrvis3d inside the xterm.

Legacy native X11 launchers

If you prefer direct X11 instead of the browser workflow, use the launchers in legacy_launchers/. See legacy_launchers/README.md for details.

About

Cross-platform container images with pre-built Amrvis

Resources

License

Stars

Watchers

Forks

Packages