description: Descripción general de los parámetros de Pywr compatibles con WaterStrategy

Parámetros

Los parámetros son funciones que devuelven un valor en el modelo en cada paso de tiempo. Estos valores pueden ser una constante basada en el tiempo (por ejemplo, el día o el mes), un cálculo basado en el almacenamiento del yacimiento en el intervalo de tiempo y muchos otros cálculos. El parámetro personalizado también se puede escribir en Python.

Esta página describe (la mayoría de) los tipos de parámetros admitidos por Pywr. Puede encontrar una descripción general de los parámetros de Pywr aquí. Se encuentra la lista completa de parámetros Pywr integrados aquí.

1. Creación de un parámetro

En una red, haga clic en la pestaña «Parámetros»:

Junto a la sección «Categorías de tipos de parámetros», haga clic en el botón «+» y seleccione «PYWR\ _PARAMETER».

Aparecerá una entrada de texto. Introduzca el nombre de su parámetro:\

Modifique el parámetro según sea necesario en el editor JSON proporcionado:

2. Editores de parámetros en WaterStrategy

Para simplificar las modificaciones de los parámetros, WaterStrategy ofrece editores para los parámetros más utilizados, como los parámetros del perfil mensual, con valores predeterminados rellenados previamente y editores gráficos para facilitar la introducción de datos.

Ejemplo de editor de parámetros

En la pestaña Parámetros, al añadir un nuevo parámetro, seleccione 'PYWR_PARÁMETRO_\ _PERFIL MENSUAL, como se muestra:\

Tenga en cuenta que el editor que aparece mostrará una pestaña JSON, pero también una pestaña Gráfica y Tabla. La modificación de los datos de la tabla actualizará automáticamente los datos del JSON como se muestra a continuación:\

Estos cambios actualizan automáticamente el JSON:

Todas las Parámetro subclases en pywr descienden de una clase base común.

Descripción general

Inicializa self. Consulte la ayuda (type (self)) para obtener una firma precisa. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro base que proporciona un índice método. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro sencillo que define un valor constante. API Referencia

Atributos

Ejemplo

{
    tipo: 'parámetro constante',
    valor: 123
}

Descripción general

Un parámetro que varía en el escenario. Los valores de este parámetro son constantes en el tiempo, pero varían en un único escenario. API Referencia

Atributos

tamaño tamaño

Ejemplo

próximamente...

{

}

Descripción general

Un escenario que varía el IndexParameter. Los valores de este parámetro son constantes en el tiempo, pero varían en un único escenario. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Una colección de IndexParameters. Esta clase se comporta como un conjunto. Los parámetros se pueden añadir o eliminar de ella. Su valor es el valor de sus parámetros secundarios agregados mediante una función de agregación (por ejemplo, suma). API Referencia

Atributos

Ejemplo

{
	«tipo»: «Parámetro agregado»,
	«agg_func»: «producto»,
	«parámetros»: [
		«Demanda de referencia»,
		«Factor de demanda de la curva de control»
	]
}

En este caso, el parámetro agregado multiplica dos parámetros

• Demanda de referencia

• Factor de demanda de la curva de control

Este ejemplo muestra la multiplicación de una demanda de referencia por un factor que reduce la demanda en función de una curva de control de yacimientos. Puede hacer clic en cada uno de estos parámetros para ver cómo están definidos.

Descripción general

Una colección de IndexParameters

Esta clase se comporta como un conjunto. Los parámetros se pueden añadir o eliminar de ella. Su índice es el índice de sus parámetros secundarios agregados mediante una función de agregación (por ejemplo, suma). API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que divide a uno Parámetro por otro. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que toma el negativo de otro Parámetro. API Referencia

Atributos

tamaño tamaño

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que toma el máximo de otro Parámetro y valor constante (umbral).

Esta clase es una versión más eficiente de Parámetro agregado donde un sencillo Parámetro se compara con el valor constante. API Referencia

Atributos

tamaño tamaño

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que toma el máximo del negativo de un Parámetro y valor constante (umbral). API Referencia

Atributos

tamaño tamaño

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que toma el mínimo de otro Parámetro y valor constante (umbral).

Esta clase es una versión más eficiente de Parámetro agregado donde un sencillo Parámetro se compara con el valor constante. API Referencia

Atributos

tamaño tamaño

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que toma el mínimo del negativo de un Parámetro y valor constante (umbral). API Referencia

Atributos

tamaño tamaño

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que compensa a otro Parámetro por un valor constante.

Esta clase es una versión más eficiente de Parámetro agregado donde un sencillo Parámetro se compensa con un valor constante. API Referencia

Atributos

tamaño tamaño optimización (superior)_límites

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que proporciona un perfil diario.

El perfil diario devuelve un valor diferente en función del mes del intervalo de tiempo actual. API Referencia

Atributos

Ejemplo

{
    tipo: 'dailyprofile',
    valores: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1...]
}

Descripción general

El perfil semanal contiene 52 semanas por año. La última semana del año tendrá más de 7 días, ya que 365/7 no es entero. API Referencia

Atributos

Ejemplo

{
    tipo: 'perfil semanal',
    valores: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1...]
}

Descripción general

Parámetro que proporciona un perfil mensual. El perfil mensual devuelve un valor diferente en función del mes del intervalo de tiempo actual. API Referencia

Atributos

Ejemplo

{
    tipo: 'perfil mensual',
    valores: [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1]
}

Water Strategy ofrece una forma alternativa de trabajar con perfiles mensuales.

Descripción general

Parámetro que proporciona un valor que se reduce uniformemente de uno a cero.

Este parámetro está diseñado para usarse con un Almacenamiento virtual anual nodo para proporcionar un perfil que represente la utilización media perfecta del volumen anual. Devuelve un valor de 1 el día del restablecimiento y, posteriormente, se reduce en 1/366 cada día posterior. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que proporciona un perfil diario por escenario.

Este parámetro proporciona un perfil anual que se repite con una resolución diaria. Se devuelve un perfil diferente para cada miembro de un escenario determinado. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que proporciona un perfil semanal por escenario

Este parámetro proporciona un perfil anual repetido con una resolución semanal. Se devuelve un perfil diferente para cada miembro de un escenario determinado. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que proporciona un perfil mensual por escenario.

El comportamiento es el mismo que Parámetro de perfil mensual excepto que se devuelve un perfil diferente para cada conjunto en un escenario determinado. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro variable en el tiempo mediante una matriz y Timestep.index con factores multiplicativos por escenario.

Los valores son los datos de series temporales de referencia que están perturbados por un factor. El factor se toma de los factores que son shape (scenario.size, 12). Por lo tanto, los factores varían según los escenarios individuales en cuanto al escenario y al mes. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que interpola un perfil diario mediante una función de base radial (RBF).

El perfil diario se calcula durante el modelo restablecer utilizando una función de base radial con el día del año como variables independientes. El usuario define los días del año junto con los valores que se utilizarán en cada uno de esos días para la interpolación. El primer día del año siempre debe ser uno y su valor se repite como el valor 366. Además, el segundo y el penúltimo valor se reflejan para fomentar la aparición de un gradiente uniforme a lo largo del límite. Los cálculos del RBF se realizan utilizando el Scipy.Interpolate.rbf objeto, consulte la documentación de Scipy para obtener más información. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro de serie temporal con alineación y remuestreo automáticos. API Referencia

Atributos

Ejemplo

{
	«tipo»: «Parámetro de marco de datos»,
	«url»: «Entradas_mm3_day.csv «,
	«columna»: «Catchment River 1",
	«index_col»: «paso de tiempo»,
	«parse_dates»: verdadero
}

Descripción general

Este parámetro lee los datos de la matriz de una base de datos HDF de PyTables.

El parámetro lee los datos mediante la interfaz de matriz PyTables y, por lo tanto, no requiere cargar todo el conjunto de datos en la memoria. Esto es útil para ejecuciones de modelos de gran tamaño. API Referencia

Al almacenar los archivos HDF5 en formato «fijo», los usuarios pueden alcanzar velocidades óptimas de acceso a los datos, lo que convierte a HDF5 en una herramienta eficaz para los escenarios de PyWR que utilizan DataFrames como parámetros, donde la recuperación rápida de datos es crucial. Los archivos HDF5 se leen como un diccionario, donde cada clave representa un DataFrame de pandas. Por ejemplo, la estructura de un archivo inflows.h5 puede contener tres claves, cada una de las cuales representa un río diferente. Cada clave contiene tres series temporales que se pueden asignar a un escenario de Pywr de tamaño 3.

Si utiliza el DataFrame del archivo h5 para ejecutar pywr-scenarios, consulte sección pywr-scenarios para activar esta función

Nota: El tamaño de pywr-scenarios debe coincidir con el número de claves del archivo h5

Atributos

Ejemplo

{
	«clave»: «Catchment River 1",
	«escenario»: «Cambio climático»,
	«tipo»: «Parámetro de marco de datos»,
	«url»: «inflows.h5",
	«index_col»: «paso de tiempo»,
	«parse_dates»: verdadero
}

Descripción general

Parámetro que varía en el tiempo mediante una matriz y Timestep.index

Los valores de este parámetro son constantes en todos los escenarios. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Un parámetro que varía en el escenario.

Los valores de este parámetro varían en el tiempo según el índice y varían dentro de un único escenario. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que usa un IndexParameter para indexar una matriz de parámetros.

Un ejemplo de uso de este parámetro es devolver un factor de ahorro de demanda (como variable) en función del nivel de ahorro de demanda actual (calculado mediante un Parámetro de índice). API Referencia

Atributos

Ejemplo

{
	«tipo»: «indexedarrayparameter»,
	«index_parameter»: «Curva de control del depósito»,
	«parámetros»: [
		1,
		0.9,
		0.8,
		0.5
	]
}

El código anterior utiliza el índice proporcionado por el parámetro denominado «Curva de control del depósito», que es un Parámetro de índice de la curva de control. El índice 0 devuelve un 1, el índice 2 devuelve 0.9, etc.

En este ejemplo, este parámetro se usa para reducir la demanda en función de una curva de control de yacimientos. Por favor, diríjase a Ejemplo de parámetro agregado para ver cómo se hace.

Consulte cómo se define el parámetro de la curva de control del depósito.

Descripción general

Clase base para los parámetros que devuelven uno de los dos valores en función del otro estado. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Devuelve uno de los dos valores según el volumen actual de un Storage node. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Devuelve uno de los dos valores en función del flujo anterior de un nodo. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Devuelve uno de los dos valores en función del valor de un parámetro. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Devuelve uno de los dos valores en función del valor de la grabadora y del umbral. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Devuelve uno de los dos valores en función del año del intervalo de tiempo actual. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Devuelve uno de los dos valores en función del ordinal del intervalo de tiempo actual. API Referencia

Atributos

Ejemplo

próximamente...

{

}

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

Parámetros de interpolación

Descripción general

El valor del parámetro es igual a la interpolación de otro parámetro. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

El valor del parámetro es igual a la cuadratura de la interpolación de otro parámetro. API Referencia

Atributos

de los puntos de datos para la interpolación Coordenadas de los puntos interpolación Opcional inferior

Ejemplo

próximamente...

{

}

Descripción general

Parámetro de interpolación genérico que usa el flujo de un nodo en el paso de tiempo anterior para la interpolación. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro de interpolación genérico que devuelve un valor basado en el volumen actual (intervalo de tiempo) de un depósito o nodo de almacenamiento. El

El parámetro usa un gama (tabla) de Volúmenes de reservorios y los valores correspondientes. En este caso, los valores asociados son los correspondientes Área del embalse por un hecho Volumen.

La interpolación se usa para calcular los valores entre los puntos dados en la matriz de interpolación. API Referencia

Atributos

Ejemplo

El siguiente Json muestra un ejemplo de una cura entre la clasificación de área y volumen para un depósito. Esto podría usarse para definir el atributo de área de un nodo de almacenamiento o depósito.

{
  «type»: «Parámetro de volumen interpolado»,
  «node»: «Nombre del depósito o Storage node»,
	«volúmenes»: [
		0,
		7,
		10,
		15,
		25
	],
	«valores»: [
		1,
		2,
		4,
		6,
		14
	],

	«interp_kwargs»: {
		«kind»: «lineal»
	},
  «comentario»: «volúmenes: Mm3, valores: Km2"
}

El Json representa la siguiente tabla:

Cuando se traza, se ve así:

A continuación se muestra un ejemplo de tabla de clasificación por área

Cuando se traza, se ve así

Descripción general

Clase base para todos los parámetros que dependen de un nodo adjunto que contiene un control_Parámetro de curva. [API Referencia] (https://pywr.github.io/pywr-docs/master/api/generated/pywr.parameters.control_Curves.BaseControlCurveParameter.html #pywr .parameters.control\ _Curves.BaseControlCurveParameter)

Atributos

(

Ejemplo

próximamente...

{

}

Descripción general

Parámetro de la curva de control que interpola entre tres o más valores.

Los valores devueltos se interpolan linealmente entre las curvas de control, siendo el primer y el último valor 100% y 0% respectivamente. API Referencia

Atributos

(

Ejemplo

próximamente...

{

}

Descripción general

Parámetro de la curva de control que interpola entre dos o más pares de valores.

Los valores devueltos se interpolan linealmente entre un par de valores según el almacenamiento actual. El primer par se utiliza entre el máximo y la primera curva de control, el siguiente par entre la primera curva de control y la segunda curva de control, y así sucesivamente hasta que se utilice el último par entre la última curva de control y el valor mínimo. El primer valor de cada par es el valor de la posición superior y el segundo el valor de la posición inferior. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Ejemplo

{
	«tipo»: «parámetro controlcurveindex»,
	«storage_node»: «Nombre del depósito»,
	«curvas de control»: [
		{
			«type»: «parámetro de perfil mensual»,
			«valores»: [
				0.45,
				0.45,
			  	0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.45,
				0.6,
				0.6
				]
		},
		{
			«tipo»: «constante»,
			«valor»: 0.4
		},		
		{
			«tipo»: «constante»,
			«valor»: 0.1
		}		
	]
}

El código anterior define 3 curvas de control del depósito denominadas «Nombre del depósito». Devuelve un índice en función de qué tan lleno esté el depósito:

Para ver cómo se usa este índice con un Parámetro de matriz indexada hacer clic aquí.

Descripción general

El parámetro objetivo de energía hidroeléctrica es un parámetro que devuelve el flujo de un objetivo de generación de energía hidroeléctrica. Este parámetro calcula el flujo necesario para generar un objetivo de producción hidroeléctrica en particular. Está diseñado para usarse en un nodo que represente una turbina en el que se requiera un objetivo de producción particular en cada etapa temporal. API Referencia

Atributos

_flujo_cabezaelevación

Ejemplo

{

}

Descripción general

UN Parámetro que devuelve el valor de una serie armónica anual.

Esto Parámetro comprende una función cosenoidal de la serie N con un período de 365 días. El cálculo se realiza utilizando el día Julien del año menos 1. Esto provoca una pequeña discontinuidad en los años no bisiestos. API Referencia

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

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Los parámetros rastrean el déficit (max\ _flow - flujo real) de un nodo. API Referencia

Notas: Este parámetro es un poco inusual porque su valor se calcula con el método after, no con calc_valores. Está diseñado para usarse en combinación con una grabadora (por ejemplo, NumpyArrayNodeRecorder) para registrar el déficit (definido como el flujo real solicitado) en un nodo. Tenga en cuenta que esto significa que registrar este parámetro sí no le dan el valor que usó el solucionador en este paso de tiempo. Como alternativa, otros parámetros pueden usar este parámetro en el modelo y se evaluará como _déficit de ayer, donde el déficit en el intervalo de tiempo cero es cero.

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que utiliza un parámetro secundario diferente en cada conjunto de escenarios.

Este parámetro se usa para cambiar entre diferentes parámetros secundarios en función de diferentes conjuntos en un determinado Escenario. Se puede usar para variar los datos de un tipo de parámetro que no tenga en cuenta el escenario en varios conjuntos de escenarios. Por ejemplo, muchos de los parámetros de interpolación o de curva de control no admiten escenarios de forma explícita. Este parámetro se puede usar para probar varias definiciones de curvas de control como parte de una única simulación. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que integra una función por partes.

Este parámetro calcula la integral de una función por partes. La función por partes se da en forma de dos matrices (x y y) y se supone que comienza desde (0, 0). Los valores de x debería ser monótonamente creciente y superior a cero. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que proporciona el flujo desde un nodo del paso de tiempo anterior. API Referencia

Notas: Este parámetro realiza un seguimiento del flujo del paso de tiempo anterior en el nodo dado. Estos valores se pueden usar en los cálculos del período de tiempo actual como si se tratara de cualquier otro parámetro.

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que devuelve el flujo retrasado de un nodo después de un número determinado de intervalos de tiempo o días. API Referencia

Atributos

Ejemplo

próximamente...

{

}

Descripción general

Parámetro que devuelve el factor de descuento actual en función de la tasa de descuento y un año base. API Referencia

Atributos

Ejemplo

próximamente...

{

}