Description générale

Paramètre simple définissant une valeur constante. API Référence

Attributs

Exemple

``json { type : « paramètre constant », valeur : 123 }

Description générale

Un paramètre variant selon le scénario. Les valeurs de ce paramètre sont constantes dans le temps, mais varient au sein d'un même scénario.

Attributs

taille taille

Exemple

à venir...

``json {

}

Description générale

Paramètre de base fournissant un index méthode.

Attributs

Exemple

à venir...

``json {

}

Description générale

Collection de paramètres IndexParameters. Cette classe se comporte comme un ensemble. Des paramètres peuvent y être ajoutés ou supprimés. Sa valeur est la valeur de ses paramètres enfants agrégés à l'aide d'une fonction d'agrégation (par exemple sum). API Référence

Attributs

Exemple

``json { « type » : « Paramètre agrégé », « agg_func » : « produit », « paramètres » : [ « Demande de référence », « Facteur de demande de la courbe de contrôle » ] }

Dans ce cas, le paramètre agrégé multiplie deux paramètres

* [Demande de référence](https://water-strategy.gitbook.io/water-strategy/modelling-fundamentals/parameters/constant#example)
* Facteur de demande de la courbe de contrôle

Cet exemple montre qu'une demande de référence est multipliée par un facteur qui réduit la demande sur la base d'une courbe de contrôle du réservoir. Vous pouvez cliquer sur chacun de ces paramètres pour voir comment ils sont définis.  

Description générale

Paramètre qui prend le négatif d'un autre Paramètre. API Référence

Attributs

taille taille

Exemple

à venir...

``json {

}

Description générale

Paramètre qui divise un Paramètre par un autre. API Référence

Attributs

Exemple

à venir...

``json {

}

Toutes les Paramètre sous-classes dans pywr sont issus d'une classe de base commune.

Description générale

Paramètre qui en décale un autre Paramètre par une valeur constante.

Cette classe est une version plus efficace de Paramètre agrégé où un seul Paramètre est compensé par une valeur constante. API Référence

Attributs

taille taille optimisation supérieure_limites

Exemple

à venir...

``json {

}

Description générale

Initialisez-vous. Consultez l'aide (type (self)) pour une signature précise.

Attributs

Exemple

à venir...

``json {

}

description: Vue d'ensemble des paramètres Pywr pris en charge par WaterStrategy

Paramètres

Les paramètres sont des fonctions qui renvoient une valeur dans le modèle à chaque pas temporel. Ces valeurs peuvent être une constante, basée sur le temps (par exemple, le jour ou le mois), un calcul basé sur le stockage du réservoir au pas de temps et de nombreux autres calculs. Le paramètre personnalisé peut également être écrit en Python.

Cette page décrit (la plupart) les types de paramètres pris en charge par Pywr. Un aperçu des paramètres de Pywr est disponible . La liste complète des paramètres Pywr intégrés se trouve .

1. Création d'un paramètre

Dans un réseau, cliquez sur l'onglet « Paramètres » :

À côté de la section « Catégories de types de paramètres », cliquez sur le bouton « + » et sélectionnez « PYWR \ _PARAMETER ».

Une saisie de texte apparaîtra. Entrez le nom de votre paramètre : \

Modifiez le paramètre selon les besoins dans l'éditeur JSON fourni :

2. Éditeurs de paramètres dans WaterStrategy

Pour simplifier les modifications de paramètres, WaterStrategy propose des éditeurs pour les paramètres couramment utilisés, tels que les paramètres du profil mensuel, avec des valeurs par défaut préremplies, et des éditeurs graphiques pour simplifier la saisie des données.

Exemple d'éditeur de paramètres

Dans l'onglet Paramètres, lorsque vous ajoutez un nouveau paramètre, sélectionnez « PYWR _PARAMÈTRE _\ _PROFIL MENSUEL » comme indiqué : \

Notez que l'éditeur qui apparaît affichera un onglet JSON, mais également un onglet Plot and Table. La modification des données du tableau mettra automatiquement à jour les données dans le JSON, comme indiqué : \

Ces modifications mettent automatiquement à jour le JSON :

Description générale

Une collection de paramètres d'index

Cette classe se comporte comme un ensemble. Des paramètres peuvent y être ajoutés ou supprimés. Son index est l'indice de ses paramètres enfants agrégés à l'aide d'une fonction d'agrégation (par exemple, sum). API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre qui en prend au moins un autre Paramètre et valeur constante (seuil).

Cette classe est une version plus efficace de Paramètre agrégé où un seul Paramètre est comparé à une valeur constante. API Référence

Attributs

taille taille

Exemple

à venir...

``json {

}

Description générale

Paramètre qui prend au minimum le négatif de Paramètre et valeur constante (seuil). API Référence

Attributs

taille taille

Exemple

à venir...

``json {

}

Description générale

Paramètre fournissant un profil quotidien par scénario.

Ce paramètre fournit un profil annuel répétitif avec une résolution quotidienne. Un profil différent est renvoyé pour chaque membre d'un scénario donné. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre fournissant une valeur uniformément réduite de un à zéro.

Ce paramètre est destiné à être utilisé avec un Stockage virtuel annuel nœud pour fournir un profil qui représente une utilisation moyenne parfaite du volume annuel. Elle renvoie une valeur de 1 le jour de la réinitialisation, puis est réduite de 1/366 chaque jour par la suite. API Référence

Attributs

la valeur initiale Oui reset

Exemple

à venir...

``json {

}

Description générale

Paramètre fournissant un profil hebdomadaire par scénario

Ce paramètre fournit un profil annuel répétitif avec une résolution hebdomadaire. Un profil différent est renvoyé pour chaque membre d'un scénario donné. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre variant dans le temps à l'aide d'un tableau et TimeStep.Index avec facteurs multiplicatifs par scénario.

Les valeurs sont les données chronologiques de référence qui sont perturbées par un facteur. Le facteur est tiré de facteurs qui sont la forme (scenario.size, 12). Par conséquent, les facteurs varient selon les scénarios individuels en termes de scénario et de mois. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre qui prend le maximum de la valeur négative d'un Paramètre et valeur constante (seuil). API Référence

Attributs

taille taille

Exemple

à venir...

``json {

}

Description générale

Paramètre fournissant un profil quotidien.

Le profil quotidien renvoie une valeur différente en fonction du mois de l'intervalle de temps en cours. API Référence

Attributs

Exemple

``json { type : « profil quotidien », valeurs : [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1...] }

Description générale

Paramètre fournissant un profil mensuel. Le profil mensuel renvoie une valeur différente en fonction du mois de l'intervalle de temps en cours.

Attributs

Exemple

``json { type : « profil mensuel », valeurs : [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1] }

Description générale

Ce paramètre lit les données d'un tableau à partir d'une base de données PyTables HDF.

Le paramètre lit les données à l'aide de l'interface de tableau PyTables et ne nécessite donc pas le chargement de l'ensemble de données en mémoire. Ceci est utile pour les grandes séries de modèles.

En stockant les fichiers HDF5 au format « fixe », les utilisateurs peuvent atteindre des vitesses d'accès aux données optimales, faisant de HDF5 un outil efficace pour les scénarios PYWR qui utilisent des DataFrames comme paramètres, où la récupération rapide des données est cruciale. Les fichiers HDF5 sont lus comme un dictionnaire, où chaque clé représente un Pandas DataFrame. Par exemple, la structure d'un fichier inflows.h5 peut contenir trois clés, chacune représentant une rivière différente. Chaque clé contient trois séries chronologiques qui peuvent être attribuées à un scénario Pywr de taille 3.

Si vous utilisez le fichier h5 DataFrame pour exécuter pywr-scenarios, veuillez vous référer à afin d'activer cette fonctionnalité

Remarque : La taille de pywr-scenarios doit correspondre au nombre de clés du fichier h5

Attributs

Exemple

``json { « key » : « Catchment River 1", « scénario » : « Changement climatique », « type » : « Paramètre du cadre de données », « url » : « Entrées .h5", « index_col » : « pas de temps », « parse_dates » : vrai }

Description générale

Un scénario faisant varier IndexParameter. Les valeurs de ce paramètre sont constantes dans le temps, mais varient au sein d'un même scénario. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Le profil hebdomadaire contient 52 semaines par an. La dernière semaine de l'année comptera plus de 7 jours, car 365/7 n'est pas entier. API Référence

Attributs

Exemple

``json { type : « profil hebdomadaire », valeurs : [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1...] }

Description générale

Un paramètre variant selon le scénario.

Les valeurs de ce paramètre varient dans le temps en fonction de l'indice et varient au sein d'un même scénario. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre variant dans le temps à l'aide d'un tableau et de TimeStep.Index

Les valeurs de ce paramètre sont constantes dans tous les scénarios. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre qui utilise un IndexParameter pour indexer un tableau de paramètres.

Un exemple d'utilisation de ce paramètre est de renvoyer un facteur d'économie de demande (sous forme de variable flottante) basé sur le niveau d'économie de demande actuel (calculé par un Paramètre d'index). API Référence

Attributs

Exemple

{
	« tapez » : « indexedarrayparameter »,
	« index_parameter » : « Courbe de contrôle du réservoir »,
	« paramètres » : [
		1,
		0.9,
		0.8,
		0.5
	]
}

Le code ci-dessus utilise l'indice fourni par le paramètre appelé « Courbe de contrôle du réservoir », qui est Paramètre d'indice de courbe de contrôle. L'index 0 renvoie un 1, l'index 2 renvoie 0.9 etc...

Dans cet exemple, ce paramètre est utilisé pour réduire une demande sur la base d'une courbe de contrôle du réservoir. Veuillez vous rendre sur Exemple de paramètre agrégé pour voir comment cela se fait.

Veuillez voir comment le paramètre de la courbe de régulation du réservoir est défini.

Description générale

Paramètre qui prend le maximum d'un autre Paramètre et valeur constante (seuil).

Cette classe est une version plus efficace de Paramètre agrégé où un seul Paramètre est comparé à une valeur constante. API Référence

Attributs

taille taille

Exemple

à venir...

``json {

}

Description générale

Paramètre qui interpole un profil quotidien à l'aide d'une fonction de base radiale (RBF).

Le profil quotidien est calculé pendant le modèle réinitialiser en utilisant une fonction de base radiale avec le jour de l'année comme variable indépendante. Les jours de l'année sont définis par l'utilisateur à côté des valeurs à utiliser pour chacun de ces jours pour l'interpolation. Le premier jour de l'année doit toujours être égal à un, et sa valeur est répétée comme étant la 366e valeur. De plus, les deuxième et avant-dernière valeurs sont mises en miroir pour favoriser l'apparition d'un dégradé cohérent à travers la limite. Les calculs du RBF sont effectués à l'aide du SciPy.Interpolate.RBF objet, veuillez consulter la documentation de Scipy pour plus d'informations. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Renvoie l'une des deux valeurs en fonction du flux précédent dans un nœud. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Renvoie l'une des deux valeurs en fonction de la valeur d'un enregistreur et d'un seuil. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre fournissant un profil mensuel par scénario.

Le comportement est le même que Paramètre de profil mensuel sauf qu'un profil différent est renvoyé pour chaque ensemble dans un scénario donné. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Renvoie l'une des deux valeurs en fonction du volume actuel dans un Storage node. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre de série chronologique avec alignement et rééchantillonnage automatiques. API Référence

Attributs

Exemple

``json { « type » : « Paramètre du cadre de données », « url » : « Flux entrants_mm3_day.csv «, « column » : « Catchment River 1", « index_col » : « pas de temps », « parse_dates » : vrai }

Description générale

Renvoie l'une des deux valeurs en fonction de l'ordinale du pas de temps actuel.

Attributs

Exemple

à venir...

``json {

}

Description générale

Classe de base pour les paramètres renvoyant l'une des deux valeurs en fonction de l'autre état. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Renvoie l'une des deux valeurs en fonction de la valeur d'un paramètre. API Référence

Attributs

Exemple

à venir...

``json {

}

layout: description: visible: false outline: visible: true pagination: visible: true tableOfContents: visible: true title: visible: true

Paramètres d'interpolation

Description générale

La valeur du paramètre est égale à l'interpolation d'un autre paramètre. API Référence

Attributs

Exemple

à venir...

``json {

}

Exemple

{
	« type » : « paramètre controlcurveindex »,
	« storage_node » : « Nom du réservoir »,
	« courbes_de contrôle » : [
		{
			« type » : « paramètre de profil mensuel »,
			« valeurs » : [
				0.45,
				0.45,
			  	0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.6,
				0.6
				]
		},
		{
			« type » : « constante »,
			« valeur » : 0.4
		},		
		{
			« type » : « constante »,
			« valeur » : 0.1
		}		
	]
}

Le code ci-dessus définit 3 courbes de contrôle du réservoir appelées « Nom du réservoir ». Il renvoie un indice en fonction du niveau de remplissage du réservoir :

Pour voir comment cet indice est utilisé avec un Paramètre de tableau indexé cliquez sur ici.

Description générale

UNE Paramètre qui renvoie la valeur d'une série harmonique annuelle.

Ce Paramètre comprend une fonction cosinus de la série N avec une période de 365 jours. Le calcul est effectué en utilisant le jour de Julien de l'année moins 1. Cela entraîne une légère discontinuité les années non bissextiles. API Référence

$f (t) =A+n=1 nan⋅cos (2 nt) /365+n)$

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre qui utilise un paramètre enfant différent dans chaque ensemble de scénarios.

Ce paramètre est utilisé pour passer d'un paramètre enfant à un autre en fonction des différents ensembles d'un même Scénario. Il peut être utilisé pour faire varier les données d'un type de paramètre non sensible au scénario dans plusieurs ensembles de scénarios. Par exemple, de nombreux paramètres de courbe de contrôle ou d'interpolation ne prennent pas explicitement en charge les scénarios. Ce paramètre peut être utilisé pour tester plusieurs définitions de courbes de contrôle dans le cadre d'une seule simulation. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

La valeur du paramètre est égale à la quadrature de l'interpolation d'un autre paramètre.

Attributs

des points de données à interpoler

Exemple

à venir...

``json {

}

Description générale

Paramètre de courbe de contrôle qui effectue une interpole entre deux ou plusieurs paires de valeurs.

Les valeurs de retour sont interpolées linéairement entre deux valeurs en fonction du stockage actuel. La première paire est utilisée entre le maximum et la première courbe de contrôle, la paire suivante entre la première courbe de contrôle et la seconde courbe de contrôle, et ainsi de suite jusqu'à ce que la dernière paire soit utilisée entre la dernière courbe de contrôle et la valeur minimale. La première valeur de chaque paire est la valeur en position haute et la seconde, la valeur en position inférieure. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Classe de base pour tous les paramètres qui reposent sur un nœud attaché contenant un contrôle _Paramètre de courbe. [API Référence] (https://pywr.github.io/pywr-docs/master/api/generated/pywr.parameters.control _Curves.BaseControlCurveParameter.html #pywr .parameters.control \ _Curves.BaseControlCurveParameter)

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre qui renvoie le flux retardé pour un nœud après un nombre donné de pas de temps ou de jours. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Renvoie l'une des deux valeurs en fonction de l'année du pas temporel en cours.

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre qui fournit le flux depuis un nœud depuis le pas de temps précédent.

Remarques : Ce paramètre permet de suivre le flux du pas de temps précédent sur le nœud donné. Ces valeurs peuvent être utilisées dans les calculs pour le pas de temps actuel comme s'il s'agissait de n'importe quel autre paramètre.

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre de courbe de contrôle qui effectue une interpolation entre trois valeurs ou plus.

Les valeurs de retour sont interpolées linéairement entre les courbes de contrôle, la première et la dernière valeur étant respectivement 100% et 0 %. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Le paramètre suit le déficit (max \ _flow - débit réel) d'un nœud. API Référence

Remarques : Ce paramètre est un peu inhabituel dans la mesure où sa valeur est calculée pendant la méthode after, et non calc _valeurs. Il est destiné à être utilisé en combinaison avec un enregistreur (par exemple NumpyArrayNodeRecorder) pour enregistrer le déficit (défini comme étant demandé - flux réel) sur un nœud. Notez que cela signifie que l'enregistrement de ce paramètre pas vous donne la valeur qui a été utilisée par le solveur au cours de cette étape. Ce paramètre peut également être utilisé dans le modèle par d'autres paramètres et évaluera _le déficit d'hier, où le déficit au pas de temps zéro est égal à zéro.

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre d'interpolation générique qui renvoie une valeur basée sur le volume actuel (pas de temps) d'un réservoir ou d'un nœud de stockage. Le

Le paramètre utilise un gamme (tableau) de Volumes des réservoirs et les valeurs correspondantes. Dans ce cas, les valeurs associées sont les valeurs correspondantes Zone du réservoir pour une donnée Volume.

L'interpolation est utilisée pour calculer les valeurs entre les points donnés dans le tableau d'interpolation. API Référence

Attributs

Exemple

Le code Json suivant montre un exemple de courbe d'évaluation de la surface par rapport au volume pour un réservoir. Cela peut être utilisé pour définir l'attribut Area d'un nœud de stockage ou de réservoir.

``json { « type » : « Paramètre de volume interpolé », « node » : « Nom du réservoir ou Storage node », « volumes » : [ 0, 7, 10, 15, 25 ], « valeurs » : [ 1, 2, 4, 6, 14 ],

« interp_kwargs » : {
	« kind » : « linéaire »
},

« comment » : « volumes : Mm3, valeurs : Km2" }

Le Json représente le tableau ci-dessous :

<table><thead><tr><th width="166">Volume (Mm3)</th><th width="182">Superficie (Km2)</th></tr></thead><tbody><tr><td>0</td><td>1</td></tr><tr><td>7</td><td>2</td></tr><tr><td>10</td><td>4</td></tr><tr><td>15</td><td>6</td></tr><tr><td>25</td><td>14</td></tr></tbody></table>

Une fois tracé, il ressemble à ceci :

Vous trouverez ci-dessous un exemple de tableau de classement des zones

<table><thead><tr><th width="166">Volume (Mm3)</th><th width="182">Superficie (Km2)</th></tr></thead><tbody><tr><td>0</td><td>1</td></tr><tr><td>7</td><td>2</td></tr><tr><td>10</td><td>4</td></tr><tr><td>15</td><td>6</td></tr><tr><td>25</td><td>14</td></tr></tbody></table>

Une fois tracé, cela ressemble à ceci

<figure><img src="../../../.gitbook/assets/image (123).png" alt=""><figcaption></figcaption></figure>

Description générale

Paramètre qui intègre une fonction par morceaux.

Ce paramètre calcule l'intégrale d'une fonction par morceaux. La fonction par morceaux est donnée sous la forme de deux tableaux (x et y) et est supposé commencer par (0, 0). Les valeurs de x doit augmenter de façon monotone et être supérieur à zéro. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre d'interpolation générique qui utilise le flux d'un nœud au pas de temps précédent pour l'interpolation. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Paramètre qui renvoie le facteur d'actualisation actuel en fonction du taux d'actualisation et d'une année de référence. API Référence

Attributs

Exemple

à venir...

``json {

}

Description générale

Le paramètre cible hydroélectrique est un paramètre qui renvoie le débit d'une cible de production hydroélectrique. Ce paramètre calcule le débit nécessaire pour générer un objectif de production hydroélectrique particulier. Il est destiné à être utilisé sur un nœud représentant une turbine pour laquelle un objectif de production particulier est requis à chaque étape. API Référence

Attributs

altitude

Exemple

``json {

}