Repository navigation
One launcher, fastsurfer, for containers and the macOS package; --exec, AMD GPUs, and docs - #953
Merged
Merged
Conversation
…quire a container runtime for the others
…s when Python has none
…exec use the newest of several
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Unresolved argument-routing and stdin-forwarding bugs break supported launcher invocations.
4 open issues
What changed in this PR
This PR makes the container launcher the primary getting-started path and extends its execution and GPU support.
Changes:
- Publishes the launcher through the documentation site and updates installation examples.
- Adds longitudinal processing, arbitrary program execution, and experimental AMD GPU support.
- Improves runtime-specific image selection and HTTPS certificate handling, with expanded tests.
| File | Description |
|---|---|
| tools/fastsurfer_container.py | Extends execution modes, GPU support, and image handling. |
| test/utils/test_fastsurfer_container.py | Tests new launcher behavior and generated commands. |
| test/lint/test_launcher_builds.py | Checks ROCm build-version consistency. |
| README.md | Introduces launcher-first container usage. |
| doc/overview/QUICKSTART.md | Uses the launcher and synchronized platform tabs. |
| doc/overview/install/LINUX.md | Documents launcher usage and AMD support. |
| doc/overview/CONTAINERS.md | Documents new modes and download location. |
| doc/conf.py | Publishes the launcher alongside generated pages. |
Review effort: Balanced
…xec=PROGRAM, and pass piped input to --exec programs
…astSurfer directly
…es the AMD GPUs, and pass --help to brun_fastsurfer.sh
…document the launcher on WSL
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Follow-up to #948.
One command on every system
tools/fastsurfer, without.py, so a downloaded copy cannot shadow the Python packagefastsurfer. ruff includes it explicitly, asrecon_surf/fs_time./Applications/FastSurfer<version>, set up by itsmacos_setup_fastsurfer.sh, as in the console), with the same flags and--execas on Linux. It chooses among installed versions as among images: one runs, several stop with a list,--image 2.6.0chooses.--updatedownloads the package of the newest release (or of--image <version>), found through GitHub's release API, and opens the macOS Installer.--runtime dockerstill runs an image under emulation.Download and docs
html_extra_path), so it downloads fromhttps://deep-mi.org/FastSurfer/stable/fastsurfer, a real file that works with curl; GitHub Pages cannot redirect. The link works from the next release on.Launcher
--exec PROGRAM ARGSruns another program of the image.--exec brun_fastsurfer.shand--exec long_fastsurfer.shtake FastSurfer's flags and are handled likerun_fastsurfer.sh(path flags, several paths after--t1s/--t2s, the license), so no launcher option shares a name with the scripts' flags;run_fastsurfer.sh --long <template_id>passes through. Any other program, e.g.--exec nib-convert in.mgz out.nii.gz, runs in the current directory, shared with the container together with the directories of absolute paths in its arguments, with the newest installed image; with Docker it gets the input from a pipe or file (-i), and a terminal in one (-it).--exec=PROGRAMworks too.--image rocm, the launcher runs the ROCm image on an AMD GPU found through the kernel driver (/dev/kfd), with--rocm(Apptainer) or the device, group and IPC flags (Docker). For a GPU whose family the image supports but whose exact architecture it lacks (e.g. gfx1032, the W6600), it setsHSA_OVERRIDE_GFX_VERSION. With both kinds of GPU, NVIDIA stays the default and a note names--image rocm.--runtimecounts only the images of the runtime it names, while there is one.Tested on a Linux server (Turing GPU, Docker and Apptainer):
--exec nib-convertand--exec bash, the image choice with several installed images, NVIDIA runs unchanged,--image rocmstopping without an AMD GPU. Tested on a Mac with Apple silicon with two package versions installed: runs through the package, the version choice,--updatefinding the package of an older release. The AMD path is not yet tested on AMD hardware, only with unit tests on a stand-in driver topology. Unit tests cover the paths for--execand the scripts, the image and package choice, the argument split at--execand the generated commands; lint tests keep the launcher's CUDA and ROCm versions in sync withgpu_support.pyandpyproject.toml; the docs build passes with-W.