Commit 7420367d9c21db46da0ba0ed677c379ec84cb89e

Authored by caveenj
1 parent 9f3dfb3b
Exists in master and in 1 other branch odf2csvP3

Ajout des docstrings et de l'aide pour odf2csvm21 et odf2csv121

Showing 1 changed file with 48 additions and 0 deletions   Show diff stats
src/odf_fcns.py
... ... @@ -12,6 +12,12 @@ import math
12 12 #------------------------------------------------
13 13  
14 14 def pres2depth(pin,lat):
  15 + '''Calculer la profondeur a partir de la pression pour une latitude
  16 + donnee.
  17 + Parametres:
  18 + pin : pression a convertir (db)
  19 + lat : latitude a utiliser pour le calcul (degres)'''
  20 +
15 21 c = [9.72659e0, -2.2512e-5, 2.279e-10, -1.82e-15]
16 22  
17 23 gammap = 2.184e-6
... ... @@ -36,6 +42,11 @@ def pres2depth(pin,lat):
36 42  
37 43  
38 44 def depth2pres(din,lat):
  45 + '''Calculer la pression a partir de la profondeur pour une
  46 + latitude donnee.
  47 + Parametres:
  48 + din : profondeur a convertir en pression (metres)
  49 + lat : latitude a utiliser pour le calcul (degres'''
39 50  
40 51 c = [5.92e-3, 5.25e-3, 8.84e-6, 4.42e-6]
41 52 slat = math.sin( lat/57.29578 )
... ... @@ -46,6 +57,7 @@ def depth2pres(din,lat):
46 57  
47 58  
48 59 def usage():
  60 + '''Aide pour le module odf2csv'''
49 61  
50 62 print "Usage: "
51 63 print "odf2csv -i ficin -o ficout [-m interval] [-d] [-e ]"
... ... @@ -61,3 +73,39 @@ def usage():
61 73  
62 74  
63 75  
  76 +
  77 +def usagem21():
  78 + '''Aide pour le module odf2csvm21
  79 + (odf2csv many to one)
  80 + i.e., un fichier csv pour tous les fichiers odf'''
  81 +
  82 + print "Usage: "
  83 + print "odf2csvm21 -o ficout [-m interval] [-d] [-e ]"
  84 + print " ou:"
  85 + print "odf2csvm21 --output ficout [--mean interval] [--error] [--doubtfull]"
  86 + print ""
  87 + print "ficout: fichier sortie (output file"
  88 + print "interval : intervale de profondeurs pour donnees moyennees"
  89 + print " (depth interval for mean data)"
  90 + print "-d (--doubtfull) : eliminer donnees douteuses (discard data flaged as doubtfull)"
  91 + print "-e (--error) : eliminer donnees erronnees (discard data flaged as erroneous)"
  92 +
  93 +
  94 +
  95 +def usage121():
  96 + '''Aide pour le module odf2csv121
  97 + (odf2csv 1 to 1)
  98 + i.e., un fichier csv par fichier odf'''
  99 +
  100 + print "Usage: "
  101 + print "odf2csv121 [-m interval] [-d] [-e ]"
  102 + print " ou:"
  103 + print "odf2csv121 [--mean interval] [--error] [--doubtfull]"
  104 + print ""
  105 + print "interval : intervale de profondeurs pour donnees moyennees"
  106 + print " (depth interval for mean data)"
  107 + print "-d (--doubtfull) : eliminer donnees douteuses (discard data flaged as doubtfull)"
  108 + print "-e (--error) : eliminer donnees erronnees (discard data flaged as erroneous)"
  109 +
  110 +
  111 +
... ...