Introduction¶

Le groupe d’outils FreeSurfer sert à l'analyse et à la visualisation des données d’imagerie cérébrale structurelle et fonctionnelle. FreeSurfer offre un flux d'imagerie structurelle entièrement automatique pour le traitement des données transversales et longitudinales.

Notre module FreeSurfer 5.3¶

Le module à charger est freesurfer/5.3.0.

FreeSurfer construit le script FreeSurferEnv.sh qui est requis pour configurer correctement les variables d’environnement comme PATH et PERL5LIB.

module load freesurfer/5.3.0
source $EBROOTFREESURFER/FreeSurferEnv.sh

FreeSurfer 6.0 et versions ultérieures¶

En raison des conditions liées à la licence pour ces versions, FreeSurfer n’est plus disponible comme module central; vous devez l’installer avec EasyBuild dans vos répertoires /home ou /project comme décrit ci-dessous. Si vous avez besoin d’assistance, contactez le soutien technique.

Téléchargement¶

Sélectionnez une version (6.0.0 ou plus) dans la liste des versions et téléchargez le fichier [...].tar.gz sur la grappe que vous voulez utiliser.

Installation avec EasyBuild dans votre répertoire /home¶

Note

L’installation pourrait échouer par manque de mémoire, car les nœuds de connexion sont limités en termes de taille des paquets de mémoire. Pour contourner ce problème, vous devrez probablement utiliser une tâche interactive et demander environ 8 Go.

La procédure suivante installe FreeSurfer 6.0.0 dans /home/$USER/.local/easybuild/software/2020/Core/freesurfer/6.0.0/.

Repérez le répertoire qui contient le fichier archive freesurfer-Linux-centos6_x86_64-stable-pub-v6.0.0.tar.gz.
Désactivez les modules actifs avec module purge.
Installez avec EasyBuild en utilisant eb FreeSurfer-6.0.0-centos6_x86_64.eb --disable-enforce-checksums.
Inscrivez-vous pour obtenir la clé de licence ici.
Enregistrez la licence dans le fichier /home/$USER/.license.
```
module load freesurfer/6.0.0
cd $FREESURFER_HOME
```
Avec nano ou un autre éditeur de texte, créez le fichier /home/$USER/.license sur le modèle suivant :
```
name.name@university.ca
12345
*A1BCdEfGHiJK
ABCd0EFgHijKl
```
Chargez le module avec :
```
module load freesurfer/6.0.0
```

En date d’août 2020, la version la plus récente disponible était la 6.0.1. Il existe cependant des versions plus récentes.

Recettes EasyBuild¶

Les recettes sont disponibles sur GitHub ou par ligne de commande sur toutes nos grappes avec eb -S FreeSurfer. Si la version que vous cherchez n’est pas listée, vous pouvez installer l’application avec l’option --try-software-version=<la nouvelle version>. En cas de problème, contactez le soutien technique.

Installation dans un répertoire partagé¶

Avec EasyBuild, FreeSurfer peut être installé dans un espace partagé (comme un répertoire /project) afin que tous les membres d’un groupe puissent y avoir accès. Dans l’exemple suivant, FreeSurfer est installé dans le répertoire /home/$USER/projects/def-someuser/$USER/software et le module est installé dans le répertoire /home/$USER/.local/easybuild/modules/2020/Core/freesurfer de l’utilisateur.

newgrp def-someuser
installdir=/home/$USER/projects/def-someuser/$USER
moduledir=/home/$USER/.local/easybuild/modules/2020
pathtosrc=/home/$USER/software
eb FreeSurfer-6.0.1-centos6_x86_64.eb --installpath-modules=${moduledir} --prefix=${installdir} --sourcepath=${pathtosrc}

Si le contrôle d'intégrité (checksums) pose problème, ajoutez l'option --disable-enforce-checksums à la commande eb.

Deux étapes supplémentaires sont requises pour que tous les membres du groupe puissent avoir accès à l’application :

Chaque membre du groupe doit avoir accès en lecture et en exécution au répertoire d’installation /home/$USER/projects/def-someuser/$USER (voir Changer les permissions de fichiers existants).
Chaque membre doit copier le fichier du module dans son répertoire /home. Le fichier du module 6.0.1.lua se trouve sous :
```
/home/$USER/.local/easybuild/modules/2020/Core/freesurfer/
```

Chaque membre du groupe doit créer le répertoire /home/$USER/.local/easybuild/modules/2020/Core/freesurfer et y copier le fichier 6.0.1.lua.

mkdir -p /home/$USER/.local/easybuild/modules/2020/Core/freesurfer
cp 6.0.1.lua /home/$USER/.local/easybuild/modules/2020/Core/freesurfer/

Ces directives installent le module (c'est-à-dire seulement le fichier du module qui pointe vers le répertoire d'installation) dans leurs répertoires /project.

Les utilisateurs doivent également charger le module à partir de leur compte avec :

module load freesurfer/6.0.1

Analyse de l’hippocampe et du tronc cérébral¶

À partir du site web de FreeSurfer, téléchargez et installez la version 2012b du module MATLAB précompilé.

module load freesurfer/6.0.0
cd $FREESURFER_HOME
curl "http://surfer.nmr.mgh.harvard.edu/fswiki/MatlabRuntime?action=AttachFile&do=get&target=runtime2012bLinux.tar.gz" -o "matlab_runtime2012bLinux.tar.gz"
tar xvf matlab_runtime2012bLinux.tar.gz

Exemple de script pour FreeSurfer versions 6.0.0 et ultérieures¶

mysub.sh

#!/bin/bash

#SBATCH --account=def-someuser
#SBATCH --mem=16G
#SBATCH --time=10:00:00

# Load the module:

module load freesurfer/6.0.0

# set the variables:

export SUBJECTS_DIR=<User_Defined_DIR>
source $EBROOTFREESURFER/FreeSurferEnv.sh

echo "Starting run at: `date`"

recon-all command

echo "Program finished with exit code $? at: `date`"

Exemples de durées d'exécution¶

recon-all -all : #SBATCH --time=08:00:00
recon-all -qcache : #SBATCH --time=00:20:00
recon-all -base -tp1 -tp2 : #SBATCH --time=10:00:00
recon-all -long subjid -base base : #SBATCH --time=10:00:00
recon-all -hippocampal-subfields-T1 : #SBATCH --time=00:40:00
recon-all -brainstem-structures : #SBATCH --time=00:30:00