Document CAN driver and boundary files

[luyssaert]

The driver and boundary files for CN-CAN need to be copied from the dofoco share on irene to the shared disk of ORCHIDEE. Prior to doing so a read me file documenting the files should be made (who made them, which info went in, which script were used, provide the scripts, etc ...).

[luyssaert]

Instructions from the IGCMG team to prepare the documentation:

Le nom du répertoire doit être unique et nouveau. On ne remplace pas un répertoire existant.
Des scripts éventuellement utilisés pour transformer les données doivent de préférence être stockés sur un dépôt SVN ou GIT. Par exemple ici :
parmi les outils Plateforme ​​https://forge.ipsl.jussieu.fr/igcmg/browser/TOOLS
parmi les outils ORCHIDEE (il faut être loggé) ​​https://forge.ipsl.jussieu.fr/orchidee/browser/trunk/TOOLS
Créer un README dans chaque répertoire. Le README contient le suivant :
Date et le nom de la personne ayant récupéré et préparé les données
Explication de l'origine des données
Explication des transformations éventuelles de ces donnés
Liens vers les scripts utilisés pour transformer les données. Les scripts doit être stockés de préférence sur un dépôt SVN ou GIT. Le numéro de révision sera donné dans le README.
S'il y a un policy d'utilisation ou de remerciement à connaitre

Si les fichiers sont transformés, ajouter l'attribut global Description décrivant les données, dans chaque fichier. L'information du README peut être repris dans l'attribut. Utiliser le commande ncatted pour cela.
Les fichiers netcdf doivent de préférence être au format netcdf-4.
Éviter les liens pour éviter toute confusion - Remarque : les liens peuvent être utiles pour conserver une rétrocompatibilité. Si vous mettez un lien, mettez le en relatif. Ceci afin qu'il fonctionne dans tous les dépôts.

[luyssaert]

Files that should be documented:

• fm_strat_map -> OK (looking for the scripts)
• litter_demand_map -> OK (looking for the scripts)
• combined_species_mtc -> OK (looking for the scripts)
• combined_species_mtc_lcc -> OK (looking for the scripts)
• combined_species_mtc_sc -> OK (looking for the scripts)
• ipsl_rcp8.5_regrid -> OK (looking for the scripts)
• cru-ncep_regrid -> OK
• RCP8.5_CO2 -> OK
• RCP4.5_CO2 -> OK
• conifers, deciduous -> OK
• desired_fm1, 2, 3 and 4 -> OK

Each folder should come with a README.txt file that contains:

• Date of creation:
• Person who created the files
• Date of documentation
• Person who documented the files
• Source of the original data
• Processing to obtain the data files
• Link to the scripts that were used for the processing
• If the scripts are in svn, revision number
• User policy

[jgipsl]

• CRUNCEP : scripts on svn, files and readme in IGCM
• FM : scripts on svn, files and readme in IGCM
• LITTER_DEMAND : scripts on svn(ref to FM folder), files and readme in IGCM
• PFT : scripts on svn(ref to FM folder), files and readme in IGCM
• ROUTING no need to copy, it's not used in zoomed mode and also the model should handle the interpolation.
• SOIL no need to copy. This file is interpolated by the model, it was already the case in the set up of FG4 and FG5.
• FUTURE_CO2 no need to copy because these files are already stored in IGCM/ATM/GHG/CMIP5/RCPs/RCP85/CO2_1765_2500.txt and IGCM/ATM/GHG/CMIP5/RCPs/RCP45/CO2_1765_2500.txt
• New paths in configuration files are commited in rev [6473]

Still on going:

• FUTURE_CLIM :
  • files and readme in IGCM
  • scripts not yet on SVN, readme to be completed after commit of scripts
  • /home/orchideeshare/igcmg/IGCM/SRF/METEO/IPSLCM5A/RCP45/119x128_Z_Europe/README
  • /home/orchideeshare/igcmg/IGCM/SRF/METEO/IPSLCM5A/RCP85/119x128_Z_Europe/README
• The files are currently only on IGCM at orchideeshare/obelix. Synchronization to irene and jean-zay must be done

[jgipsl]

• FUTURE_CLIM : files are now stored on svn [6485] and README files updated
• Synchronization to irene have been done. Jean-Zay and ciclad under going.

Scripts added to SVN are stored here: ​https://forge.ipsl.jussieu.fr/orchidee/browser/trunk/TOOLS