皮西姆德姆

pysimdeum是一个 Python 包，用于在最终使用级别对住宅随机用水需求进行建模和模拟。

主要功能：

• 根据特定国家的统计数据建造和安装用户和最终用水设备的房屋
• 根据统计数据随机模拟用水量
• 结果存储为xarray.DataArray，因此所有模拟信息都可以在之后访问和汇总（例如，特定的最终用途、用户的用水量总和、随时间推移的滚动平均值……）
• 序列化：pysimdeum 支持不同的输出格式（例如，csv、excel、netcdf、...）
• 使用 matplotlib 绘制结果

详细的文档很快就会在https://pysimdeum.readthedocs.io下提供。

警告！

请注意，这种pysimdeum 情况仍在发生很大变化。在它被标记为 1.0.0 之前，您应该假设它是不稳定的并采取相应的行动。我们正在努力避免重大更改，但它们可以而且将会发生！

安装

pysimdeum 使用仅在较新的 Python 版本中可用的功能，这就是为什么需要 Python >= 3.8 以及几个 Python 包依赖项的原因。

pysimdeum 在 PyPI 上可用，并且可以使用以下命令轻松安装它的依赖项pip：

pip install pysimdeum

或者，您可以pysimdeum 从其存储库安装：

pip install git+https://github.com/KWR-Water/pysimdeum.git

依赖项

pysimdeum 需要以下 Python 包：

• matplotlib
• 麻木的
• 熊猫
• 通俗易懂
• 数组
• scipy

基本用法

要使用pysimdeum，您首先必须在脚本中导入它：

import pysimdeum

在pysimdeum，一切都是关于House。如果您想从一个新的空房子开始，请输入以下内容：

house = pySIMDEUM.built_house(house_type='one_person')

如果你想建造一个特定的房子，例如一个人的家庭，你可以使用house_type关键字：

# Built a house (one-person household)
house = pySIMDEUM.built_house(house_type='one_person')

房子自动由人居住，这些人遵循一定的统计数据，并“配备”了最终用水设备或器具（例如，马桶、浴缸……）。您可以使用房屋的appliances或财产检查哪些电器可用：users

# Show users and water end-use devices present in the house
print(house.users)
print(house.appliances)

要模拟房屋的用水量，可以使用 House 的simulate方法：

# Simulate water consumption for house (xarray.DataArray)
consumption = house.simulate(num_patterns=100)

模拟结果是一个xarray.DataArray——基本上是一个numpy.ndarray用四个维度/轴（即时间、用户、最终用途、模式）标记的。

您可以轻松地创建消费对象的统计数据，例如，计算平均总消费量（所有用户和最终用户的消费总和作为模式的平均值），您可以构建轴user和enduse轴的总和（总消费量） ，然后在patterns轴上建立平均值

# Build statistics from consumption
tot_cons = consumption.sum(['enduse', 'user']).mean([ 'patterns'])

如果您想绘制结果并另外描绘一些滚动平均值（例如，每小时平均值 = 3600 秒），您可以通过以下方式

# Plot total consumption
tot_cons.plot()
tot_cons.rolling(time=3600, center=True).mean().plot()
plt.show()

执照

pysimdeum可在EUPL-1.2 许可下使用。

贡献

如果您想投稿，请查看我们的行为准则和投稿指南。期待您的拉取请求或问题！

引用

如果您基于 发表作品pysimdeum，我们感谢您引用以下参考资料：

• Steffelbauer, DB, Hillebrand B., Blokker, EJM, 2022. pySIMDEUM：Python 中的开源随机用水需求最终用途模型。2022 年 7 月 18 日至 22 日在瓦伦西亚（西班牙）举行的第二届供水行业联合配水系统分析、计算和控制 (WDSA/CCWI2022) 会议论文集。