libhydro.conv.shom.shom
index
/home/seb/PHyC_source/libhydro3/libhydro/conv/shom/shom.py

Module shom.
 
Ce module contient des convertisseurs pour les fichiers de predictions
de marees du SHOM:
    simulation_from_hfs()
    simulation_from_h10()
 
On peut aussi manipuler ces donnees comme des observations simplifiees a
l'aide des fonctions suivantes:
    serie_from_hfs()
    serie_from_h10()
 
Format des fichiers HFS:
    # fichier texte, séparateur espace
    # horodatage TU, pas de temps constant
    # une ligne par donnée au format "yyyy-mm-dd hh:mm:ss xx.xx"
    # hauteurs en mètres. Se référer au descriptif du port fourni
        par le SHOM pour déterminer la réference altimétrique
 
Format des fichiers H10:
    # fichier texte, séparateur espace
    # horodatage TU+1, pas de temps constant
    # une ligne par jour, chaque ligne contenant 147 colonnes:
          année YYYY
          code station SHOM (numérique)
          jour de l'année de 1 à 365 (probablement 366)
          144 mesures de H en cm au pas de temps 10 min
    # hauteurs en centimètres. Se référer au descriptif du port fourni
        par le SHOM pour déterminer la réference altimétrique

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

 
Functions
       
serie_from_h10(src, station=None, begin=None, end=None, strict=True)
Retourne une obshydro.Serie a partir d'un fichier H10.
 
La Serie est simplifiee et ne contient que la colonne res.
 
Arguments:
    src (str 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
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 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_h10(src, codemodeleprevision, station=None, begin=None, end=None, dtprod=None, strict=True)
Retourne une simulation.Simulation a partir d'un fichier H10.
 
Arguments:
    src (str ou file) = fichier source
    codemodeleprevision (str <= 10) = code du modèle de prévision
    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
simulation_from_hfs(src, codemodeleprevision, station=None, begin=None, end=None, dtprod=None, strict=True)
Retourne une simulation.Simulation a partir d'un fichier HFS.
 
Arguments:
    src (str ou file) = fichier source
    codemodeleprevision (str <= 10) = code du modèle de prévision
    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