Skip to content

Latest commit

 

History

History
119 lines (89 loc) · 4.06 KB

README.md

File metadata and controls

119 lines (89 loc) · 4.06 KB
Raw

AFNI Docker Script

A Bash script for simplifying use of the afni/afni_make_build Docker image for running AFNI on unsupported systems like Debian 13 (Trixie).

Table of Contents

Requirements

  • Docker
  • Bash shell
  • X11 (for GUI functionality)
  • Curl

Installation

Download the shell script:

curl -O https://raw.githubusercontent.com/compmem/afni-docker-script/main/afni.sh

Ensure that the desired users computer users are part of the Docker group to allow them non-root access to Docker:

sudo usermod -aG docker <username>

Log out & back in for the group changes to take effect, or run the following to activate the changes:

newgrp docker

Make the script executable and move it to a directory in your PATH (e.g., /usr/local/bin):

chmod +x afni.sh
sudo mv afni.sh /usr/local/bin/afni

After moving the script to /usr/local/bin, refresh your terminal’s PATH to recognize the new command:

  • Restart your terminal or run hash -r in the terminal to refresh the command table:
hash -r

hash -r will update your shell to recognize the new script without needing to restart.

Before the first use, pull the afni/afni_make_build Docker image by running:

afni -u

This ensures that the latest version of the image is available on your system.

Explanation

This script is designed to simplify working with Containerized AFNI by using Docker to manage dependencies and run AFNI functions within a container.

Why Use This Script?

As of November 2024, the AFNI package supports only Debian 9 (stretch), 10 (buster), and unstable (sid) distributions (details here). Running AFNI on Debian 13 (Trixie) through Docker ensures compatibility and prevents package dependency issues associated with different distribution versions.

Usage

The script has two primary modes:

  1. AFNI GUI Mode: Launches the AFNI GUI.
  2. Command Mode: Runs specified AFNI commands directly in the Docker container.

Basic Commands

  1. Launch the AFNI GUI (uses the current directory as the data directory):
afni
  1. Run an AFNI command (defaults to the current directory for data files):
afni "<afni command and associated arguments>"
  • Example:
afni "3dinfo -n4 dataset.nii"

Optional Flags

  • -d, --data-directory <path>: Specifies the data directory to be mounted in the container, overriding the default (current directory).
    • Example:
afni -d /path/to/data "3dinfo -n4 dataset.nii"
  • -u, --update-image: Pulls the latest afni/afni_make_build Docker image to ensure you’re using the most recent version.
    • Example:
afni -u
  • -h, --help: Displays help information about usage and available flags.
    • Example:
afni -h

Troubleshooting

GUI Issues

The GUI functionality requires X11, as it mounts the host's X11 socket directory into the container to communicate with the display server. If you encounter GUI issues, verify the following:

  • X11 Windowing System: Ensure you are using X11 as your windowing system, especially if your system defaults to Wayland. You can check this by running echo $XDG_SESSION_TYPE, which should output x11.
  • DISPLAY Variable: Confirm that the DISPLAY environment variable is set correctly and matches your active display. Use echo $DISPLAY to check this.
  • X11 Access Permissions: Ensure your Docker container has permission to access X11. Run xhost +local: on the host to allow local connections (not secure for multi-user environments; consider alternatives if needed).