JmmcAmberDrs < Jmmc/Software

---+!! <center>Plugin Yorick pour la librairie <em>amdlib</em></center>

%TOC%
---++ Introduction
Le but est de cette activité consiste à:
   * mettre en place la génération automatique du _plugin_ Yorick des fonctions de la librarie de réduction de données _amdlib_,
   * extraire (du module _ammyorick_), remettre en forme et documenter les fonctions Yorick strictement nécessaires à la réduction des données AMBER,
   * extraire le plugin cftisio
   * finaliser la procédure _check data quality_
   * reprendre la génération du fichier pdf
   * fournir une procédure d'installation simplifiée
   * finaliser la documentation utilisateur

Le reponsable scientifique est Main.FabienMalbet, et la responsable technique est Main.EvelyneAltariba.

---++ Description détaillée
Le plugin Yorick est intégré au module _amdlib_ actuel, dans le réperoire _yorick_. Pour le besoin du développement de ce plugin, le module amdlib est archivé sous CVS sur le [[Laog.GRIL.Informatique.GestionConfiguration][serveur du LAOG]].

---+++ Génération du _plugin_
Le fichier d'interface =amdlibYorick.i= et la librairie =amdlib.so= sont générés automatiquement à partir des fichiers de déclaration =amdlib.h= et amdlibYorick.h, en exécutant les commandes suivantes dans le répertoire =yorick=.
<verbatim>
   yorick -batch make.i
   make update
   make all install
</verbatim>

La liste des fonction du _plugin_ sont les suivantes:
 %EDITTABLE{ format="|text, 80, Ancien nom | text, 80, Nouveau nom | select, 1, Non, Oui | select, 1, Non, Oui |" changerows="on" }%
| *Ancien nom* | *Nouveau nom* | *Reprise* | *Testée* |
| amdlibVersion | - | Oui | Non |
| amdlibLoadRawData | - | Oui | Non |
| amdlibLoadRawDataHdr | - | Oui | Non |
| amdlibLoadRawFrames | - | Oui | Non |
| amdlibCalibrateRawData | - | Oui | Non |
| amdlibGetRawData | - | Oui | Non |
| amdlibSetRawData | - | Oui | Non |
| amdlibLoadBadPixelMap | - | Oui | Non |
| amdlibSetBadPixelMap | - | Oui | Non |
| amdlibGeneratePixelBiasData | - | Oui | Non |
| amdlibGetPixelBiasData | - | Oui | Non |
| amdlibSetPixelBiasData | - | Oui | Non |
| amdlibCreatePixelBiasData | - | Oui | Non |
| amdlibSetFlatFieldMap | - | Oui | Non |
| amdlibLoadFlatFieldMap | - | Oui | Non |
| amdlibGetWaveDataFromRawData | - | Oui | Non |
| amdlibGetOiArrayFromRawData | - | Oui | Non |
| amdlibRawData2ScienceData | - | Oui | Non |
| amdlibGetOiTargetFromRawData | - | Oui | Non |
| amdlibGetScienceData | - | Oui | Non |
| amdlibSetScienceData | - | Oui | Non |
| amdlibLoadP2VM | - | Oui | Non |
| amdlibGetP2vm | - | Oui | Non |
| amdlibAddToP2vmData | - | Oui | Non |
| amdlibComputeP2VM | - | Oui | Non |
| amdlibSaveP2VM | - | Oui | Non |
| amdlibComputeVisibilities | - | Oui | Non |
| amdlibWriteOiFile | - | Oui | Non |
| amdlibReadOiFile | - | Oui | Non |
| amdlibGetPhot | - | Oui | Non |
| amdlibGetVis | - | Oui | Non |
| amdlibGetVis2 | - | Oui | Non |
| amdlibGetVis3 | - | Oui | Non |
| amdlibGetWavelength | - | Oui | Non |
| amdlibGetPiston | - | Oui | Non |

---+++ Extraction et reprise des fonctions Yorick
La reprise consiste principalement à documenter les fonctions et appliquer les règles de programmation (plus précisément de nommage) du langage C.
La liste des fonctions à reprendre est la suivante:
%EDITTABLE{ format="|text, 80, Ancien nom | text, 80, Nouveau nom | select, 1,  Non, Oui | select, 1, Non, Oui | text, 80, Fichier |" changerows="on" }%
| *Ancien nom* | *Nouveau nom* | *Reprise* | *Testée* | *Fichier* |
| ammyorickP2VM | | Non | Non | |
| ammyorickUtils | | Non | Non | |
| ammyorickVis | | Non | Non | |
| ammyorickEasyUse | | Non | Non | |
| ammyorickMaintenance | | Non | Non | |
| ammyorickSim | | Non | Non | |
| depla | | Non | Non | |
| ammyorickRawData | | Non | Non | |
| ammyorickSpecCalib | | Non | Non | |
| ammyorickDataQuality | | Non | Non | |
| latexUtils  | | Non | Non | |
| linfit  | | Non | Non | |
| plg_err  | | Non | Non | |
| plmenu  | | Non | Non | |
| pondAvg  | | Non | Non | |
| strReplace  | | Non | Non | |
| strkot | | Non | Non | |
| strsep  | | Non | Non | |
| unwrap  | | Non | Non | |
| generateDoc  | | Non | Non | |
| remove_multiple  | | Non | Non | |
| ammyorickUVW  | | Non | Non | |

La dernière colonne indique le nom du fichier dans lequel la fonction est définie.

---+++ Extraction du plugin cftisio
Le plugin Yorick pour cfitsio doit être un package indépendant de amdlib.

---+++ Finalisation de la procédure _check data quality_

---+++ Reprise de la génération du fichier pdf 
La génération du fichier pdf résultant de _check data quality_ doit être repris pou utiliser les outils intégrés à Yorick et non plus Latex
 
---+++ Procédure d'installation simplifiée
La procédure d'installation du package amdlib doit être simplifiée. L'installation de Yorick, rlterm, cfitio et fftw doit être faite séparément.

---+++ Documentation utilisateur
La documentation utilisateur doit :
   * reflétée la dernière version du logiciel, 
   * inclure des exemples,
   * préciser les limites d'utilisation,
   * fournir les _justifications_ scientifiques (référence aux publications)

-- Main.GerardZins - 08 Jan 2007
This topic: Jmmc/Software > WebHome > AMBER > JmmcAmberDrs
Topic revision: r1 - 2007-01-08 - GerardZins