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...
用于追踪的录音机的基础类 参数 价值观。 API 参考资料
func 某些优化算法是约束
模型
pywr.core.model
是的
参数
要记录的参数
是的
AGG_
聚合时使用的场景聚合函数_价值 被称为
是的
名称
录音机的名称
是的
评论
录音机的评论或描述
是的
忽视_
调用聚合时忽略 NaN 值的 nan 标志_价值
是的
是_
object
ive 标记,用于表示使用此记录器进行优化的方向(如果有)
是
epsilon
使用的 Epsilon 距离
_更低_边界,约束_上部_bound
s 用于下限和上限定义的值。这些值决定录制器实例是否被标记为约束。任一绑定都可以为 “无”(默认)以禁用相应的边界。如果两个边界都为无,则为_约束 财产将返回 假的。下限必须严格小于上限。通过将两个边界设置为相同的值,可以创建相等约束。
模型仿真期间不使用约束边界。相反,它们旨在供优化包装器(或其他外部工具)用来定义受限的优化问题。
是的
示例即将推出...``json {}
func
要使用的聚合函数。可以是定义聚合函数的字符串或字典,也可以是执行聚合的可调用自定义函数。
如果是字符串,则可以是:“总和”、“最小值”、“最大值”、“平均值”、“中位数”、“乘积” 或 “计数” 之一_非零”。这些字符串映射到并导致聚合器使用相应的 num py
函数。
可以提供一个包含 “函数” 密钥以及可选的 “args” 和 “kwargs” 键的字典。“func” 的值应该是一个与前面提到的 numpy 函数名称相对应的字符串,并带有 “百分位数” 和 “百分位数” 等附加选项。后两个函数需要额外的参数(百分位数和分数)才能起作用,并且必须作为值在字典的 “args” 或 “kwargs” 键中提供。有关这些参数的文档,请参阅相应的 numpy(或 scipy)函数定义
。
最后,可以给出一个可调用的函数。此函数必须接受一维或二维 numpy 数组作为第一个参数,并支持 “axis” 关键字作为整数值,该整数值决定该函数应在哪个轴上应用聚合。axis 关键字仅在给出 2D 数组时提供。因此,`可调用函数的行为应与 numpy 函数类似
是的
func_args
func_args: 列表
是
函数_kwargs
func_kwargs: 字典
是的
模型
pywr.core.model
是的
节点
要记录的节点实例
是的
时间的_AGG_func
计算每个场景的值时随时间推移使用的聚合函数。例如,这可以用来返回仿真中的中流量。有关场景的聚合,请参阅 agg_func 关键字参数。
是的
因素
可以提供一个系数来调整总流量(例如,用于计算运营成本)。
是的
模型
pywr.core.model
是的
AGG_
聚合时使用的场景聚合函数_价值 被称为
是的
名称
录音机的名称
评论
录音机的评论或描述
忽视_
调用聚合时忽略 NaN 值的 nan 标志_价值
是_
目标
标志,用于表示使用此记录器进行的优化方向
epsilon Epsilon
距离
s 用于下限和上限定义的值。这些值决定录制器实例是否被标记为约束。任一绑定都可以为 “无”(默认)以禁用相应的边界。如果两个边界都为无,则为_约束 财产将返回 假的。下限必须严格小于上限。通过将两个边界设置为相同的值,可以创建相等约束。
模型仿真期间不使用约束边界。相反,它们旨在供优化包装器(或其他外部工具)用来定义受限的优化问题。
模型
pywr.core.model
是的
节点
要记录的节点实例
是的
时间的_AGG_func
计算每个场景的值时随时间推移使用的聚合函数。例如,这可以用来返回仿真中的中流量。有关场景的聚合,请参阅 agg_func 关键字参数
是的
记录来自 a 的时间序列信息 存储 节点。
该类存储仿真每个时间步来自特定节点的体积。数据使用内存视图在内部保存。数据可以通过以下方式访问 数据 属性或 _到_dataframe () _ 方法。 API 参考资料
模型
pywr.core.model
是的
节点
要记录的节点实例
是的
成比例的
是记录成比例的 [0, 1.0] 还是绝对存储量(默认 = 假)
是的
时间的_AGG_func
计算每个场景的值时随时间推移使用的聚合函数。例如,这可以用来返回仿真中的中流量。有关场景的聚合,请参阅 agg_func 关键字参数
是的
即将推出...
``json {
}
记录来自的时间序列信息 索引参数。
该类存储来自特定值的值 索引参数 对于仿真的每个时间步长。数据使用内存视图在内部保存。数据可以通过以下方式访问 数据 属性或 _到_dataframe () _ 方法。 API 参考资料
模型
pywr.core.model
是的
参数
要记录的参数实例
是的
时间的_AGG_func
计算每个场景的值时随时间推移使用的聚合函数。例如,这可以用来返回仿真中的中流量。有关场景的聚合,请参阅 agg_func 关键字参数
是的
即将推出...
``json {
}
description: WaterStrategy 支持的 Pywr 记录器概述
本页介绍在 WaterStrategy 中创建新记录器的过程,以及一些最常用的 Pywrrecorder 类型和最常用的属性。内置记录器的完整列表及其详尽的属性列表是 。
在 “网络” 页面中,单击 “录像机” 选项卡:
在 “记录器类型类别” 文本旁边,单击 “+” 按钮并选择 “PYWR\ _RECORDER”:\
输入录音机的名称。这可以是你喜欢的任何东西, 但必须在网络中是唯一的。
在 JSON 编辑器中填充记录器:
目前,在 WaterStrategy 中有两种不同的输入记录器的方式。...
该类存储仿真每个时间步来自特定节点的流量。记录器的结果输出在 “网络属性” 面板上,并将命名为 “模拟\ _<recordername>'
``json { “类型”:“NumpyArrayNodeRecorder”, “节点”:“水库 1”, “时间的_AGG_func”: “平均值”, “agg_func”:“平均值” }
记录来自节点的时间序列信息。
类型
numpyarraynodeRecorder
是的
无
节点
要记录的节点的名称
是的
无
时间的_AGG_func
可选
意思
agg_func
可选
意思
模型
pywr.core.model
是的
节点
要记录的节点
是的
百分位数
用于计算流量持续时间曲线的百分位数。值必须在 0-100 范围内
是的
AGG_func
函数,用于聚合百分位数的 FDC。
支持轴参数的 Numpy 样式函数是的 fdc
_agg_func
可选的不同功能,用于跨场景汇总
是的
来自 a 的区域时间序列记录器 存储 节点。
该类存储仿真每个时间步的特定节点的区域。数据使用内存视图在内部保存。数据可以通过以下方式访问 数据 属性或 _到_dataframe () _ 方法。 API 参考资料
模型
pywr.core.model
是的
节点
要记录的节点实例
是的
时间的_AGG_func
计算每个场景的值时随时间推移使用的聚合函数。例如,这可以用来返回仿真中的中流量。有关场景的聚合,请参阅 agg_func 关键字参数
是的
即将推出...
``json {
}
缩减比率的时间序列记录器 节点。该类存储仿真每个时间步的特定节点的缩减率。数据使用内存视图在内部保存。数据可以通过以下方式访问 数据 属性或 _到_dataframe () _ 方法。 API 参考资料
模型
节点
要记录的节点实例
可选
时间的_AGG_func
计算每个场景的值时随时间推移使用的聚合函数。例如,这可以用来返回仿真中的中流量。有关场景的聚合,请参阅 agg_func 关键字参数
可选
即将推出...
``json {
}
func 某些优化算法约束使用的(如果有)_更低_边界,约束_上部_bound
模型
pywr.core.model
是的
AGG_
聚合时使用的场景聚合函数_价值 被称为
是的
名称
录音机的名称
评论
录音机的评论或描述
忽视_
调用聚合时忽略 NaN 值的 nan 标志_价值
是_
目标
标志,用于表示使用此记录器进行的优化方向
epsilon Epsilon
距离
s 用于下限和上限定义的值。这些值决定录制器实例是否被标记为约束。任一绑定都可以为 “无”(默认)以禁用相应的边界。如果两个边界都为无,则为_约束 财产将返回 假的。下限必须严格小于上限。通过将两个边界设置为相同的值,可以创建相等约束。
模型仿真期间不使用约束边界。相反,它们旨在供优化包装器(或其他外部工具)用来定义受限的优化问题。
示例即将推出...``json {}
记录来自 a 的时间序列信息 参数。
该类存储来自特定值的值 参数 对于仿真的每个时间步长。数据使用内存视图在内部保存。数据可以通过以下方式访问 数据 属性或 _到_dataframe () _ 方法。 API 参考资料
模型
pywr.core.model
是的
参数
要记录的参数实例
是的
时间的_AGG_func
计算每个场景的值时随时间推移使用的聚合函数。例如,这可以用来返回仿真中的中流量。有关场景的聚合,请参阅 agg_func 关键字参数
是的
即将推出...
``json {
}
用于记录来自 a 的信息的基类 pywr.model.model。
记录器组件用于计算、聚合和保存仿真数据。该基类为所有录制器提供基本功能。 API 参考资料
func 某些优化算法约束使用的(如果有)_更低_边界,约束_上部_bound
模型
pywr.core.model
是的
AGG_
聚合时使用的场景聚合函数_价值 被称为
是的
名称
录音机的名称
评论
录音机的评论或描述
忽视_
调用聚合时忽略 NaN 值的 nan 标志_价值
是_
目标
标志,用于表示使用此记录器进行的优化方向
epsilon Epsilon
距离
s 用于下限和上限定义的值。这些值决定录制器实例是否被标记为约束。任一绑定都可以为 “无”(默认)以禁用相应的边界。如果两个边界都为无,则为_约束 财产将返回 假的。下限必须严格小于上限。通过将两个边界设置为相同的值,可以创建相等约束。
模型仿真期间不使用约束边界。相反,它们旨在供优化包装器(或其他外部工具)用来定义受限的优化问题。
示例即将推出...``json {}
该记录器计算每种场景的存储持续时间曲线。 API 参考资料
模型
pywr.core.model
是的
节点
要记录的节点
是的
百分位数
用于计算流量持续时间曲线的百分位数。值必须在 0-100 范围内
是的
AGG_func
函数,用于聚合百分位数的 FDC。
支持轴参数的 Numpy 样式函数是的 sdc
_agg_func
可选的不同功能,用于跨场景汇总
是的
即将推出...
``json {
}
该记录器计算每种情景的流量持续时间曲线 (FDC),然后计算其与上限和下限目标 FDC 的偏差。目标持续时间曲线和百分位数列表的第二维度必须具有相同的长度和顺序(从高到低的值或从低到高的值)。
如果实际 FDC 高于上限目标值或低于下限目标,则偏差计算为正值。如果实际 FDC 落在上限和下限目标之间,则返回零偏差。 API 参考资料
模型
pywr.core.model
是的
节点
要记录的节点
是的
百分位数
用于计算流量持续时间曲线的百分位数。值必须在 0-100 范围内
是的
更低_目标_fdc
与场景 FDC 进行比较的较低 FDC
是的
上部_目标_fdc
与场景 FDC 进行比较的上限 FDC
是的
AGG_func
函数,用于聚合百分位数上的 FDC 偏差。
支持轴参数的 Numpy 样式函数是的 fdc
_agg_func
可选的不同功能,用于跨场景汇总
是的
即将推出...
``json {
}
模型
名称
录音机的名字
可选
节点
清单 pywr.core.node 要记录的实例
可选
因素
适用于每个节点的因子列表
可选
该记录器计算给定季节中每种情景的流量持续时间曲线(以月为单位)。 API 参考资料
模型
pywr.core.model
是的
节点
要记录的节点
是的
百分位数
用于计算流量持续时间曲线的百分位数。值必须在 0-100 范围内
是的
AGG_func
函数,用于聚合百分位数上的 FDC 偏差。
支持轴参数的 Numpy 样式函数是的 fdc
_agg_func
可选的不同功能,用于跨场景汇总
是的
月份
应计算流量持续时间曲线的月份的数值
是的
即将推出...
``json {
}
模型
节点
要记录的节点实例
可选
时间的_AGG_func
计算每个场景的值时随时间推移使用的聚合函数。例如,这可以用来返回仿真中的中流量。有关场景的聚合,请参阅 agg_func 关键字参数
可选
年度简介记录器 参数。
该记录器存储由特定参数返回的每日配置文件。对于一年中的每一天,它存储模拟期间当天遇到的值。这使得最终配置文件成为仿真期间一年中每天遇到的最后一个值。此记录器可用于返回可能由一个或多个参数组合生成的每日概况。例如,在优化新配置文件期间,非每日参数(例如 RBF 配置文件参数) 和/或可以使用多个参数的聚合。使用此记录器,可以轻松保存模拟中使用的每日配置文件。
数据使用内存视图在内部保存。数据可以通过以下方式访问 数据 属性或 _到_dataframe () _ 方法。 API 参考资料
模型
pywr.core.model
是的
参数
要记录的参数实例
是的
时间的_AGG_func
计算每个场景的值时随时间推移使用的聚合函数。有关场景的聚合,请参阅 agg_func 关键字参数
是的
即将推出...
``json {
}
func 某些优化算法是约束
模型
pywr.core.model
是的
参数
要记录的参数
是的
AGG_
聚合时使用的场景聚合函数_价值 被称为
是的
名称
录音机的名称
是的
评论
录音机的评论或描述
是的
忽视_
调用聚合时忽略 NaN 值的 nan 标志_价值
是的
是_
object
ive 标记,用于表示使用此记录器进行优化的方向(如果有)
是
epsilon
使用的 Epsilon 距离
_更低_边界,约束_上部_bound
s 用于下限和上限定义的值。这些值决定录制器实例是否被标记为约束。任一绑定都可以为 “无”(默认)以禁用相应的边界。如果两个边界都为无,则为_约束 财产将返回 假的。下限必须严格小于上限。通过将两个边界设置为相同的值,可以创建相等约束。
模型仿真期间不使用约束边界。相反,它们旨在供优化包装器(或其他外部工具)用来定义受限的优化问题。
是的
示例即将推出...``json {}
记录 a 的平均值 参数 在模拟过程中。
此记录器可用于跟踪返回值的平均值 参数 在模型仿真过程中。可以提供一个可选因子来对值进行线性缩放。 API 参考资料
模型
pywr.core.model
可选
名称
录音机的名字
可选
参数
要记录的参数
必填项
因素
值的缩放系数 参数
可选
即将推出...
``json {
}
对于每种方案,记录每年节点列表中的总流量。数据属性的输出形状为:(年份、场景组合)。
可以提供一系列因素来调整总流量(例如,用于计算运营成本)。 API 参考资料
模型
名称
录音机的名字
可选
节点
清单 pywr.core.node 要记录的实例
可选
因素
适用于每个节点的因子列表
可选
即将推出...
``json {
}
来自a的赤字时间序列记录器 节点。该类存储仿真每个时间步来自特定节点的赤字。数据使用内存视图在内部保存。数据可以通过以下方式访问 数据 属性或 _到_dataframe () _ 方法。 API 参考资料
模型
节点
要记录的节点实例
可选
时间的_AGG_func
计算每个场景的值时随时间推移使用的聚合函数。例如,这可以用来返回仿真中的中流量。有关场景的聚合,请参阅 agg_func 关键字参数。
可选
即将推出...
``json {
}
记录节点在前 N 个时间步中的平均流量。 API 参考资料
模型
pywr.core.model
可选
节点
要记录的节点
必填项
名称
录音机的名字
可选
时间步长
计算平均流量的时间步数
可选
即将推出...
``json {
}
此记录器用于聚合多个其他记录器对象。
该类提供了一种通过获取其他记录的结果来生成复杂的聚合记录器的方法。这个 .values () 方法首先从提供的记录器中收集未聚合的值。然后根据每个场景对它们进行汇总并由该类返回 .values () 方法。这个方法允许 聚合记录器 用作其他录音机 聚合记录器 实例。
默认情况下是一样的 agg_func 两个步骤都使用函数,但可选 录音机_agg_func 可以跨场景进行不同的聚合。例如,对每个场景的记录器求和,然后取总和的平均值。 API 参考资料
func
模型
pywr.core.model
可选
录音机
另一个 录音机 用于执行聚合的实例
可选
AGG_
聚合时使用的场景聚合函数_价值 被调用(默认= “均值”)
可选
录音机_AGG_func
录制器聚合功能可在何时使用 汇总_值被调用(默认值=`agg_func`)
可选
示例即将推出...``json {}
将最低音量录制为 存储 模拟期间的节点。 API 参考资料
模型
pywr.core.model
可选
节点
要记录的节点
必填项
名称
录音机的名字
可选
即将推出...
``json {
}
模型
pywr.core.model
可选
节点
要记录的节点
必填项
名称
录音机的名字
可选
阈值
要将参数与之比较的阈值
可选
使用水力发电方程计算发电量
该记录器保存了每个时间步中的水力发电量阵列。模型运行完成后,可以将其转换为数据框。它不计算总能量产量。 API 参考资料
涡轮转换
水_仰角_参数
进入涡轮机的水的海拔。此值与 涡轮机_仰角给出涡轮机的工作头
所需的
涡轮机_仰角
涡轮机本身的高度。两者之间的区别 水_仰角和该值给出了涡轮机的工作头
所需的
效率
机的效率
可选
密度
水的密度
可选
流量_单元_
用于将流量单位转换为与此处方程兼容的系数。
_单位转换
可选
即将推出...
``json {
}
这应该将流量转换为单位可选能量
用于转换总能量单位的因子。默认为 1e-6 返回
对于每种方案,计算参数列表每年超过阈值的次数。如果在一个时间步长内超过多个参数,则仅计算一次。
数据属性的输出形状为:(年份、场景组合)。 API 参考资料
模型
pywr.core.model
可选
参数
清单 pywr.core.Index参数 记录下来
必填项
名称
录音机的名字
可选
阈值
用于比较参数的阈值
可选
排除月份
可选的月份数字列表,可从计数中排除
可选
即将推出...
``json {
}
将节点值保存到 CSV 文件中的记录器。
该类使用 Python 标准库中的 csv 包。 API 参考资料
模型
用于记录节点的模型
可选
csv 文件
CSV 文件的路径
必填项
scenao_index
要保存的模型的场景索引
必填项
节点
用于保存数据的节点的迭代器。默认为 None,即模型中的所有节点
必填项
kwargs
要传递给的其他关键字参数 CSV.writer 宾语
可选
即将推出...
``json {
}
记录索引参数大于或等于阈值的年数。 API 参考资料
模型
pywr.core.model
可选
参数
要记录的参数
必填项
名称
录音机的名字
可选
阈值
与参数进行比较的阈值
可选
即将推出...
``json {
}
记录器来总结节点的流量。
可以提供一个系数来调整总流量(例如,用于计算运营成本)。 API 参考资料
模型
名称
录音机的名字
可选
节点
清单 pywr.core.node 要记录的实例
可选
因素
适用于每个节点的因子列表
可选
即将推出...
``json {
}
记录 a 的总值 参数 在模拟过程中。
此记录器可用于跟踪返回值的总和 参数 在模型仿真过程中。可以提供一个可选因子来对值进行线性缩放。如果参数代表通量 整合 关键字参数可用于将值乘以时间步长度(以天为单位)。 API 参考资料
模型
pywr.core.model
可选
参数
要记录的参数
必填项
名称
录音机的名字
可选
因素
值的缩放系数 参数
可选
整合
求和时是否乘以时间步长度(以天为单位)
可选
即将推出...
``json {
}
记录最近 N 个时间步的参数的平均值。 API 参考资料
模型
pywr.core.model
可选
参数
要记录的参数
必填项
名称
录音机的名字
可选
时间的_AGG_func
可选
窗口
可选
即将推出...
``json {
}
使用模型运行中的水力发电方程计算总能量产量。
该记录器可保存模型运行期间每个场景的总能量产量。它不节省时间序列或功率,而是节省总能量。 API 参考资料
涡轮转换
水_仰角_参数
进入涡轮机的水的海拔。此值与 涡轮机_仰角给出涡轮机的工作头
所需的
涡轮机_仰角
涡轮机本身的高度。两者之间的区别 水_仰角和该值给出了涡轮机的工作头
所需的
效率
机的效率
可选
密度
水的密度
可选
流量_单元_
用于将流量单位转换为与此处方程兼容的系数。
_单位转换
可选
即将推出...
``json {
}
这应该将流量转换为单位可选能量
用于转换总能量单位的因子。默认为 1e-6 返回
记录索引参数超过每种场景阈值的次数。
该记录器将计算时间步长,因此在按每日时间步运行时将计为每日计数。 API 参考资料
模型
pywr.core.model
可选
参数
要记录的参数
必填项
阈值
要将参数与之比较的阈值
可选
即将推出...
``json {
}
模型
用于记录节点的模型
可选
h5 文件
用于附加 CarRay 对象的表格文件句柄或文件名。如果给定了文件名,则该对象将打开和关闭文件句柄。
必填项
节点
要保存在 tables 数据库中的节点。可以是 Node 对象或节点名称的可迭代对象。它也可以是元组的可迭代,将特定于节点的 where 关键字作为第一项,节点对象或名称作为第二项。如果提供了可迭代的元组,则优先使用特定于节点的 where 关键字而不是 where 关键字(见下文)
必填项
参数
要保存的参数。与 nodes 关键字类似,唯一的不同是指参数对象或其名称
必填项
哪里
在数据库内创建 CARray 的默认路径
必填项
时间
保存时间表的默认完整节点路径。表。如果没有,则不创建表
可选
场景
保存场景表的默认完整节点路径。表。如果没有,则不创建表
可选
路线_flow
s 相对(相对于哪里)节点路径保存路径流量 carRay。如果没有(默认),则不创建任何数组
可选
路由
保存路由表的完整节点路径。表。如果没有,则不创建表
可选
过滤器_kwds
筛选关键字以传递给 tables.open_打开文件时文件
需要
模式
传递给 tables.open 的模型参数_文件。默认为 'w'
可选
元数据
要保存在根节点上的用户定义属性的字典 (根。_v_attrs)
必填项
创造_
如果给定了文件路径并创建)_目录为 True 然后尝试创建中间目录。这在下面使用 os.makedirs ()
可选