From 49a51bb83b4412867d8cc2fcfc0612fe7a82e190 Mon Sep 17 00:00:00 2001 From: mckenziephagen Date: Mon, 27 Jan 2025 12:47:38 -0800 Subject: [PATCH 1/2] Add Apptainer warning to Singularity docs --- docs/apps/singularity.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/apps/singularity.md b/docs/apps/singularity.md index 2391a9f..9b4b5d9 100644 --- a/docs/apps/singularity.md +++ b/docs/apps/singularity.md @@ -3,6 +3,9 @@ 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 migrated and became Apptainer. Despite this, all below commands that contain `singularity` will execute Apptainer, and can be replaced with the `apptainer` command with no change in function. + ## Preparing a Singularity image **Singularity version >= 2.5**: From 08ce56dd7f4554d28515b940c9b095c367c3a397 Mon Sep 17 00:00:00 2001 From: McKenzie Paige Hagen <35019015+mckenziephagen@users.noreply.github.com> Date: Tue, 28 Jan 2025 10:37:12 -0800 Subject: [PATCH 2/2] Update docs/apps/singularity.md code review from Oscar Co-authored-by: Oscar Esteban --- docs/apps/singularity.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/apps/singularity.md b/docs/apps/singularity.md index 9b4b5d9..c962983 100644 --- a/docs/apps/singularity.md +++ b/docs/apps/singularity.md @@ -4,7 +4,8 @@ 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 migrated and became Apptainer. Despite this, all below commands that contain `singularity` will execute Apptainer, and can be replaced with the `apptainer` command with no change in function. + 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