libhydro.conv.shom.shom (version 0.3, 2015-09-23)
index
/home/seb/PHyC_source/libhydro3/libhydro/conv/shom/shom.py

Module shom.
 
Ce module contient des convertisseurs de et vers les fichiers de predictions
de marees du SHOM:
    simulation_from_hfs()
    simulation_to_hfs()  -- not implemented --
 
On peut aussi manipuler ces donnees comme des observations simplifiees a l'aide
des fonctions suivantes:
    serie_from_hfs()
    serie_to_hfs()  -- not implemented --
 
Format des fichiers HFS:
    # fichier texte avec extension hfs
    # le nom du fichier est le nom du maregraphe ou du port en majuscule
    # une ligne par donnee au format "yyyy-mm-dd hh:mm:ss xx.xx"
    # pas de temps constant et heures TU
    # les hauteurs sont en metres. Se referer au descriptif du port fourni par
        le SHOM pour determiner la reference altimetrique
 
Exemple:
...
2013-01-23 00:00:00  3.46
2013-01-23 00:10:00  3.51
2013-01-23 00:20:00  3.55
...

 
Modules
       
libhydro.core.modeleprevision
numpy
libhydro.core.obshydro
os
pandas
libhydro.core.simulation
libhydro.core.sitehydro

 
Functions
       
serie_from_hfs(src, station=None, begin=None, end=None, strict=True)
Retourne une obshydro.Serie a partir d'un fichier HFS.
 
La Serie est simplifiee et ne contient que la colonne res.
 
Arguments:
    src (str o ou file) = fichier source
    station (Station) = par defaut utilise le nom du fichier src
    begin, end (isoformat string) = dates de debut/fin de la plage de
        valeurs a conserver, bornes incluses
    strict (bool, defaut True) = le mode permissif permet de lever le
        controle de validite de la station
simulation_from_hfs(src, station=None, begin=None, end=None, dtprod=None, strict=True)
Retourne une simulation.Simulation a partir d'un fichier HFS.
 
Arguments:
    src (str o ou file) = fichier source
    station (Station) = par defaut utilise le nom du fichier src
    begin, end (isoformat string) = dates de debut/fin de la plage de
        valeurs a conserver, bornes incluses
    dtprod (string ou datetime) = date de production
    strict (bool, defaut True) = le mode permissif permet de lever le
        controle de validite de la station

 
Data
        CODE_MODEL = '00nMERSHOM'

 
Author
        Philippe Gouin <philippe.gouin@developpement-durable.gouv.fr>