A short guide to Amrvis is available here.
The complete LaTeX-formatted documentation is available as a PDF.
- Install XQuartz
$ brew install --cask xquartz
$ open -a XQuartz
- Go to
XQuartz -> Settings... -> Security
and check the box for "Allow connections from network clients". - Reboot your computer (this step is required).
Run Amrvis from the command line like this:
$ ./launch_amrvis3d_macos.sh
localhost being added to access control list
Initializing AMReX (25.05-27-g78268f16d626)...
AMReX (25.05-27-g78268f16d626) initialized
Cannot find amrvis defaults file: ./amrvis.defaults
Cannot find amrvis defaults file: /home/vscode/amrvis.defaults
Reading defaults from: /home/vscode/.amrvis.defaults
You should see a window that looks like this:
Your current working directory on the host is bind-mounted into /home/vscode/data
.
Amrvis requires a three-button mouse for some features (see PDF for details).
Three-button mouse emulation can be turned on by toggling the control in XQuartz -> Setttings... -> Input -> Emulate three button mouse
. Then you can click the emulated middle mouse button by holding the option key on your keyboard and left clicking (option + left click).

This also runs on Linux using Singularity:
username@login11:~/Amrvis-container> ./launch_amrvis3d_linux.sh
INFO: Using cached SIF image
Initializing AMReX (25.05-27-g78268f16d626)...
AMReX (25.05-27-g78268f16d626) initialized
Reading defaults from: ./amrvis.defaults
It also works over X11 from a remote HPC cluster, e.g. Frontier.
This also runs on Windows inside a WSL2 instance.
- First, create a WSL2 instance and install Singularity inside it.
- Then, inside the WSL2 instance, run the Linux launcher script.