Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
func Función de algoritmos de optimización (restricción_inferior_límites, restricción_superior_límites
modelo
Pywr.Core.Model
Sí
agg_
agregación de escenarios para usar cuando se agregan_valor se llama
Sí
nombre
Nombre de la grabadora
comentario
Comentario o descripción de la grabadora
ignorar_
Bandera nan para ignorar los valores de NaN al llamar a los agregados_valor
es_
indicador objetivo para indicar la dirección, si la hubiera, de la optimización realizada con este registrador de
distancia épsilon
Epsilon utilizada por algunos
Los valores que se van a utilizar para las definiciones de límites inferior y superior. Estos valores determinan si la instancia del grabador está marcada como una restricción. Cualquiera de los límites puede ser Ninguno (el valor predeterminado) para deshabilitar el límite respectivo. Si ambos límites son Ninguno, entonces es_restricción la propiedad volverá Falso. El límite inferior debe ser estrictamente menor que el límite superior. Se puede crear una restricción de igualdad estableciendo ambos límites en el mismo valor.
Los límites de restricción no se utilizan durante la simulación del modelo. Por el contrario, están diseñados para que los utilicen los contenedores de optimización (u otras herramientas externas) para definir problemas de optimización restringidos.
Ejemplopróximamente...{}
func Función de utilizada por algunos algoritmos de optimización Sí restricción límites
modelo
Pywr.Core.Model
Sí
parámetro
El parámetro que se va a grabar
Sí
agg_
agregación de escenarios para usar cuando se agregan_valor se llama
Sí
nombre
Nombre de la grabadora
Sí
comentario
Comentario o descripción de la grabadora
Sí
ignorar_
Bandera nan para ignorar los valores de NaN al llamar a los agregados_valor
Sí
es_
indicador objetivo para indicar la dirección, si la hubiera, de la optimización realizada con esta grabadora
Sí
distancia épsilon
Epsilon
_inferior_límites, restricción_superior_
Los valores que se van a utilizar para las definiciones de límites inferior y superior. Estos valores determinan si la instancia del grabador está marcada como una restricción. Cualquiera de los límites puede ser Ninguno (el valor predeterminado) para deshabilitar el límite respectivo. Si ambos límites son Ninguno, entonces es_restricción la propiedad volverá Falso. El límite inferior debe ser estrictamente menor que el límite superior. Se puede crear una restricción de igualdad estableciendo ambos límites en el mismo valor.
Los límites de restricción no se utilizan durante la simulación del modelo. Por el contrario, están diseñados para que los utilicen los contenedores de optimización (u otras herramientas externas) para definir problemas de optimización restringidos.
Sí
Ejemplopróximamente...{}
Clase base para grabadoras que rastrean Parámetro valores. API Referencia
func Función de utilizada por algunos algoritmos de optimización Sí restricción límites
modelo
Pywr.Core.Model
Sí
parámetro
El parámetro que se va a grabar
Sí
agg_
agregación de escenarios para usar cuando se agregan_valor se llama
Sí
nombre
Nombre de la grabadora
Sí
comentario
Comentario o descripción de la grabadora
Sí
ignorar_
Bandera nan para ignorar los valores de NaN al llamar a los agregados_valor
Sí
es_
indicador objetivo para indicar la dirección, si la hubiera, de la optimización realizada con esta grabadora
Sí
distancia épsilon
Epsilon
_inferior_límites, restricción_superior_
Los valores que se van a utilizar para las definiciones de límites inferior y superior. Estos valores determinan si la instancia del grabador está marcada como una restricción. Cualquiera de los límites puede ser Ninguno (el valor predeterminado) para deshabilitar el límite respectivo. Si ambos límites son Ninguno, entonces es_restricción la propiedad volverá Falso. El límite inferior debe ser estrictamente menor que el límite superior. Se puede crear una restricción de igualdad estableciendo ambos límites en el mismo valor.
Los límites de restricción no se utilizan durante la simulación del modelo. Por el contrario, están diseñados para que los utilicen los contenedores de optimización (u otras herramientas externas) para definir problemas de optimización restringidos.
Sí
Ejemplopróximamente...{}
description: Descripción general de las grabadoras Pywr compatibles con WaterStrategy
Esta página describe el proceso de creación de una nueva grabadora en WaterStrategy y una selección de los tipos de Pywrrecorder más utilizados y los atributos más utilizados. La lista completa de grabadoras integradas y su lista exhaustiva de atributos son aquí.
En una página de red, haga clic en la pestaña «Grabadoras»:
Junto al texto «Categorías de tipos de grabadoras», haga clic en el botón «+» y seleccione «PYWR\ _RECORDER»:\
Introduzca el nombre de la grabadora. Puede ser lo que quieras, pero debe ser único dentro de la red.
Rellene la grabadora en el editor JSON:
Actualmente, hay dos maneras diferentes de introducir una grabadora en WaterStrategy...
Grabador de información de series temporales de un nodo. API Referencia
Esta clase almacena el flujo de un nodo específico para cada paso de tiempo de una simulación. Los resultados de una grabadora se muestran en el panel de atributos de red y se denominarán «simulado\ _\»'
tipo
grabadora de nodos numparray
Sí
Ninguna
nodo
Nombre del nodo que se va a registrar
Sí
Ninguna
temporal_agg_func
Opcional
malo
agg_func
Opcional
malo
Clase de utilidad para calcular valores agregados.
Es poco probable que los usuarios usen esta clase directamente. En su lugar Grabadora las subclases utilizarán esta funcionalidad para agregar sus resultados en diferentes dimensiones (por ejemplo, tiempo, escenarios, etc.).
_kwargs
Grabador de información de series temporales de un Almacenamiento nodo.
Esta clase almacena el volumen de un nodo específico para cada paso de tiempo de una simulación. Los datos se guardan internamente mediante una vista de memoria. Se puede acceder a los datos a través del dato atributo o _para_método dataframe () _.
próximamente...
func
La función de agregación que se va a utilizar. Puede ser una cadena o un dictado que defina las funciones de agregación, o una función personalizada invocable que realice la agregación.
Cuando es una cadena, puede ser una de las siguientes: «suma», «mínimo», «máximo», «media», «mediana», «producto» o «recuento»_distinto de cero». Estas cadenas se asignan al agregador y hacen que el agregador utilice las funciones numéricas correspondientes
.
Se puede proporcionar un diccionario que contenga una clave «func» y las teclas «args» y «kwargs» opcionales. El valor de «func» debe ser una cadena correspondiente a los nombres numéricos de funciones antes mencionados, con las opciones adicionales de «percentile» y «percentileofscore». Estas dos últimas funciones requieren argumentos adicionales (el percentil y la puntuación) para funcionar y deben proporcionarse como valores en las teclas «args» o «kwargs» del diccionario. Consulte las definiciones de las funciones numpy (o scipy) correspondientes para obtener documentación sobre estos argumentos.
Por último, se puede proporcionar una función invocable. Esta función debe aceptar una matriz numérica 1D o 2D como primer argumento y admitir la palabra clave «axis» como un valor entero que determina en qué eje debe aplicar la agregación la función. La palabra clave axis solo se proporciona cuando se proporciona una matriz 2D. Por lo tanto, `la función invocable debería comportarse de manera similar a las funciones numéricas.
Sí, función
_argumentos
func_
Etiquetas: lista
Sí, función
func_kwargs: dictado
Sí
modelo
Pywr.Core.Model
Sí
nodo
Instancia de nodo para grabar
Sí
proporcional
Si se deben registrar volúmenes de almacenamiento proporcionales [0, 1.0] o absolutos (default=false)
Sí
temporal_agg_func
Función de agregación utilizada a lo largo del tiempo al calcular un valor por escenario. Se puede usar para devolver, por ejemplo, la mediana del flujo en una simulación. Para obtener información sobre la agregación de escenarios, consulte la agg_func argumento de palabra clave
Sí
Grabador para series horarias de área de un Almacenamiento nodo.
Esta clase almacena el área de un nodo específico para cada paso de tiempo de una simulación. Los datos se guardan internamente mediante una vista de memoria. Se puede acceder a los datos a través del dato atributo o _para_método dataframe () _. API Referencia
modelo
Pywr.Core.Model
Sí
nodo
Instancia de nodo para grabar
Sí
temporal_agg_func
Función de agregación utilizada a lo largo del tiempo al calcular un valor por escenario. Se puede usar para devolver, por ejemplo, la mediana del flujo en una simulación. Para obtener información sobre la agregación de escenarios, consulte la agg_func argumento de palabra clave
Sí
próximamente...
Grabadora para un perfil anual de un Parámetro.
Esta grabadora almacena un perfil diario devuelto por un parámetro específico. Para cada día del año, almacena el valor encontrado para ese día durante una simulación. Esto hace que el perfil final sea el último valor encontrado en cada día del año durante una simulación. Esta grabadora es útil para obtener el perfil diario que puede resultar de la combinación de uno o más parámetros. Por ejemplo, durante la optimización de nuevos perfiles, los parámetros no diarios (p. ej. Parámetro de perfil RBF) y/o se pueden usar agregaciones de varios parámetros. Con esta grabadora, el perfil diario utilizado en la simulación se puede guardar fácilmente.
Los datos se guardan internamente mediante una vista de memoria. Se puede acceder a los datos a través del dato atributo o _para_método dataframe () _. API Referencia
modelo
Pywr.Core.Model
Sí
parámetro
Instancia de parámetros a registrar
Sí
temporal_agg_func
Función de agregación utilizada a lo largo del tiempo al calcular un valor por escenario. Para obtener información sobre la agregación de escenarios, consulte la agg_func argumento de palabra clave
Sí
próximamente...
Clase base para registrar información de un Pywr.model.model.
Los componentes del registrador se utilizan para calcular, agregar y guardar datos de una simulación. Esta clase base proporciona la funcionalidad básica para todos los grabadores. API Referencia
func Función de algoritmos de optimización (restricción_inferior_límites, restricción_superior_límites
modelo
Pywr.Core.Model
Sí
agg_
agregación de escenarios para usar cuando se agregan_valor se llama
Sí
nombre
Nombre de la grabadora
comentario
Comentario o descripción de la grabadora
ignorar_
Bandera nan para ignorar los valores de NaN al llamar a los agregados_valor
es_
indicador objetivo para indicar la dirección, si la hubiera, de la optimización realizada con este registrador de
distancia épsilon
Epsilon utilizada por algunos
Los valores que se van a utilizar para las definiciones de límites inferior y superior. Estos valores determinan si la instancia del grabador está marcada como una restricción. Cualquiera de los límites puede ser Ninguno (el valor predeterminado) para deshabilitar el límite respectivo. Si ambos límites son Ninguno, entonces es_restricción la propiedad volverá Falso. El límite inferior debe ser estrictamente menor que el límite superior. Se puede crear una restricción de igualdad estableciendo ambos límites en el mismo valor.
Los límites de restricción no se utilizan durante la simulación del modelo. Por el contrario, están diseñados para que los utilicen los contenedores de optimización (u otras herramientas externas) para definir problemas de optimización restringidos.
Ejemplopróximamente...{}
Esta grabadora calcula una curva de duración del almacenamiento para cada escenario. API Referencia
modelo
Pywr.Core.Model
Sí
nodo
El nodo que se va a grabar
Sí
percentiles
Los percentiles que se utilizarán en el cálculo de la curva de duración del flujo. Los valores deben estar en el rango 0-100
Sí
agg_
función utilizada para agregar el FDC en percentiles.
Se admiten las funciones de estilo numérico que admiten un argumento de eje: Sí, sdc
_agg_func
función diferente opcional para agregar escenarios
Sí
próximamente...
Este registrador calcula una curva de duración del flujo para cada escenario para una estación determinada especificada en meses. API Referencia
modelo
Pywr.Core.Model
Sí
nodo
El nodo que se va a grabar
Sí
percentiles
Los percentiles que se utilizarán en el cálculo de la curva de duración del flujo. Los valores deben estar en el rango 0-100
Sí
agg_func
Función utilizada para agregar las desviaciones del FDC entre los percentiles.
Se admiten las funciones de estilo numérico que admiten un argumento de eje. Sí, fdc
_agg_func
Función diferente opcional para la agregación entre escenarios
Sí
meses
Los valores numéricos de los meses para los que se debe calcular la curva de duración del flujo
Sí
próximamente...
Grabador para series temporales de nivel desde un Almacenamiento nodo.
Esta clase almacena el nivel de un nodo específico para cada paso de tiempo de una simulación. Los datos se guardan internamente mediante una vista de memoria. Se puede acceder a los datos a través del dato atributo o _para_método dataframe () _. API Referencia
modelo
Pywr.Core.Model
Sí
nodo
Instancia de nodo para grabar
Sí
temporal_agg_func
Función de agregación utilizada a lo largo del tiempo al calcular un valor por escenario. Se puede usar para devolver, por ejemplo, la mediana del flujo en una simulación. Para obtener información sobre la agregación de escenarios, consulte la agg_func argumento de palabra clave
Sí
próximamente...
Grabador de información de series temporales de un Parámetro.
Esta clase almacena el valor de un Parámetro para cada paso temporal de una simulación. Los datos se guardan internamente mediante una vista de memoria. Se puede acceder a los datos a través del dato atributo o _para_método dataframe () _. API Referencia
modelo
Pywr.Core.Model
Sí
parámetro
Instancia de parámetros a registrar
Sí
temporal_agg_func
Función de agregación utilizada a lo largo del tiempo al calcular un valor por escenario. Se puede usar para devolver, por ejemplo, la mediana del flujo en una simulación. Para obtener información sobre la agregación de escenarios, consulte la agg_func argumento de palabra clave
Sí
próximamente...
Registrador para series temporales de la relación del flujo suministrado desde un Nodo. Esta clase almacena la relación de suministro de un nodo específico para cada paso de tiempo de una simulación. Los datos se guardan internamente mediante una vista de memoria. Se puede acceder a los datos a través del dato atributo o _para_método dataframe () _. API Referencia
modelo
nodo
Instancia de nodo para grabar
Opcional
temporal_agg_func
Función de agregación utilizada a lo largo del tiempo al calcular un valor por escenario. Se puede usar para devolver, por ejemplo, la mediana del flujo en una simulación. Para obtener información sobre la agregación de escenarios, consulte la agg_func argumento de palabra clave
Opcional
próximamente...
modelo
Pywr.Core.Model
Sí
nodo
El nodo que se va a grabar
Sí
percentiles
Los percentiles que se utilizarán en el cálculo de la curva de duración del flujo. Los valores deben estar en el rango 0-100
Sí
agg_
función utilizada para agregar el FDC en percentiles.
Se admiten funciones de estilo numérico que admiten un argumento de eje. Sí, fdc.
_agg_func
función diferente opcional para agregar escenarios
Sí
modelo
Pywr.Core.Model
Sí
agg_
agregación de escenarios para usar cuando se agregan_valor se llama
Sí
nombre
Nombre de la grabadora
comentario
Comentario o descripción de la grabadora
ignorar_
Bandera nan para ignorar los valores de NaN al llamar a los agregados_valor
es_
indicador objetivo para indicar la dirección, si la hubiera, de la optimización realizada con este registrador de
distancia épsilon
Epsilon utilizada por algunos
Los valores que se van a utilizar para las definiciones de límites inferior y superior. Estos valores determinan si la instancia del grabador está marcada como una restricción. Cualquiera de los límites puede ser Ninguno (el valor predeterminado) para deshabilitar el límite respectivo. Si ambos límites son Ninguno, entonces es_restricción la propiedad volverá Falso. El límite inferior debe ser estrictamente menor que el límite superior. Se puede crear una restricción de igualdad estableciendo ambos límites en el mismo valor.
Los límites de restricción no se utilizan durante la simulación del modelo. Por el contrario, están diseñados para que los utilicen los contenedores de optimización (u otras herramientas externas) para definir problemas de optimización restringidos.
Registrador de series temporales de ratio de reducción desde un Nodo. Esta clase almacena la tasa de reducción de un nodo específico para cada paso temporal de una simulación. Los datos se guardan internamente mediante una vista de memoria. Se puede acceder a los datos a través del dato atributo o _para_método dataframe () _. API Referencia
modelo
nodo
Instancia de nodo para grabar
Opcional
temporal_agg_func
Función de agregación utilizada a lo largo del tiempo al calcular un valor por escenario. Se puede usar para devolver, por ejemplo, la mediana del flujo en una simulación. Para obtener información sobre la agregación de escenarios, consulte la agg_func argumento de palabra clave
Opcional
próximamente...
Grabador de información de series temporales de un Parámetro de índice.
Esta clase almacena el valor de un Parámetro de índice para cada paso temporal de una simulación. Los datos se guardan internamente mediante una vista de memoria. Se puede acceder a los datos a través del dato atributo o _para_método dataframe () _. API Referencia
modelo
Pywr.Core.Model
Sí
parámetro
Instancia de parámetros a registrar
Sí
temporal_agg_func
Función de agregación utilizada a lo largo del tiempo al calcular un valor por escenario. Se puede usar para devolver, por ejemplo, la mediana del flujo en una simulación. Para obtener información sobre la agregación de escenarios, consulte la agg_func argumento de palabra clave
Sí
próximamente...
Esta grabadora se usa para agregar varios otros objetos de la grabadora.
La clase proporciona un método para producir un grabador agregado complejo tomando los resultados de otros registros. El .valores () El método primero recopila valores no agregados de los registradores proporcionados. Luego, estos se agregan por escenario y estas clases los devuelven .valores () método. Este método permite Grabador agregado para usarse como grabadora en otros Grabador agregado instancias.
Por defecto, lo mismo agg_func la función se usa para ambos pasos, pero es opcional grabadora_agg_func puede realizar una agregación diferente en todos los escenarios. Por ejemplo, sumar los registradores por escenario y, a continuación, calcular la media de la suma de los totales.
func Función de
Ejemplopróximamente...{}
modelo
nodo
Instancia de nodo para grabar
Opcional
comentario
comentario
Opcional
modelo
nodo
Instancia de nodo para grabar
Opcional
comentario
comentario
Opcional
modelo
Pywr.Core.Model
Opcional
grabadoras
La otra Grabadora instancias sobre las que realizar la agregación
Opcional
agg_
agregación de escenarios para usar cuando se agregan_valor se llama (default=» mean»)
Opcional
grabadora_agg_func
Función de agregación de grabadoras para usar cuando agregado_el valor se llama (default=`agg_función`)
Opcional
Grabador de información de series temporales de un Nodo.
Esta clase almacena el flujo de un nodo específico para cada paso de tiempo de una simulación. Los datos se guardan internamente mediante una vista de memoria. Se puede acceder a los datos a través del dato atributo o _para_método dataframe () _. API Referencia
modelo
Pywr.Core.Model
Sí
nodo
Instancia de nodo para grabar
Sí
temporal_agg_func
Función de agregación utilizada a lo largo del tiempo al calcular un valor por escenario. Se puede usar para devolver, por ejemplo, la mediana del flujo en una simulación. Para obtener información sobre la agregación de escenarios, consulte la agg_func argumento de palabra clave.
Sí
factor
Se puede proporcionar un factor para escalar el flujo total (por ejemplo, para calcular los costos operativos).
Sí
próximamente...
Esta grabadora calcula una curva de duración del flujo (FDC) para cada escenario y, a continuación, calcula su desviación con respecto a los FDC objetivo superiores e inferiores. La segunda dimensión de la lista de curvas y percentiles de duración objetivo debe tener la misma longitud y estar en el mismo orden (valores de mayor a menor o de menor a mayor).
La desviación se calcula como positiva si el FDC real está por encima del objetivo superior o por debajo del objetivo inferior. Si el FDC real se sitúa entre los objetivos superior e inferior, se devuelve una desviación cero. API Referencia
modelo
Pywr.Core.Model
Sí
nodo
El nodo que se va a grabar
Sí
percentiles
Los percentiles que se utilizarán en el cálculo de la curva de duración del flujo. Los valores deben estar en el rango 0-100
Sí
inferior_objetivo_fdc
El FDC más bajo con el que se comparan los FDC hipotéticos
Sí
superior_objetivo_fdc
El FDC superior con el que se comparan los FDC del escenario
Sí
agg_func
Función utilizada para agregar las desviaciones del FDC entre los percentiles.
Se admiten las funciones de estilo numérico que admiten un argumento de eje. Sí, fdc
_agg_func
Función diferente opcional para la agregación entre escenarios
Sí
próximamente...
Registrador de series temporales de déficit de un Nodo. Esta clase almacena el déficit de un nodo específico para cada paso temporal de una simulación. Los datos se guardan internamente mediante una vista de memoria. Se puede acceder a los datos a través del dato atributo o _para_método dataframe () _. API Referencia
modelo
nodo
Instancia de nodo para grabar
Opcional
temporal_agg_func
Función de agregación utilizada a lo largo del tiempo al calcular un valor por escenario. Se puede usar para devolver, por ejemplo, la mediana del flujo en una simulación. Para obtener información sobre la agregación de escenarios, consulte la agg_func argumento de palabra clave.
Opcional
próximamente...
Registra el valor medio de un Parámetro durante una simulación.
Esta grabadora se puede utilizar para rastrear la media de los valores devueltos por un Parámetro durante una simulación de modelos. Se puede proporcionar un factor opcional para aplicar una escala lineal de los valores. API Referencia
modelo
Pywr.Core.Model
Opcional
nombre
El nombre de la grabadora
Opcional
parámetro
El parámetro que se va a grabar
Necesario
factor
Factor de escala para los valores de parámetro
Opcional
próximamente...
Para cada escenario, registre el flujo total de cada año en una lista de nodos. El resultado de la propiedad de los datos tiene la forma: (años, combinaciones de escenarios).
Se puede proporcionar una lista de factores para escalar el flujo total (por ejemplo, para calcular los costos operativos). API Referencia
modelo
nombre
El nombre de la grabadora
Opcional
nodos
Lista de Pywr.Core.Node instancias para grabar
Opcional
factores
Lista de factores que se deben aplicar a cada nodo
Opcional
próximamente...
Registra el flujo medio de un nodo.
Se puede proporcionar un factor para escalar el flujo total (por ejemplo, para calcular los costos operativos). API Referencia
modelo
nombre
El nombre de la grabadora
Opcional
nodos
Lista de Pywr.Core.Node instancias para grabar
Opcional
factores
Lista de factores que se deben aplicar a cada nodo
Opcional
próximamente...
Grabador para totalizar el flujo de un nodo.
Se puede proporcionar un factor para escalar el flujo total (por ejemplo, para calcular los costos operativos). API Referencia
modelo
nombre
El nombre de la grabadora
Opcional
nodos
Lista de Pywr.Core.Node instancias para grabar
Opcional
factores
Lista de factores que se deben aplicar a cada nodo
Opcional
próximamente...
Registra el flujo medio de un nodo durante los N pasos de tiempo anteriores. API Referencia
modelo
Pywr.Core.Model
Opcional
nodo
El nodo que se va a grabar
Necesario
nombre
El nombre de la grabadora
Opcional
pasos de tiempo
El número de intervalos de tiempo para calcular el flujo medio de
Opcional
próximamente...
Registra el valor total de un Parámetro durante una simulación.
Esta grabadora se puede usar para rastrear la suma total de los valores devueltos por un Parámetro durante una simulación de modelos. Se puede proporcionar un factor opcional para aplicar una escala lineal de los valores. Si el parámetro representa un flujo, integrar el argumento de palabra clave se puede usar para multiplicar los valores por la duración del intervalo de tiempo en días. API Referencia
modelo
Pywr.Core.Model
Opcional
parámetro
El parámetro que se va a grabar
Necesario
nombre
El nombre de la grabadora
Opcional
factor
Factor de escala para los valores de parámetro
Opcional
integrar
Si se debe multiplicar por la duración del intervalo de tiempo en días durante la suma
Opcional
próximamente...
Registre el número de veces que un parámetro de índice supera un umbral para cada escenario.
Esta grabadora contará el número de intervalos de tiempo, por lo que será un recuento diario cuando se ejecute en un intervalo de tiempo diario. API Referencia
modelo
Pywr.Core.Model
Opcional
parámetro
El parámetro que se va a grabar
Necesario
umbral
El umbral con el que comparar el parámetro
Opcional
próximamente...