pyspc.model.grp22.cal_basin.GRP_Basin

class pyspc.model.grp22.cal_basin.GRP_Basin(filename=None)[source]

Bases : Config

Structure du fichier Bassin de GRP Calage

filename

Nom du fichier Bassin de GRP Calage

Type:: str

Voir aussi

pyspc.core.config.Config

__init__(filename=None)[source]

Initialisation de l’instance de la classe GRP_Data

Paramètres:: filename (str) – Nom du fichier Bassin de GRP Calage

Methods

`__init__`([filename])	Initialisation de l'instance de la classe GRP_Data
`clear`()
`convert`([functions])	Convertir les valeurs de la configuration
`copy`()
`from_bool`(n)	Convertir un booléen en une chaîne de caractères
`from_csv`([filename, encoding, sectionname, sep])	Lire la configuration au format CSV
`from_datetime`(n[, fmt])	Convertir un datetime en une chaîne de caractères
`from_dictoffloat`(d[, sep1, sep2, fmt])	Convertir dictionnaire de réels en une chaîne de caractères
`from_dictofint`(d[, sep1, sep2, fmt])	Convertir dictionnaire d'entiers en une chaîne de caractères
`from_dictofstr`(d[, sep1, sep2])	Convertir dictionnaire de str en une chaîne de caractères
`from_float`(n[, fmt])	Convertir un réel en une chaîne de caractères
`from_int`(n[, fmt])	Convertir un entier en une chaîne de caractères
`from_listoffloat`(l[, sep, fmt])	Convertir liste de réels en une chaîne de caractères
`from_listofint`(l[, sep, fmt])	Convertir liste d'entiers en une chaîne de caractères
`from_listofintorstr`(l[, sep, fmt])	Convertir liste d'entiers ou de texte en une chaîne de caractères
`from_listofstr`(l[, sep])	Convertir liste de chaînes de caractères en une chaîne de caractères
`from_multitxt`([filenames, encoding, sep])	Lire la configuration depuis plusieurs fichiers TXT
`fromkeys`(iterable[, value])	Create a new ordered dictionary with keys from iterable and values set to value.
`get`(key[, default])	Return the value for key if key is in the dictionary, else default.
`items`()	Return a set-like object providing a view on the dict's items.
`join_basename`([location, timestep])	Définir le nom du fichier de données GRP Basin (GRP Calage) à partir des informations
`keys`()	Return a set-like object providing a view on the dict's keys.
`list_ordered_options`()	Lister les options UNIQUES de la configuration, avec tri
`list_sections_options`()	Lister les sections et options de la configuration
`list_unique_options`()	Lister les options UNIQUES de la configuration, avec tri
`move_to_end`(key[, last])	Move an existing element to the end (or beginning if last is false).
`pop`(key[,default])	If the key is not found, return the default if given; otherwise, raise a KeyError.
`popitem`([last])	Remove and return a (key, value) pair from the dictionary.
`read`()	Lecture du fichier Bassin de GRP Calage
`setdefault`(key[, default])	Insert key with a value of default if key is not in the dictionary.
`split_basename`([filename])	Extraire les informations depuis le nom du fichier de données GRP Basin (GRP Calage)
`to_bool`(text)	Convertir une chaîne de caractères en un booléen
`to_csv`([filename, encoding, sectionname, ...])	Écrire la configuration au format CSV
`to_datetime`(fmt, text)	Convertir une chaîne de caractères en datetime
`to_datetimeformat`(text)	Convertir une chaîne de caractères en format pour datetime
`to_dictoffloat`(text[, sep1, sep2])	Convertir une chaîne de caractères en dictionnaire de réels
`to_dictofint`(text[, sep1, sep2])	Convertir une chaîne de caractères en dictionnaire d'entiers
`to_dictofstr`(text[, sep1, sep2])	Convertir une chaîne de caractères en dictionnaire de str
`to_float`(text)	Convertir une chaîne de caractères en un réel
`to_int`(text)	Convertir une chaîne de caractères en un entier
`to_listofdatetime`(text[, sep, fmt])	Convertir une chaîne de caractères en liste de datetime
`to_listoffloat`(text[, sep])	Convertir une chaîne de caractères en liste de réels
`to_listofint`(text[, sep])	Convertir une chaîne de caractères en liste d'entiers ou de texte
`to_listofintorstr`(text[, sep])	Convertir une chaîne de caractères en liste d'entiers ou de texte
`to_listofstr`(text[, sep])	Convertir une chaîne de caractères en liste de chaînes de caractères
`to_multitxt`([dirname, encoding, sep])	Ecrire la configuration dans plusieurs fichiers TXT
`to_path`(dirname, text)	Convertir une chaîne de caractères en chemin de fichier
`update`([E, ]**F)	If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
`update_config`([config, overwrite, strict])	Mettre à jour la configuration à partir d'un dictionnaire
`values`()	Return an object providing a view on the dict's values.
`write`()	Ecriture du fichier Bassin de GRP Calage

clear() → None. Remove all items from od.

convert(functions=None)

Convertir les valeurs de la configuration

Paramètres:: functions (dict) – Fonctions de conversion à appliquer - clé : (section, option) - valeur : fonction de conversion

copy() → a shallow copy of od

static from_bool(n)

Convertir un booléen en une chaîne de caractères

Paramètres:: n (bool) – Valeur à convertir
Type renvoyé:: Chaîne de caractères

classmethod from_csv(filename=None, encoding='utf-8', sectionname=None, sep=None)

Lire la configuration au format CSV

Paramètres:

filename (str) – Fichier de configuration csv
encoding (str) – Encodage du fichier de configuration “utf-8” par défaut
sectionname (str) – Nom de la colonne utilisée pour “section”
sep (str) – Séparateur, “;” par défaut

Renvoie:

config – Instance Config

Type renvoyé:

Config

static from_datetime(n, fmt=None)

Convertir un datetime en une chaîne de caractères

Paramètres:

n (datetime) – datetime à convertir
fmt (str) – Format. Par défaut: “%Y%m%d%H”

Type renvoyé:

Chaîne de caractères

static from_dictoffloat(d, sep1=None, sep2=None, fmt=None)

Convertir dictionnaire de réels en une chaîne de caractères

Paramètres:

d (dict) – Dictionnaire à convertir
sep1 (str) – Séparateur définissant les groupes “clévaleurSEP…”. Par défaut: “;”
sep2 (str) – Séparateur définissant les clés et valeurs “cléSEPvaleur”. Par défaut: “,”

Type renvoyé:

Chaîne de caractères

static from_dictofint(d, sep1=None, sep2=None, fmt=None)

Convertir dictionnaire d’entiers en une chaîne de caractères

Paramètres:

d (dict) – Dictionnaire à convertir
sep1 (str) – Séparateur définissant les groupes “clévaleurSEP…”. Par défaut: “;”
sep2 (str) – Séparateur définissant les clés et valeurs “cléSEPvaleur”. Par défaut: “,”

Type renvoyé:

Chaîne de caractères

static from_dictofstr(d, sep1=None, sep2=None)

Convertir dictionnaire de str en une chaîne de caractères

Paramètres:

d (dict) – Dictionnaire à convertir
sep1 (str) – Séparateur définissant les groupes “clévaleurSEP…”. Par défaut: “;”
sep2 (str) – Séparateur définissant les clés et valeurs “cléSEPvaleur”. Par défaut: “,”

Type renvoyé:

Chaîne de caractères

static from_float(n, fmt=None)

Convertir un réel en une chaîne de caractères

Paramètres:

n (float) – Valeur à convertir
fmt (str) – Format. Par défaut: “{}”

Type renvoyé:

Chaîne de caractères

static from_int(n, fmt=None)

Convertir un entier en une chaîne de caractères

Paramètres:

n (int) – Valeur à convertir
fmt (str) – Format. Par défaut: “{}”

Type renvoyé:

Chaîne de caractères

static from_listoffloat(l, sep=None, fmt=None)

Convertir liste de réels en une chaîne de caractères

Paramètres:

text (str) – Texte à convertir
sep (str) – Séparateur. Par défaut: “;”
fmt (str) – Format. Par défaut: “{}”

Type renvoyé:

Chaîne de caractères

static from_listofint(l, sep=None, fmt=None)

Convertir liste d’entiers en une chaîne de caractères

Paramètres:

text (str) – Texte à convertir
sep (str) – Séparateur. Par défaut: “;”
fmt (str) – Format. Par défaut: “{}”

Type renvoyé:

Chaîne de caractères

static from_listofintorstr(l, sep=None, fmt=None)

Convertir liste d’entiers ou de texte en une chaîne de caractères

Paramètres:

text (str) – Texte à convertir
sep (str) – Séparateur. Par défaut: “;”
fmt (str) – Format. Par défaut: “{}”

Type renvoyé:

Chaîne de caractères

static from_listofstr(l, sep=None)

Convertir liste de chaînes de caractères en une chaîne de caractères

Paramètres:

l (str) – Texte à convertir
sep (str) – Séparateur. Par défaut: “;”

Type renvoyé:

Chaîne de caractères

classmethod from_multitxt(filenames=None, encoding='utf-8', sep=None)

Lire la configuration depuis plusieurs fichiers TXT

Paramètres:

filenames (str, list, dict) – Fichier(s) de configuration texte
encoding (str) – Encodage du fichier de configuration “utf-8” par défaut
sep (str) – Séparateur, “

Renvoie:

config – Instance Config

Type renvoyé:

Config

classmethod fromkeys(iterable, value=None): Create a new ordered dictionary with keys from iterable and values set to value.

get(key, default=None, /): Return the value for key if key is in the dictionary, else default.

items(): Return a set-like object providing a view on the dict’s items.

static join_basename(location=None, timestep=None)[source]

Définir le nom du fichier de données GRP Basin (GRP Calage) à partir des informations

Paramètres:

location (str) – Identifiant de la station
timestep (str) – Pas de temps du modèle

Renvoie:

filename – Fichier de données GRP Basin (GRP Calage)

Type renvoyé:

str

keys(): Return a set-like object providing a view on the dict’s keys.

list_ordered_options(): Lister les options UNIQUES de la configuration, avec tri

list_sections_options(): Lister les sections et options de la configuration

list_unique_options(): Lister les options UNIQUES de la configuration, avec tri

move_to_end(key, last=True)

Move an existing element to the end (or beginning if last is false).

Raise KeyError if the element does not exist.

pop(key[, default]) → v, remove specified key and return the corresponding value.: If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(last=True)

Remove and return a (key, value) pair from the dictionary.

Pairs are returned in LIFO order if last is true or FIFO order if false.

read()[source]

Lecture du fichier Bassin de GRP Calage

Exemples

>>> from pyspc.model.grp20.cal_basin import GRP_Basin
>>> f = 'data/model/grp20/cal/RH10585x_00J01H00M.DAT'
>>> basin = GRP_Basin(filename=f)
>>> basin.read()
>>> basin
*************************************
*********** GRP 2022 - Basin ********
*************************************
*  NOM FICHIER      = data/model/grp22/cal/RH10585x_00J01H00M.ini
*  LIEU MODELE      = RH10585x
*  PAS DE TEMPS     = 00J01H00M
*  INFORMATIONS     =
*      + RH10585x
*          + etp_pond = 1.00
*      + 90035001
*          + ta_pond = 0.33
*          + ta_alti = 401.00
*      + 90052002
*          + rr_pond = 0.80
*          + rr_pdt = 00J01H00M
*          + ta_pond = 0.33
*          + ta_alti = 473.00
*      + 90065003
*          + rr_pond = 0.20
*          + rr_pdt = 00J01H00M
*          + ta_pond = 0.33
*          + ta_alti = 1153.00
*      + MODELISATION
*          + facteur_neige = 1.00
*          + duree_lacune = 01J00H00M
*************************************

setdefault(key, default=None)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

static split_basename(filename=None)[source]

Extraire les informations depuis le nom du fichier de données GRP Basin (GRP Calage)

Paramètres:

filename (str) – Fichier de données GRP Basin (GRP Calage)

Renvoie:

location (str) – Identifiant de la station
timestep (str) – Pas de temps du modèle

Exemples

>>> from pyspc.model.grp22 import GRP_Basin
>>> f = 'data/model/grp22/cal/RH10585x_00J01H00M.ini'
>>> [location, timestep] = GRP_Basin.split_basename(filename=f)
>>> location
RH10585x
>>> varname
00J01H00M

static to_bool(text)

Convertir une chaîne de caractères en un booléen

Paramètres:: text (str) – Texte à convertir
Type renvoyé:: Booléen

to_csv(filename=None, encoding='utf-8', sectionname=None, sep=None, date_format=None, float_format=None, sort_index=None)

Écrire la configuration au format CSV

Paramètres:

filename (str) – Fichier de configuration csv
encoding (str) – Encodage du fichier de configuration “utf-8” par défaut
sectionname (str) – Nom de la colonne utilisée par “section” et à ajouter dans l’export. Par défaut: “section”
sep (str) – Séparateur, “;” par défaut
date_format (str) – Format des dates. Par défaut: “%Y%m%d%H%M”
float_format (str) – Format des réels
sort_index (bool) – Trier l’index par ordre croissant. Défaut: False

Renvoie:

filename – Fichier de configuration csv

Type renvoyé:

str

Voir aussi

pandas.DataFrame.to_csv,

static to_datetime(fmt, text)

Convertir une chaîne de caractères en datetime

Paramètres:

fmt (str) – Format de la date
text (str) – Texte à convertir

Type renvoyé:

datetime

static to_datetimeformat(text)

Convertir une chaîne de caractères en format pour datetime

Paramètres:: text (str) – Texte à convertir
Type renvoyé:: Format pour datetime

static to_dictoffloat(text, sep1=None, sep2=None)

Convertir une chaîne de caractères en dictionnaire de réels

Paramètres:

text (str) – Texte à convertir
sep1 (str) – Séparateur définissant les groupes “clévaleurSEP…”. Par défaut: “;”
sep2 (str) – Séparateur définissant les clés et valeurs “cléSEPvaleur”. Par défaut: “,”

Type renvoyé:

Dictionnaire de réels

static to_dictofint(text, sep1=None, sep2=None)

Convertir une chaîne de caractères en dictionnaire d’entiers

Paramètres:

text (str) – Texte à convertir
sep1 (str) – Séparateur définissant les groupes “clévaleurSEP…”. Par défaut: “;”
sep2 (str) – Séparateur définissant les clés et valeurs “cléSEPvaleur”. Par défaut: “,”

Type renvoyé:

Dictionnaire d’entiers

static to_dictofstr(text, sep1=None, sep2=None)

Convertir une chaîne de caractères en dictionnaire de str

Paramètres:

text (str) – Texte à convertir
sep1 (str) – Séparateur définissant les groupes “clévaleurSEP…”. Par défaut: “;”
sep2 (str) – Séparateur définissant les clés et valeurs “cléSEPvaleur”. Par défaut: “,”

Type renvoyé:

Dictionnaire de str

static to_float(text)

Convertir une chaîne de caractères en un réel

Paramètres:: text (str) – Texte à convertir
Type renvoyé:: float

static to_int(text)

Convertir une chaîne de caractères en un entier

Paramètres:: text (str) – Texte à convertir
Type renvoyé:: int

static to_listofdatetime(text, sep=None, fmt='%Y%m%d%H')

Convertir une chaîne de caractères en liste de datetime

Paramètres:

text (str) – Texte à convertir
sep (str) – Séparateur. Par défaut: “;”
fmt (str) – Format de la date

Type renvoyé:

Liste de chaînes de caractères

static to_listoffloat(text, sep=None)

Convertir une chaîne de caractères en liste de réels

Paramètres:

text (str) – Texte à convertir
sep (str) – Séparateur. Par défaut: “;”

Type renvoyé:

Liste de réels

static to_listofint(text, sep=None)

Convertir une chaîne de caractères en liste d’entiers ou de texte

Paramètres:

text (str) – Texte à convertir
sep (str) – Séparateur. Par défaut: “;”

Type renvoyé:

Liste d’entiers

static to_listofintorstr(text, sep=None)

Convertir une chaîne de caractères en liste d’entiers ou de texte

Paramètres:

text (str) – Texte à convertir
sep (str) – Séparateur. Par défaut: “;”

Type renvoyé:

Liste d’entiers ou de texte

static to_listofstr(text, sep=None)

Convertir une chaîne de caractères en liste de chaînes de caractères

Paramètres:

text (str) – Texte à convertir
sep (str) – Séparateur. Par défaut: “;”

Type renvoyé:

Liste de chaînes de caractères

to_multitxt(dirname=None, encoding='utf-8', sep=None)

Ecrire la configuration dans plusieurs fichiers TXT

Paramètres:

dirname (str) – Répertoire des fichier
encoding (str) – Encodage du fichier de configuration “utf-8” par défaut
sep (str) – Séparateur, par défaut: “=”

Renvoie:

filenames – Liste de fichiers de configuration texte

Type renvoyé:

list

static to_path(dirname, text)

Convertir une chaîne de caractères en chemin de fichier

Paramètres:

dirname (str) – Répertoire du fichier
text (str) – Texte à convertir

Type renvoyé:

Chemin de fichier

update([E, ]**F) → None. Update D from mapping/iterable E and F.: If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

update_config(config=None, overwrite=None, strict=None)

Mettre à jour la configuration à partir d’un dictionnaire

Paramètres:

config (dict, Config) – Eléments à mettre à jour. {(section, option) : valeur}
overwrite (bool) – Forcer l’écriture si existant, par défaut: True
strict (bool) – Ne considérer que les clés existantes, par défaut: True

values(): Return an object providing a view on the dict’s values.

write()[source]: Ecriture du fichier Bassin de GRP Calage