Difference between revisions of "Neopipe"

From Wikili
Jump to: navigation, search
(New page: Neopipe)
 
(→‎Installation)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
Neopipe
+
Le NeoPipe est uniquement installé sur '''studio''' pour le moment.
 +
 
 +
=Informations=
 +
*'''Nom''' : NeoPipe
 +
*'''Description''' : A new toolkit for protein family analysis
 +
*'''Développeur''' : Vincent Walter
 +
*'''Architecte/Project Manager''' : Hoan Nguyen
 +
*'''Crédits''' : FRISBI/INSTRUCT
 +
*'''copyright''' : LBGI (ICUBE); Integrated Structural Biology (IGBMC)
 +
*'''Dernière version''' : 1.0.0
 +
*'''Date de dernière version''' : 11.02.2014
 +
*'''Langage de programmation et Framework''' : Java 7, JBOSS jBPM
 +
*'''Environnement''' : Linux (Debian-based)
 +
*'''Langue''' : Anglais / Français
 +
*'''Type''' : Bioinformatique
 +
 
 +
=Installation=
 +
 
 +
==Dépendances==
 +
 
 +
Pour pouvoir utiliser NeoPipe il faut télécharger et/ou installer un certain nombre de programmes :
 +
 
 +
Pour la recherche de protéines homologues :
 +
* [http://blast.ncbi.nlm.nih.gov/Blast.cgi?PAGE_TYPE=BlastDocs&DOC_TYPE=Download BLAST+]
 +
 
 +
Pour les alignements :
 +
* [[PyBallast]]
 +
* DbClustal
 +
* [http://www.clustal.org/omega/#Download Clustal Ω 1.2+]
 +
* [http://msa.sbc.su.se/cgi-bin/msa.cgi KAlign 1.04+]
 +
* [http://www.tcoffee.org/Projects/tcoffee/#DOWNLOAD TCoffee 10.00+]
 +
* [http://mafft.cbrc.jp/alignment/software/ MAFFT 7+]
 +
 
 +
Pour la correction d'alignements :
 +
* [[Rascal]]
 +
* [[Leon]]
 +
 
 +
Pour évaluer la qualité de l'alignement :
 +
* [[NorMD]]
 +
 
 +
Pour le clustering et annotations d'alignements :
 +
* [[Cluspack]]
 +
* [[Macsim]]
 +
 
 +
'''''S'assurer que chacun de ces produits soient fonctionnels avant de continuer.'''''
 +
 
 +
==Installation==
 +
 
 +
Pour installer le NeoPipe, il suffit de déployer l'archive .jar et son launcher. Les librairies nécessaires au fonctionnement du NeoPipe sont embarquées dans l'archive.
 +
 
 +
Pour pouvoir s'exécuter, il faudra que '''Java 7''' (ou version ultérieure) soit installée sur le serveur.
 +
 
 +
Le programme est installé sur le serveur et peut-être utilisé avec la commande '''neopipe''' directement accessible (de n'importe où)
 +
 
 +
=Configuration=
 +
 
 +
La configuration par défaut se trouve à l'emplacement '''/etc/lbgi/neopipe/'''.
 +
 
 +
Si l'option '''-c''' / '''--confdir''' n'est pas renseignée, la configuration par défaut du pipe sera utilisée : '''/etc/lbgi/neopipe/'''
 +
 
 +
Si vous voulez customiser l'installation, il vous faudra copier l'ensemble de la configuration dans un répertoire
 +
 
 +
<pre>
 +
mkdir ~/neopipeconf
 +
cp -r /etc/lbgi/neopipe ~/neopipeconf
 +
</pre>
 +
 
 +
Puis modifier les paramètres d’exécution pour les différents programmes.
 +
 
 +
Les options définies dans '''/etc/lbgi/''' sont prioritaires et écrasent les paramètres de l'utilisateur (permet de poser des restrictions, comme pour le nombre de threads)
 +
 
 +
'''Si des options ne sont pas implémentées sur certains programmes et que vous voulez les utiliser : me contacter (v.walter@unistra.fr)'''
 +
 
 +
=Exécution=
 +
 
 +
==Options==
 +
 
 +
{|class="wikitable sortable centre" style="text-align:center;"
 +
! width="15%" | Mot
 +
! width="15%" | Lettre
 +
! width="15%" | Type
 +
! width="60%" | Description
 +
|-
 +
| --confdir || -c || Path || Le repertoire contenant les fichiers de configuration pour les differents noeuds du NeoPipe
 +
|-
 +
| --input || -i || Path || Le fichier d'entree du NeoPipe (au format Fasta ou MSF)
 +
|-
 +
| --project || -p || String || Le nom du projet associe à l'analyse
 +
|-
 +
| --type || -t || String || Type d'analyse (alignement, annotations, structure)
 +
|-
 +
| --reference || -r || String || Le nom de la sequence de reference necessaire pour differentes etapes du NeoPipe
 +
|-
 +
| --outdir || -o || Path || Le repertoire ou seront enregistres tous les fichiers generes par les differentes noeuds du NeoPipe
 +
|-
 +
| --mail || -m || Mail || L'adresse mail a laquelle renvoyer l'ensemble des fichiers generes par les differents noeuds du NeoPipe
 +
|-
 +
| --alignment || -a || String || Permet de choisir le programme d'alignement. Valeurs autorisées : clustalo, dbclustal, kalign, mafft, tcoffee
 +
|-
 +
| --compress || -z || String || Le format de compression utilise pour creer l'archive envoyee par mail
 +
|-
 +
| --set || -s || boolean || Execute un pipe par proteine (dans le cas d'un Fasta multi-sequences)
 +
|-
 +
| --overwrite || -w || boolean || Ecrase les fichiers si ils existent déjà.
 +
|-
 +
| --help || -h || boolean || Affiche l'aide
 +
|}
 +
 
 +
Certaines de ces options ne sont pas encore complètement fonctionnelles :
 +
* '''''--compress''''' : seule l'option zip est disponible pour le moment
 +
* '''''--overwrite''''' : n'écrase pas les documents s'ils existent (sortie de Blast uniquement) et passe directement à l'étape suivante
 +
* '''''--mail''''' : ne fonctionne que pour des résultats de petits volumes (<10Mo et non répétés), il faut d'abord que je fasse sauter les limitations "spam" de la boite mail utilisée pour l'envoi (neopipe@outlook.com)
 +
* '''''--type''''' : n'effectue que le type annotations c'est-à-dire de Blast à Macsim (par défaut)
 +
 
 +
D'autres ne sont pas implémentées :
 +
* '''''--set'''''
 +
 
 +
==Exemples==
 +
 
 +
<pre>
 +
neopipe --confdir <config_dir> --input <fichier_fasta> --output <output_dir> --alignment kalign --p <project_name> --compress zip
 +
neopipe -c <config_dir> -i <fichier_fasta> -o <output_dir> -a kalign  -p <project_name> -z zip -a
 +
</pre>
 +
 
 +
=Correction de bugs=
 +
 
 +
Si vous avez une erreur, envoyez moi
 +
* la ligne de commande entrée
 +
* le message d'erreur complet affiché dans la console
 +
* le fichier fasta soumis

Latest revision as of 22:40, 9 April 2014

Le NeoPipe est uniquement installé sur studio pour le moment.

Informations

  • Nom : NeoPipe
  • Description : A new toolkit for protein family analysis
  • Développeur : Vincent Walter
  • Architecte/Project Manager : Hoan Nguyen
  • Crédits : FRISBI/INSTRUCT
  • copyright : LBGI (ICUBE); Integrated Structural Biology (IGBMC)
  • Dernière version : 1.0.0
  • Date de dernière version : 11.02.2014
  • Langage de programmation et Framework : Java 7, JBOSS jBPM
  • Environnement : Linux (Debian-based)
  • Langue : Anglais / Français
  • Type : Bioinformatique

Installation

Dépendances

Pour pouvoir utiliser NeoPipe il faut télécharger et/ou installer un certain nombre de programmes :

Pour la recherche de protéines homologues :

Pour les alignements :

Pour la correction d'alignements :

Pour évaluer la qualité de l'alignement :

Pour le clustering et annotations d'alignements :

S'assurer que chacun de ces produits soient fonctionnels avant de continuer.

Installation

Pour installer le NeoPipe, il suffit de déployer l'archive .jar et son launcher. Les librairies nécessaires au fonctionnement du NeoPipe sont embarquées dans l'archive.

Pour pouvoir s'exécuter, il faudra que Java 7 (ou version ultérieure) soit installée sur le serveur.

Le programme est installé sur le serveur et peut-être utilisé avec la commande neopipe directement accessible (de n'importe où)

Configuration

La configuration par défaut se trouve à l'emplacement /etc/lbgi/neopipe/.

Si l'option -c / --confdir n'est pas renseignée, la configuration par défaut du pipe sera utilisée : /etc/lbgi/neopipe/

Si vous voulez customiser l'installation, il vous faudra copier l'ensemble de la configuration dans un répertoire 

mkdir ~/neopipeconf
cp -r /etc/lbgi/neopipe ~/neopipeconf

Puis modifier les paramètres d’exécution pour les différents programmes.

Les options définies dans /etc/lbgi/ sont prioritaires et écrasent les paramètres de l'utilisateur (permet de poser des restrictions, comme pour le nombre de threads)

Si des options ne sont pas implémentées sur certains programmes et que vous voulez les utiliser : me contacter (v.walter@unistra.fr)

Exécution

Options

Mot Lettre Type Description
--confdir -c Path Le repertoire contenant les fichiers de configuration pour les differents noeuds du NeoPipe
--input -i Path Le fichier d'entree du NeoPipe (au format Fasta ou MSF)
--project -p String Le nom du projet associe à l'analyse
--type -t String Type d'analyse (alignement, annotations, structure)
--reference -r String Le nom de la sequence de reference necessaire pour differentes etapes du NeoPipe
--outdir -o Path Le repertoire ou seront enregistres tous les fichiers generes par les differentes noeuds du NeoPipe
--mail -m Mail L'adresse mail a laquelle renvoyer l'ensemble des fichiers generes par les differents noeuds du NeoPipe
--alignment -a String Permet de choisir le programme d'alignement. Valeurs autorisées : clustalo, dbclustal, kalign, mafft, tcoffee
--compress -z String Le format de compression utilise pour creer l'archive envoyee par mail
--set -s boolean Execute un pipe par proteine (dans le cas d'un Fasta multi-sequences)
--overwrite -w boolean Ecrase les fichiers si ils existent déjà.
--help -h boolean Affiche l'aide

Certaines de ces options ne sont pas encore complètement fonctionnelles :

  • --compress : seule l'option zip est disponible pour le moment
  • --overwrite : n'écrase pas les documents s'ils existent (sortie de Blast uniquement) et passe directement à l'étape suivante
  • --mail : ne fonctionne que pour des résultats de petits volumes (<10Mo et non répétés), il faut d'abord que je fasse sauter les limitations "spam" de la boite mail utilisée pour l'envoi (neopipe@outlook.com)
  • --type : n'effectue que le type annotations c'est-à-dire de Blast à Macsim (par défaut)

D'autres ne sont pas implémentées :

  • --set

Exemples

neopipe --confdir <config_dir> --input <fichier_fasta> --output <output_dir> --alignment kalign --p <project_name> --compress zip
neopipe -c <config_dir> -i <fichier_fasta> -o <output_dir> -a kalign  -p <project_name> -z zip -a

Correction de bugs

Si vous avez une erreur, envoyez moi

  • la ligne de commande entrée
  • le message d'erreur complet affiché dans la console
  • le fichier fasta soumis
Retrieved from "http://www.lbgi.fr/wikili/index.php?title=Neopipe&oldid=2971"