Organisation des logiciels concernant les développeurs¶

La BAO – Boite à outils¶

Contacts BAO : eric.venot@jouy.inra.fr

Qu’est ce que la BAO ?¶

La boîte à outil (BAO) consiste en un répertoire directement accessible par tous (/logiciels) regroupant les différents logiciels développés en interne et utilisés par de nombreuses personnes (exemple : recode, genekit… ). Pour permettre un accès simple aux utilisateurs et assurer la validité de la version disponible du programme, une architecture standard de la BAO a été définie (voir schéma).

Elle se compose de 5 répertoires prédéfinis :

• les répertoires bin, doc et ex*regroupent tous les éléments permettant à un utilisateur quelconque de faire tourner le logiciel. Le répertoire bin contient l’exécutable du programme, le doc le manuel d’utilisation ainsi que les trucs et astuces et ex des exemples d’utilisation (description général de l’exemple, fichier de paramètres, données, sorties, log).
• les répertoires src et .chk sont quant à eux destinés aux développeurs : src rassemble toutes les sources du programme ainsi qu’un Makefile qui permet de lancer automatiquement la compilation du programme. .chk doit permettre de vérifier la validité de la version du logiciel mise à disposition des utilisateurs, suite à une modification par exemple : il contient un script shell exécutant automatiquement le programme sur les données d’un ou plusieurs exemples et comparant les résultats avec les résultats standards. Selon le programme considéré, l’accès à ces derniers répertoires peut être restreint par le responsable du logiciel.

Structure de la BAO¶

Comment mettre un logiciel dans la BAO¶

Envoyer les renseignements suivants à ctig.systeme@dga.jouy.inra.fr :

• nom du répertoire à créer sous /logiciels,
• nom du groupe des administrateurs du programme (les utilisateurs ayant le droit d’écriture dans les répertoires du programme) qui sera aussi l’alias de messagerie pour d’éventuelles demandes de renseignements concernant le programme,
• liste des comptes utilisateurs faisant partie du groupe précédent.

Éventuellement, lancer le script LancementProjet.sh . Ce script de François GUILLAUME crée automatiquement toute l’architecture standard du projet ainsi que les modèles de fichiers à créer pour assurer la bonne mise en place du logiciel et donc sa bonne utilisation.

Ajouter toutes les sources dans le répertoire SRC,

Créer le Makefile permettant la compilation automatique du programme (voir le modèle de Makefile à simplement compléter dans /SRC),

Ajouter un exemple complet contenant une description de l’exemple, les fichiers de données, paramètres, sortie et log),

Créer le script shell .check permettant la vérification du bon déroulement du logiciel (voir le modèle de fichier disponible dans /.CHK),

Lancer le Makefile par la commande make, puis la vérification avec la commande make check (si un problème est survenu et qu’une correction sur le logiciel a été nécessaire, lancer la commande make clean, puis make puis make check.

La version bêta d'un programme pourra être stockée dans le bin du répertoire de ce programme avec un nom différent (exemple : /logiciels/recode/bin/recodeBeta) afin que tous les utilisateurs le souhaitant puissent le tester et le valider. Le responsable décide de la validation et gère la mise en production de son programme.

Information et mise à disposition du logiciel¶

En collaboration avec ctig.systeme@dga.jouy.inra.fr :

• Préparer la fiche d'utilisation de ce nouveau logiciel pour la partie logiciel de CTIGWiki.
• Un message (exemple ci-dessous)sera diffusé à tous les utilisateurs de dga2.

  Sujet :Utilisation du programme TOTO
  L'exécutable de toto version 1.2 est disponible :
  Pour l'appeler, tapez la commande "toto /param" :
  où /param/ est le fichier de paramètres
  Tous les détails ici

• Pour que l’ exécutable soit à disposition des utilisateurs, il faut créer une commande qui lance cet exécutable et crée une log.