Commit 613ff383 authored by mmassaviol's avatar mmassaviol
Browse files

Ajout d'une documentation

parent ea2bd360
# Documentation Wapps
Le dépôt [Wapps](https://gitlab.mbb.univ-montp2.fr/mmassaviol/wapps) (Workflow applications) contient les fichiers nécessaires pour créer des conteneurs d'application générés à l'aide du dépot [WAW](https://gitlab.mbb.univ-montp2.fr/mmassaviol/waw) (Workflow Application Wrapper). Ce sont des conteneurs qui possèdent tous les outils et fichiers nécessaires à l'execution d'un workflow.
## 1 Construire un conteneur
Pour construire un conteneur on utilise singularity. On crée un premier conteneur qui contient les outils basique et communs à tous les workflows pour gagner du temps par la suite. Pour construire un conteneur singularity il faut le programme [Singularity](https://singularity.lbl.gov/) (disponible sous Linux) et un fichier de recette qui est fourni sur le dépôt git de Wapps. Il faut aussi les droits administrateur pour pouvoir construire le conteneur (ils ne sont pas nécessaires pour l'utilisation du conteneur).
```bash
sudo singularity build base.simg base.recipe
```
Ici on se place à la racine du dépôt et on construit le conteneur de base. Ensuite pour construire le conteneur du workflow choisi il suffit de lancer (toujours depuis le dossier racine du dépot) la commande suivante :
```bash
sudo singularity build NomDuWorkflow.simg ./NomDuWorkflow/files/singularity.recipe
```
## 2 Utiliser un conteneur
Il existe deux façons d'utiliser le conteneur. On peut lancer l'interface shiny afin de paramétrer le workflow et de le lancer. On peut aussi fournir un fichier de paramètres et lancer le workflow directement depuis la console.
Dans les deux cas il va falloir lier les dossiers nécessaires pour qu'ils soient accessibles dans le conteneur. Pour lier un dossier à un conteneur singularity il faut utiliser l'option -B avec le chemin du dossier à lier séparé par ':' du chemin auquel le dossier sera accessible dans le conteneur. Par exemple pour le dossier de données (-B /dossier/de/données:/Data) qui dans le conteneur seront accessibles dans /Data et le dossier dans lequel les résultats seront écrits (-B /dossier/de/résultats:/Results) qui dans le conteneur correspond à l'adresse /Results.
### 2.1 Avec interface graphique
Pour lancer l'application il faut lancer la commande :
```bash
singularity run --app UI -B /chemin/vers/les/données:/Data -B /dossier/de/résultats:/Results addresse_IP_hôte port
```
Il suffit ensuite de se connecter avec son navigateur à l'adresse et au port choisi dans la commande.
### 2.2 En ligne de commande
Pour lancer le workflow il faut lancer la commande :
```bash
singularity run --app Snakemake -B /chemin/vers/les/données:/Data -B /dossier/de/résultats:/Results configfile cores additional_snakemake_parameters
```
Une fois le workflow lancé les commandes s'enchainent jusqu'à la fin du workflow. On peut trouver les fichiers de logs dans le dossier logs du dossier de résultat.
......@@ -3,5 +3,6 @@
Workflow applications generated from WAW and SAG
Each application has two directories :
* files : which contains the Snakefile, the params file, all the scripts to run the workflow and the singularity recipe to build the container.
* sagApp : which contains the RShiny application to customise the parameters and launch the workflow
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment