Skip to content

singularity

emaliemcmahon@gmail.com edited this page Jun 30, 2022 · 1 revision

How to build a fMRIprep Singularity image for HPC

Warning: This is a very slow process because you are essentially setting up a brand new computer (the VM) from scratch. It also requires a lot of disk space (VirtualBox + OS + all the packages).

Virtual Machine

Building the image requires 1. root priviledges and 2. a Linux OS. So it can't be built on Rockfish or on a local Mac or PC

Install VirtualBox

(VirtualBox)[https://www.virtualbox.org/manual/ch02.html#installation-mac] is an open source VM gui.

Download Ubuntu

Download a compatible version of (Ubuntu)[https://ubuntu.com/download/desktop] for your local machine -- version will be different from Mac with Intel vs Apple chip

Install OS on VM

Detailed step-by-step instructions are (here)[https://ubuntu.com/tutorials/how-to-run-ubuntu-desktop-on-a-virtual-machine-using-virtualbox#1-overview].

Note: The installation of the OS on the VM is quite slow.

Install Dependencies

Docker

Installation instructions on Ubuntu are (here)[https://docs.docker.com/engine/install/ubuntu/].

Singularity

Installation instructions are (here)[https://docs.sylabs.io/guides/3.5/user-guide/quick_start.html]

Build Singularity image

Instructions for building the image are available on the fMRIprep website (here)[https://www.nipreps.org/apps/singularity/].

Transfer the image

Clone this wiki locally