PySWMM 开源项目安装与使用指南

PySWMM 是一个基于Python语言的软件包，专为创建、操作以及研究复杂网络的结构、动力学和功能而设计。本指南旨在帮助您了解并快速上手这个用于管理美国环保署（EPA）Stormwater Management Model (SWMM) 的强大工具。

1. 项目目录结构及介绍

PySWMM 的仓库遵循典型的Python项目布局，主要结构如下：

• docs: 包含项目的文档源文件，如教程、API参考等。
• pyswmm: 核心代码库，这里封装了所有与SWMM交互的模块和函数。
  • 例如，nodes.py, links.py 等文件分别处理节点和链接相关的操作。
• .gitattributes, .git-blame-ignore-revs: Git配置文件，用于控制版本控制行为。
• AUTHORS, CHANGELOG.md, CITATION.cff, LICENSE.txt: 作者信息、更新日志、引用格式和许可协议。
• setup.py: 安装脚本，定义项目依赖和元数据，以便通过pip安装。
• requirements-dev.txt, requirements.txt: 分别列出开发和运行所需的第三方库列表。
• README.md: 项目简介，包含快速入门指导。

2. 项目的启动文件介绍

在PySWMM中，并没有一个特定的“启动文件”，但有一个推荐的开始使用流程。通常，开发者或用户会从导入PySWMM库并在自己的脚本中调用其函数开始。以下是一个简单的示例启动流程：

from pyswmm import Simulation, Nodes, Links

with Simulation('path/to/your/model.inp') as sim:
    node21 = Nodes(sim)["21"]
    print(f"Invert Elevation: {node21.invert_elevation}")
    link15 = Links(sim)['15']
    print(f"Outlet Node ID: {link15.outlet_node}")

    for step in sim:
        if step % 100 == 0:
            print(f"{sim.current_time} {sim.percent_complete:.2f}%"
                  f" Depth: {node21.depth}, Flow: {link15.flow}")

您的实际启动文件将是执行类似上述逻辑的Python脚本，确保替换 'path/to/your/model.inp' 为您的SWMM模型输入文件路径。

3. 项目的配置文件介绍

PySWMM本身不直接提供一个特定的配置文件模板，而是通过SWMM的.inp输入文件来配置模型。.inp文件是SWMM模型的核心配置，它包含了模拟区域的所有设定，包括子流域、节点、链接、时间步长、报告设置等。

SWMM 输入文件 (.inp) 结构简述：

• Project Info: 模型的基本信息，如名称、单位系统。
• Subcatchments: 定义每个汇水区的属性。
• Nodes: 描述下水道系统中的节点（如贮流井、溢流口）及其特性。
• Links: 定义连接不同节点的管道和其他连接件。
• Pumps / Orifices / Weirs: 特殊连接件如泵、孔口、堰的详细参数。
• Pollutants: 如果模型考虑污染，则定义污染物信息。
• Hydraulics / Hydrology: 控制模拟的水力学和水文参数。
• Options: 包括模拟选项和输出报告设置。
• Report: 输出报告的细节设置。
• Controls: 控制规则，描述在模拟过程中的动态调整。

要使用PySWMM，您需要准备或编辑这样的.inp文件，然后在Python脚本中指定该文件路径以启动模拟。

---

以上就是PySWMM项目的简单介绍，包括目录结构、启动基本流程，以及SWMM模型特有的配置文件.inp的简述。通过遵循这些指导，您可以迅速开始利用PySWMM进行高效的水力模型分析和仿真。