""" Generate SAGE_datasets.docx from data/manifest.json and the per-dataset metadata. Numbers in the document are read from the metadata written by build_release.py, so the document cannot drift out of sync with the released arrays. pip install python-docx python make_docx.py """ from __future__ import annotations import json import os from docx import Document from docx.enum.table import WD_TABLE_ALIGNMENT from docx.enum.text import WD_ALIGN_PARAGRAPH from docx.shared import Pt, RGBColor HERE = os.path.dirname(os.path.abspath(__file__)) ROOT = os.path.dirname(HERE) DATA = os.path.join(ROOT, "data") OUT = os.path.join(ROOT, "SAGE_datasets.docx") # Display order and the prose for each dataset. Keyed by slug. ORDER = ["urban_mobile_communication", "brain_eeg", "power_grid", "urban_rail_transit"] CN_TITLE = { "urban_mobile_communication": "城市移动通信网络（Urban mobile communication network）", "brain_eeg": "脑电网络（Brain EEG network）", "power_grid": "电力网络（Power grid network, IEEE 39-bus）", "urban_rail_transit": "城市轨道交通网络（Urban rail transit network）", } CN_DOMAIN = { "urban_mobile_communication": "人类活动 / 城市通信", "brain_eeg": "神经科学 / 生物网络", "power_grid": "关键基础设施 / 电力系统", "urban_rail_transit": "交通运输 / 城市轨道交通", } CN_VARS = { "urban_mobile_communication": {"x": "互联网活动量", "y": "通话活动量", "z": "短信活动量"}, "brain_eeg": {"x": "希尔伯特解析信号幅值分量", "y": "希尔伯特正交分量"}, "power_grid": {"x": "母线相角（转子角状态）"}, "urban_rail_transit": {"x": "车站进站客流（上车人数）", "y": "车站出站客流（下车人数）"}, } CN_TIMESPAN = { "urban_mobile_communication": "2013 年 11 月 1–7 日", "brain_eeg": "PhysioNet EEGMMIDB 记录 S001R01", "power_grid": "IEEE 39 节点新英格兰测试系统", "urban_rail_transit": "2016 年 2 月 29 日 – 4 月 3 日，每日 05:00–23:00（仅工作日）", } CN_ADJ = { "urban_mobile_communication": "基于米兰 100×100 栅格的四邻域空间邻接", "brain_eeg": "64 通道共激活图，403 条无向边（矩阵中 806 个非零元）", "power_grid": "IEEE 39 节点系统的实际输电线路拓扑", "urban_rail_transit": "车站之间实际轨道连通关系", } # -------------------------------------------------------------------------- # Document helpers # -------------------------------------------------------------------------- def setup_styles(doc: Document) -> None: normal = doc.styles["Normal"] normal.font.name = "Times New Roman" normal.font.size = Pt(10.5) normal.element.rPr.rFonts.set( __import__("docx").oxml.ns.qn("w:eastAsia"), "宋体" ) for level in (1, 2, 3): style = doc.styles[f"Heading {level}"] style.font.name = "Times New Roman" style.font.color.rgb = RGBColor(0, 0, 0) style.element.rPr.rFonts.set( __import__("docx").oxml.ns.qn("w:eastAsia"), "黑体" ) def add_table(doc: Document, header: list[str], rows: list[list[str]]) -> None: table = doc.add_table(rows=1, cols=len(header)) table.style = "Table Grid" table.alignment = WD_TABLE_ALIGNMENT.CENTER for cell, text in zip(table.rows[0].cells, header): cell.text = "" run = cell.paragraphs[0].add_run(text) run.bold = True for row in rows: cells = table.add_row().cells for cell, text in zip(cells, row): cell.text = str(text) doc.add_paragraph() def add_kv_table(doc: Document, pairs: list[tuple[str, str]]) -> None: add_table(doc, ["属性", "值"], [[k, v] for k, v in pairs]) def reflow(text: str) -> str: """Collapse source-code indentation in a prose block from metadata.json.""" return "\n\n".join( para for para in (" ".join(line.strip() for line in chunk.splitlines()).strip() for chunk in text.strip().split("\n\n")) if para ) # -------------------------------------------------------------------------- # Sections # -------------------------------------------------------------------------- def section_overview(doc: Document, metas: list[dict]) -> None: doc.add_heading("一、概述", level=1) doc.add_paragraph( "本文档汇总论文《Discovering hierarchical governing equations for " "community-structured complex network dynamics》（SAGE 框架）中用于评估的四个真实世界" "复杂网络数据集，并给出面向开源发布（Zenodo / GitHub）的统一数据格式规范。" ) doc.add_paragraph( "四个网络来自四个不同领域，均为具有社团结构的复杂网络：网络中的节点动力学可以分解为" "社团层面共享的动力学项与节点个体特有的动力学项。为便于复现与二次使用，四个数据集已" "重新整理为完全一致的文件布局：统一的文件命名、统一的数据排布方向、统一的社团标签编码，" "并附带机器可读的元数据与说明文档。" ) def section_format(doc: Document) -> None: doc.add_heading("二、统一数据格式", level=1) doc.add_heading("2.1 目录结构", level=2) pre = doc.add_paragraph() pre.paragraph_format.left_indent = Pt(18) run = pre.add_run( "dataset_release/\n" "├── README.md 总说明文档\n" "├── SAGE_datasets.docx 本文档\n" "├── data/\n" "│ ├── manifest.json 四个数据集的索引\n" "│ └── / 每个数据集一个目录\n" "│ ├── x.csv [y.csv] [z.csv] 状态量，(T, N)，无表头\n" "│ ├── adj.csv 邻接矩阵，(N, N)，0/1 整数\n" "│ ├── community.csv 社团标签，node,community\n" "│ ├── metadata.json 机器可读元数据\n" "│ └── README.md 该数据集的来源与引用\n" "└── scripts/\n" " ├── load_dataset.py 统一加载器（仅依赖 numpy）\n" " ├── preprocess.py 平滑、求导、数据切分\n" " └── build_release.py 从原始数据重新生成 data/\n" ) run.font.name = "Consolas" run.font.size = Pt(9) doc.add_heading("2.2 文件规范", level=2) doc.add_paragraph( "其中 T 为时间步数，N 为节点数，D 为状态变量维度，K 为社团数。" "所有数据集使用完全相同的文件名与语义：" ) add_table( doc, ["文件", "形状", "说明"], [ ["x.csv, y.csv, z.csv", "(T, N)", "状态量文件，无表头 CSV。每个状态变量一个文件，" "数据集含 2 或 3 个。第 t 行为第 t 个时间步上全部 N 个节点的状态，" "第 i 列为节点 i 的完整时间轨迹。数值为原始观测量，保持来源数据集的单位。"], ["adj.csv", "(N, N)", "邻接矩阵，无表头 CSV，整数 0/1，对角线为 0。" "取值为 1 表示两节点在物理或功能网络上直接相连。"], ["community.csv", "(N, 2)", "含表头 node,community。社团标签为重编号后的连续整数 0…K−1，" "按首次出现顺序编号。"], ["metadata.json", "—", "上述信息的机器可读形式：slug、title、T、N、D、K、" "community_sizes、variables、dt、adjacency、source、citation、state_files。"], ], ) doc.add_heading("2.3 与原始工作副本的差异", level=2) doc.add_paragraph("整理过程中对原始文件做了以下规范化处理：") for item in [ "统一排布方向：城市轨道交通数据集原始文件为 (N, T)（行=站点），已转置为 (T, N)，" "与其余三个数据集一致；转置过程逐值校验，无数值改动。", "统一社团标签：轨道交通数据集原始文件为 8 列 one-hot 编码，已转换为 node,community 两列；" "脑电数据集原始的 8 社团标签已替换为论文所述的 5 社团标签。", "统一邻接矩阵为整数 0/1 表示，去除多余的浮点写法。", "状态量数值逐个 token 从原始文件复制，未做任何精度转换或重新计算，" "因此不引入任何数值误差。", "统一补充 metadata.json 与 README.md，原始文件中缺失。", "本地辅助绘图/中间文件（.opju、.emf、.xlsx、临时 csv 等）未纳入发布包。", ]: doc.add_paragraph(item, style="List Bullet") def section_summary(doc: Document, metas: list[dict]) -> None: doc.add_heading("三、四个数据集汇总", level=1) add_table( doc, ["数据集", "领域", "节点 N", "时间步 T", "变量 D", "社团 K", "时间步长"], [ [ CN_TITLE[m["slug"]].split("（")[0], CN_DOMAIN[m["slug"]], m["N"], m["T"], m["D"], m["K"], m["dt"].split("（")[0].split("(")[0].strip(), ] for m in metas ], ) doc.add_paragraph( "注：表中规模为发布数组的实际规模，与论文正文所引数值的对应关系见第七节。" "两处需要通过预处理才能对上：城市移动通信数据集按原始 10 分钟分辨率发布（1008 步），" "论文中聚合为 60 分钟分辨率（168 步），聚合方式见 scripts/preprocess.py；" "电力网络数据集按论文 Supplementary Section 3.3 的单一状态变量发布（D=1），" "工作副本中的第二个数组是派生量而非观测量。" ) def section_details(doc: Document, metas: list[dict]) -> None: doc.add_heading("四、各数据集详细说明", level=1) for idx, m in enumerate(metas, start=1): slug = m["slug"] doc.add_heading(f"4.{idx} {CN_TITLE[slug]}", level=2) add_kv_table(doc, [ ("标识 slug", slug), ("领域", CN_DOMAIN[slug]), ("节点数 N", str(m["N"])), ("时间步数 T", str(m["T"])), ("状态变量 D", f"{m['D']}（" + "；".join( f"{k} = {v}" for k, v in CN_VARS[slug].items()) + "）"), ("时间步长", m["dt"]), ("社团数 K", f"{m['K']}（规模 " + ", ".join(str(s) for s in m["community_sizes"]) + "）"), ("邻接矩阵构建", CN_ADJ[slug]), ("时间范围", CN_TIMESPAN[slug]), ]) doc.add_paragraph("数据来源与处理：").runs[0].bold = True doc.add_paragraph(reflow(m["source"])) doc.add_paragraph("引用：").runs[0].bold = True doc.add_paragraph(reflow(m["citation"])) def section_preprocess(doc: Document) -> None: doc.add_heading("五、预处理流程", level=1) doc.add_paragraph( "发布包仅包含原始观测量。论文在方程发现前对数据执行的处理由 scripts/preprocess.py " "完整复现，顺序如下：" ) for item in [ "时间聚合（可选）：对相邻若干时间步取均值，用于城市移动通信数据集" "（10 分钟 → 60 分钟，窗口 6）。", "Savitzky–Golay 平滑：沿时间轴做局部多项式回归，在去噪的同时保留高阶矩。" "各数据集窗口与阶数：移动通信/脑电/轨道交通为窗口 7、2 阶，电力为窗口 5、2 阶。", "导数估计：对 Savitzky–Golay 拟合结果求解析一阶导数，避免有限差分的噪声放大。", "数据切分：按时间顺序的 60% / 20% / 20% 分块切分训练、验证、测试集。", ]: doc.add_paragraph(item, style="List Number") doc.add_paragraph( "切分始终沿时间连续进行，不做随机打乱——时间顺序是导数估计成立的前提。" ) def section_license(doc: Document) -> None: doc.add_heading("六、数据来源与许可", level=1) doc.add_paragraph( "四个网络均来源于公开数据，发布包按各来源的条款进行再分发。" "使用任一数据集时，请同时引用该数据集的来源文献与 SAGE 论文。" ) add_table( doc, ["数据集", "来源", "许可条款"], [ ["urban_mobile_communication", "Telecom Italia Big Data Challenge（哈佛 Dataverse）", "开放数据，需署名（Barlacchi et al., Sci. Data 2, 150055, 2015）"], ["brain_eeg", "PhysioNet EEGMMIDB，记录 S001R01", "Open Data Commons Attribution License v1.0"], ["power_grid", "IEEE 39-bus New England 测试系统", "公开测试系统数据"], ["urban_rail_transit", "北京轨道交通 AFC 客流数据", "科研用途；需引用 Zhang et al., IEEE T-ITS 22, 7004–7014, 2021"], ], ) def section_consistency(doc: Document) -> None: doc.add_heading("七、与论文的一致性核对", level=1) doc.add_paragraph( "已将发布数组与《英文正文v16》及《Supplementary Information》中关于四个数据集的" "全部数值性陈述逐条比对，结果如下。" ) add_table( doc, ["核对项", "论文表述", "发布数组", "结论"], [ ["数据集个数与名称", "urban mobile communication / brain EEG / IEEE 39-bus " "power grid / Beijing urban rail transit", "四个数据集一一对应", "一致"], ["节点数 N", "48 / 64 / 39 / 276", "48 / 64 / 39 / 276", "一致"], ["状态变量 D", "移动通信 3；脑电 2；轨道交通 2；电力 1", "3 / 2 / 2 / 1", "一致（电力已修正，见下）"], ["社团数 K", "脑电 5；电力 3；其余未给出", "12 / 5 / 3 / 8", "已给出者一致"], ["时间步 T（脑电）", "2,440", "2,440", "一致"], ["时间步 T（移动通信）", "168（聚合后）", "1008（原始 10 分钟）", "一致，聚合系数 6；论文未写明原始分辨率"], ["时间步 T（电力 / 轨道交通）", "论文未给出", "5000 / 1800", "论文缺此信息"], ["轨道交通时间分辨率", "15 分钟", "15 分钟", "一致"], ["轨道交通线路与车站", "17 条线路、276 座车站", "276 节点", "一致"], ["脑电预处理", "1–20 Hz 带通、CAR、Hilbert 解析信号两分量", "x = 幅值分量，y = 正交分量", "一致（corr(x,y) ≈ 0，正交性成立）"], ["移动通信邻接", "栅格四邻域空间邻接", "48×48 四邻域", "一致"], ["数据存放方式", "已存放于 Zenodo（DOI 待补）", "本地发布包", "待上传，需同步更新正文"], ], ) doc.add_heading("7.1 已修正的问题", level=2) doc.add_paragraph( "电力网络的状态变量个数。Supplementary Section 3.3 称每母线仅有单一状态变量，" "但工作副本中同时存在 x.csv 与 y.csv，此前按两个状态变量处理。经数值核验：" ) doc.add_paragraph( "y 与 np.gradient(x, axis=0) / 0.01 的最大相对残差为 4.7×10⁻⁸，" "即恰好等于 float32 精度；而前向差分的相对残差为 1.38，完全不符。", style="List Bullet", ) doc.add_paragraph( "因此 y 并非独立观测量，而是由 x 中心差分得到的派生量。发布包已改为只提供 x，" "与 Supplementary Section 3.3 的单一状态变量表述一致；" "正文中「角度–角速度关系」是所发现方程内部的项，而非对输入数据的描述。" "工作副本中的 y 可用上述一行代码精确复现。", style="List Bullet", ) doc.add_heading("7.2 已澄清的问题", level=2) doc.add_paragraph( "城市轨道交通数据集的时间跨度。正文称连续五周、每日 18 小时（05:00–23:00），" "即 35 天；数组为 1800 个 15 分钟时间步。该数值可由工作日精确解释：" ) doc.add_paragraph( "2016-02-29 为星期一，2016-04-03 为星期日，该区间共有 25 个工作日；" "25（工作日）× 18（小时）× 4（次/小时）= 1800。", style="List Bullet", ) doc.add_paragraph( "同时，25 天逐日客流剖面高度一致（两两相关系数 0.99 以上），" "不存在周末客流量级差异，佐证数组不含周末。" "建议正文将「five consecutive weeks」改为「weekdays over five consecutive weeks」。", style="List Bullet", ) doc.add_heading("7.3 仍需处理", level=2) for item in [ "Supplementary Section 3.4 的表述建议为「weekdays over five consecutive weeks」，" "以与该数据集实际只含工作日这一事实一致。", "Supplementary Section 3.1 引用的 168 步是 60 分钟聚合后的结果，" "论文未说明原始分辨率为 10 分钟（1008 步）。建议补充原始分辨率与聚合方式。", "Supplementary Section 3 中每一小节结尾均写有「The detailed network configuration " "and system parameters are reported below.」，但该节及其后并无对应参数表。" "建议补齐参数表，或删去该句。", "移动通信与轨道交通的社团数（12 与 8）、电力网络与轨道交通的时间步数" "（5000 与 1800）论文均未给出，建议在补充参数表中一并列出。", "脑电数据集的社团划分在工作副本中有 8 社团与 5 社团两个版本。" "发布包采用论文 Supplementary Section 3.2 所述的 5 社团版本，" "建议确认 8 社团版本仅为中间产物。", "正文数据可用性声明称数据已存放于 Zenodo，DOI 待填；" "上传后需同步更新正文与 SI 的链接。", ]: doc.add_paragraph(item, style="List Number") # -------------------------------------------------------------------------- def main() -> int: with open(os.path.join(DATA, "manifest.json"), encoding="utf-8") as fh: manifest = json.load(fh) by_slug = {m["slug"]: m for m in manifest["datasets"]} metas = [] for slug in ORDER: with open(os.path.join(DATA, slug, "metadata.json"), encoding="utf-8") as fh: metas.append(json.load(fh)) assert set(by_slug) == set(ORDER), "manifest and ORDER disagree" doc = Document() setup_styles(doc) title = doc.add_heading("SAGE 真实世界复杂网络数据集说明", level=0) title.alignment = WD_ALIGN_PARAGRAPH.CENTER sub = doc.add_paragraph( "四个真实世界社团结构复杂网络的统一数据格式与数据集描述" ) sub.alignment = WD_ALIGN_PARAGRAPH.CENTER sub.runs[0].italic = True section_overview(doc, metas) section_format(doc) section_summary(doc, metas) section_details(doc, metas) section_preprocess(doc) section_license(doc) section_consistency(doc) doc.save(OUT) print(f"wrote {OUT}") return 0 if __name__ == "__main__": raise SystemExit(main())