Documentation

Documentation caom2repo

caom2repo

Installation

caom2repo.py est un module client en language Python qui utilise la librairie caom2repoClient. caom2repo.py est installé sur votre ordinateur via la commande 'pip' suivante:

pip install http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/software/caom2repoClient-0.5.1.tar.gz

alternativement, vous pouvez télécharger le fichier tar précédent et installer le module manuellement via la sequence:

python setup.py install

Veuillez noter que la variable d'environnement CADC_ROOT doit être préalablement définie avant l'éxécution du code et cette dernière doit pointer à l'endroit où est installé le module caom2repoClient.

Une façon sécuritaire de définir cette variable est d'exécuter cette commande:

Pour un shell bash

export CADC_ROOT=`python -c 'import caom2repoClient,os ; dirname=os.path.dirname(caom2repoClient.__path__[0]); idx=dirname.find("/lib") ; print dirname[:idx]'`

Pour un shell tcsh ou csh

setenv CADC_ROOT `python -c 'import caom2repoClient,os ; dirname=os.path.dirname(caom2repoClient.__path__[0]); idx=dirname.find("/lib") ; print dirname[:idx]'`

Usage

caom2repo.py est raisonablement bien documenté. Prenez connaissance des différentes options via:

caom2repo.py --help

Essentiellement la scripte caom2repo.py permet de pousser le fichier XML qui contient vos metadonnées de vos observations vers le système de storage CAOM du CCDA. Les informations sont par la suite acheminées vers les bases de données. Veuillez noter qu'une vérification extensive est faite afin de vérifier la consistence de vos informations avant de d'insérer les metadonnées dans la base de données. Voici un exemple d'utilisation qui utilise un fichier XML créé à partir de la commande fits2caom2 :

caom2repo.py --put caom:CFHT/1615920 1615920.xml

L'argument après l'option '--put' est l'adresse CAOM du fichier XML. Ces adresses sont toujours de la forme suivante: caom:{COLLECTION}/{observationID} où les valeurs de COLLECTION et de observationID doivent être identique aux valeurs contenues dans le fichiers XML pour cet archive.