Skip to content

DOC: Add Apptainer warning to Singularity docs #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 28, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/apps/singularity.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
Here, we describe how to run *NiPreps* with Singularity containers.
To illustrate the process, we will show the execution of *fMRIPrep*, but these guidelines extend to any other end-user *NiPrep*.

!!! warning "Apptainer"
In 2021, [*Singularity* was rebranded as *Apptainer* when the project was transferred to the Linux Foundation](https://apptainer.org/news/community-announcement-20211130/).
As noted in the community announcement, all the commands below that contain `singularity` as the command line executable will execute *Apptainer* and can be replaced with the `apptainer` command with no change in function.

## Preparing a Singularity image

**Singularity version >= 2.5**:
Expand Down