DOCUMENTATION

Prérequis

• Nous contacter afin de déployer votre clé ssh pour ce service.
• N'oubliez pas d'ajouter cette clé à votre agent ssh si nécessaire quand vous vous connectez sur hpc-login.u-strasbg.fr.
• Chargez le module Singularity :

module load singularity/singularity-3.9.5

Créer une image Singularity

• Créez un répertoire et aller dedans.
• Créez un fichier de recette d'image <project_name>.def (par exemple : exemple.def)
• Générez l'image Singularity avec le script suivant :

hpc_login_gen.sh <project_name>

• L'image <project_name>.sif devrait être générée

Tester une image Singularity (sur votre PC ou sur hpc-login)

singularity run <project_name>.sif

Soumettre un job utilisant une image Singularity sur les nœuds de calcul

Ceci est un exemple simple de scipt sbatch :

#!/bin/bash

#SBATCH -n 8 # On demande 8 cœurs

module load singularity/singularity-3.9.5

singularity run <project_name>.sif

Soumettre le script sbatch :

sbatch my_script

Singularity avec intel18

Créer l'image

• Créer un fichier de recette à l'aide de l'exemple suivant : jacobi.def
• Générer l'image Singularity avec le script suivant :

hpc_login_gen.sh <project_name>

• Lancer l'image générée avec ce lien (bind) spécifique :

singularity run --bind /opt/intel/compilers_and_libraries_2018.1.163:/opt/intel/compilers_and_libraries_2018.1.163 <project_name>.sif

Singularity avec GPU

Créer l'image

• Créer un fichier de recette à l'aide de l'exemple suivant : gpu.def
• Générer l'image Singularity avec le script suivant :

hpc_login_gen.sh <project_name>

• Lancer l'image générée avec cette option spécifique :

singularity run --nv <project_name>.sif

Singularity avec MPI

Créer l'image

• Créer un fichier de recette à l'aide de l'exemple suivant : bandwidth.def
• Générer l'image Singularity avec le script suivant :

hpc_login_gen.sh <project_name>

• Lancer l'image générée avec ces liens (binds) spécifiques :

mpirun singularity run --bind /usr/local/openmpi/openmpi-3.1.3-i18:/usr/local/openmpi/openmpi-3.1.3-i18 --bind /opt/intel/compilers_and_libraries_2018.1.163:/opt/intel/compilers_and_libraries_2018.1.163 <project_name>.sif

Transformer une image Docker en image Singularity (sans MPI)

À partir de Docker Hub

À partir d'une image Docker présente dans Docker Hub, créez votre recette <project_name>.def avec :

Bootstrap: docker
From: <my_image>:<my_tag>

Depuis une image Docker locale

• Créer une archive de votre image Docker :

docker image save -o my_image.tar image_name:version

• Écrire le fichier Singularity <project_name>.def correspondant :

Bootstrap: docker
From: hpc-singularity.di.unistra.fr:5000/<my_image>

• Générer l'image Singularity avec le script suivant :

hpc_login_docker.sh <project_name>

• L'image <my_image>.sif est ainsi générée

Pages d'aide Singularity

Site officiel de Singularity

VERSIONS ET SCRIPTS D'INSTALLATION

• singularity-3.9.5 (latest)
• singularity-3.5.3
• singularity-3.0.3
• singularity-2.6

TAGS

• software