init

README.md

@@ -1,56 +1,232 @@
 ---
 license: bsd-3-clause
 task_categories:
-- reinforcement-learning
+- other
+language:
+- en
 tags:
+- mixed-integer-programming
 - power-systems
 - optimization
 - unit-commitment
-- mixed-integer-programming
+- mps
+- benchmark
+size_categories:
+- 100<n<1K
+---
+
+
+# 机组组合 MIP 基准数据集（UCTD）
+
+本文档说明如何从零开始，使用本仓库提供的工具链，生成一份用于**混合整数规划（MIP）**研究的标准基准数据集。
+
 ---
 
-# Unit Commitment Trajectory Dataset (UCTD)
+## 一、整体目录结构
+
+本仓库（`UnitCommitment_Trajectory`）包含两个顶层子文件夹：
+
+```
+UnitCommitment_Trajectory/
+├── UnitCommitment_Trajectory_Test/    ← 代码与算例（运行脚本的工作目录）
+└── UnitCommitment_Trajectory_Dataset/ ← 数据集输出目录（脚本自动生成）
+```
+
+---
+
+## 二、代码目录详细说明（`UnitCommitment_Trajectory_Test/`）
+
+### 2.1 顶层文件
+
+| 文件名 | 作用 |
+| :--- | :--- |
+| `generate_dataset.jl` | **核心脚本**。批量读取所有算例，构建 MIP 模型，导出 `.mps` 文件到数据集目录。 |
+| `create_scuc_mps_files.jl` | 单算例调试脚本。用于手动测试单个算例的 MPS 生成流程，不用于批量生产。 |
+| `test_main.jl` | 模型对比实验脚本。对比基础模型、v1（添加启停轨迹）和 v2（修改最小运行时间）三种配置的求解结果，生成 CSV 报表。 |
+| `pmax-preprocessing.jl` | 预处理函数库。被 `test_main.jl` 调用，实现以下两步逻辑：①按容量（Pmax）筛选机组并写入启停曲线（Part 1）；②修改前 20% 大机组的最小运行时间（Part 2）。 |
+| `Project.toml` | Julia 包管理配置文件。声明了本项目依赖的所有第三方包及版本约束（JuMP、HiGHS、CodecZlib 等）。 |
+| `Manifest.toml` | Julia 依赖锁定文件。精确记录了每个依赖包的版本和哈希值，确保不同机器上的环境完全一致。**请勿手动修改此文件。** |
 
-## 1. Overview
+### 2.2 `src/` — UnitCommitment.jl 核心源代码
 
-This dataset is generated using a customized version of the `UnitCommitment.jl` framework, specifically designed for **Machine Learning for Optimization (ML4Opt)** research. It provides Unit Commitment (SCUC) optimization problems ranging from small IEEE test systems to large-scale national grids.
+这是对原版 `UnitCommitment.jl` 进行定制修改后的源代码目录。
 
-**Core Innovation**: Unlike standard datasets, UCTD incorporates **Power Trajectories** for generator startup and shutdown. This provides a high-fidelity physical representation of power system operations, making it a challenging benchmark for modern optimization solvers and ML models.
+| 子目录 | 作用 |
+| :--- | :--- |
+| `src/instance/` | 数据读取模块。负责将 `.json.gz` 格式的算例文件解析为 Julia 内部的数据结构（`UnitCommitmentInstance`）。 |
+| `src/model/` | 模型构建模块。`build.jl` 是入口，根据传入的 `Formulation` 参数调用各子模块，在内存中构建 JuMP 数学模型。 |
+| `src/model/formulations/base/` | 基础公式化组件。包含线路约束（`line.jl`）、机组约束（`unit.jl`）等标准模块。 |
+| `src/model/formulations/xxx2005/` | **本项目新增的核心模块**。实现了发电机启停功率轨迹（Power Trajectories）约束。该约束用曲线精确建模机组在启动和停机阶段逐时段的输出功率，是本数据集区别于普通 UC 数据集的关键特性。 |
+| `src/transform/` | 数据变换模块。包含 `convert_to_subhourly` 函数，负责将 1 小时分辨率（24 时段）的算例转换为 15 分钟分辨率（96 时段）。 |
 
-## 2. Case Statistics
+### 2.3 `instances/` — 原始输入算例
 
-The dataset contains **464** `.mps` files across three grid models:
+```
+instances/
+└── matpower/
+    ├── case14/    ← IEEE 14 节点测试系统，含 67 个日期的算例文件
+    └── case30/    ← IEEE 30 节点测试系统，含 45 个日期的算例文件
+```
 
-- **Case14**: Basic test system (14-bus, 67 days).
-- **Case30**: Medium-scale system (30-bus, 45 days).
-- **Case2383wp (Challenge Set)**: Large-scale Polish national grid (2383-bus), used for testing scalability.
+每个文件夹下存放以日期命名的 `.json.gz` 压缩文件（例如 `2017-01-01.json.gz`），每个文件描述了当日的负荷曲线、机组参数和电网拓扑。
 
-## 3. Model Variants
+### 2.4 `testdata/` — 大型算例
 
-For each day, 4 modeling variants are provided:
+```
+testdata/
+└── case2383wp/    ← 波兰国家电网模型（2383 节点，323 台发电机），含 4 个日期的算例文件
+```
 
-1. `hourly_noline`: 1-hour resolution, unit constraints only.
-2. `hourly_withline`: 1-hour resolution, including full network constraints (SCUC).
-3. `subhourly_noline`: 15-minute resolution, unit constraints only.
-4. `subhourly_withline`: 15-minute resolution, including full network constraints (SCUC).
+该算例规模接近实际电网，生成的 MPS 文件体积较大（单文件可超过 50MB），用于测试 MIP 求解器的可扩展性。
 
-## 4. File Naming Convention
+### 2.5 `test/` — 实验输出目录
 
-Format: `{case}_{date}_{granularity}_{variant}.mps`
-Example: `case30_2017-01-01_s_withline.mps` (Case30, Sub-hourly, with network constraints).
+运行 `test_main.jl` 后生成，存放对比实验的中间 JSON 文件和最终的 CSV 报表。**与数据集生成无关。**
+
+---
+
+## 三、数据集目录详细说明（`UnitCommitment_Trajectory_Dataset/`）
+
+运行生成脚本后，该目录结构如下：
+
+```
+UnitCommitment_Trajectory_Dataset/
+├── case14/
+│   ├── hourly_noline/       ← case14 的 MPS 文件，1小时粒度，无网络约束
+│   ├── hourly_withline/     ← case14 的 MPS 文件，1小时粒度，含 SCUC 网络约束
+│   ├── subhourly_noline/    ← case14 的 MPS 文件，15分钟粒度，无网络约束
+│   └── subhourly_withline/  ← case14 的 MPS 文件，15分钟粒度，含 SCUC 网络约束
+├── case30/
+│   └── ...（结构同上）
+└── case2383wp/
+    └── ...（结构同上）
+```
+
+### 3.1 四种变体的 MIP 特性对比
+
+| 变体文件夹 | 时段数 | 网络约束 | MIP 变量规模 | 典型用途 |
+| :--- | :---: | :---: | :--- | :--- |
+| `hourly_noline` | 24 | ✗ | 最小。仅含机组开关（二进制）和出力（连续）变量。 | 入门级 MIP 测试，算法原型验证。 |
+| `hourly_withline` | 24 | ✓ | 中等。在 `noline` 基础上增加大量潮流不等式约束（DCOPF）。 | 标准 SCUC 基准，适合测试割平面效果。 |
+| `subhourly_noline` | 96 | ✗ | 较大。变量数量是 hourly 版本的 4 倍。 | 测试求解器处理高维 MIP 的收敛性能。 |
+| `subhourly_withline` | 96 | ✓ | 最大。同时具备高维变量和密集约束矩阵。 | 最接近现实调度的高难度 MIP 命题。 |
+
+### 3.2 文件命名规则
+
+每个 `.mps` 文件的命名格式为：
+
+```
+{算例名}_{日期}_{粒度}_{变体}.mps
+```
+
+示例解析：
+
+```
+case30_2017-01-01_s_withline.mps
+│      │           │ └── withline：包含网络约束 / noline：无网络约束
+│      │           └── s：subhourly（15分钟）/ h：hourly（1小时）
+│      └── 该条 MPS 对应的负荷场景日期
+└── 电网算例名称
+```
+
+---
 
-## 5. Key Features
+## 四、从零复现数据集的完整步骤
 
-- **High-Fidelity Physics**: Includes power output trajectories during generator startup/shutdown phases.
-- **Multiple Resolutions**: Covers both traditional 1-hour scheduling and modern 15-minute sub-hourly scheduling.
-- **Standardized Format**: Uses the industry-standard `.mps` format, compatible with Gurobi, CPLEX, HiGHS, and more.
+### 步骤 1：安装 Julia
 
-## 6. Use Cases
+从 [https://julialang.org/downloads/](https://julialang.org/downloads/) 下载并安装 Julia，建议版本 **v1.10 或更高**。
+
+安装完成后，在命令行执行 `julia --version`，确认输出版本号即表示安装成功。
+
+### 步骤 2：克隆或下载本仓库
+
+确保本地磁盘上存在以下两个文件夹（目录结构必须与此一致）：
+
+```
+E:\Project\UnitCommitment_Trajectory\
+├── UnitCommitment_Trajectory_Test\     ← 包含 generate_dataset.jl 和 src/ 等
+└── UnitCommitment_Trajectory_Dataset\  ← 可以是空文件夹，脚本会自动创建子目录
+```
+
+> **注意**：`UnitCommitment_Trajectory_Dataset` 文件夹必须与 `UnitCommitment_Trajectory_Test` 处于**同一层级**，否则脚本中的相对路径 `../UnitCommitment_Trajectory_Dataset` 将无法找到输出目录。
+
+### 步骤 3：初始化 Julia 环境（仅需执行一次）
+
+打开 PowerShell，进入代码目录，执行以下命令自动安装所有依赖：
+
+```powershell
+cd E:\Project\UnitCommitment_Trajectory\UnitCommitment_Trajectory_Test
+
+julia --project=. -e "using Pkg; Pkg.instantiate()"
+```
+
+该命令会读取 `Project.toml` 和 `Manifest.toml`，自动下载并安装所有指定版本的依赖包（JuMP、HiGHS、CodecZlib 等）。
+
+> **常见问题**：若网络较慢或出现 SSL 错误，可尝试设置国内镜像后再执行：
+> ```powershell
+> $env:JULIA_PKG_SERVER = "https://mirrors.tuna.tsinghua.edu.cn/julia"
+> julia --project=. -e "using Pkg; Pkg.instantiate()"
+> ```
+
+### 步骤 4：运行数据集生成脚本
+
+在同一目录下执行：
+
+```powershell
+julia --project=. generate_dataset.jl
+```
+
+脚本将依次处理 `case14`（67 个文件）、`case30`（45 个文件）和 `case2383wp`（4 个文件），每个算例生成 4 种变体共 **464 个 `.mps` 文件**。
+
+终端输出示例：
+```
+🚀 开始全量数据集生成任务 (包含大型算例)...
+
+>>> 正在准备算例: case14
+    [case14] 处理进度: 1/67 (2017-01-01)
+    [case14] 处理进度: 2/67 (2017-01-02)
+    ...
+✅ 所有算例生成完毕！
+```
+
+> **预计耗时**���普通电脑约 10–20 分钟（case2383wp 的大型算例每个文件需较长时间）。
+>
+> **内存要求**：建议至少 8GB 可用内存，生成 case2383wp 的 Subhourly 版本时内存占用峰值约为 4GB。
+
+### 步骤 5：验证生成结果
+
+生成完成后，检查 `UnitCommitment_Trajectory_Dataset/` 下是否存在如下结构，且每个变体文件夹内包含对应数量的 `.mps` 文件：
+
+| 文件夹路径 | 预期文件数 |
+| :--- | :---: |
+| `case14/hourly_noline/` | 67 |
+| `case14/hourly_withline/` | 67 |
+| `case14/subhourly_noline/` | 67 |
+| `case14/subhourly_withline/` | 67 |
+| `case30/hourly_noline/` | 45 |
+| `case30/hourly_withline/` | 45 |
+| `case30/subhourly_noline/` | 45 |
+| `case30/subhourly_withline/` | 45 |
+| `case2383wp/hourly_noline/` | 4 |
+| `case2383wp/hourly_withline/` | 4 |
+| `case2383wp/subhourly_noline/` | 4 |
+| `case2383wp/subhourly_withline/` | 4 |
+| **合计** | **464** |
+
+---
+
+## 五、数据集技术规格
+
+- **格式**：标准 MPS（Mathematical Programming System），兼容 Gurobi、CPLEX、HiGHS、SCIP 等所有主流求解器。
+- **变量命名**：已启用 `variable_names=true`，MPS 文件中的变量使用语义化名称（如 `is_on[generator_name, t]`、`prod_above[s1, generator_name, t]`），而非 `x1, x2` 等匿名编号。
+- **启停轨迹**：所有模型均包含本项目定制的发电机启停功率轨迹约束（`xxx2005` 模块），相比标准 UC 公式，MIP 的可行域更精确，对求解器分支策略的要求更高。
+
+---
 
-- **Supervised Learning**: Predict optimal commitment status or production levels.
-- **End-to-End Optimization**: Train Graph Neural Networks (GNN) to map problem instances directly to solutions.
-- **Solver Benchmarking**: Test the performance and scalability of modern MIP solvers on large-scale power grid problems.
+## 六、引用
 
-## 7. Citation
+本数据集基于以下项目生成，如在研究中使用，请引用原始论文：
 
-If you use this dataset in your research, please cite the original `UnitCommitment.jl` paper and acknowledge the source of this trajectory-enhanced version.
+- **UnitCommitment.jl** — Alinson S. Xavier et al., Argonne National Laboratory  
+  DOI: [10.5281/zenodo.4269874](https://doi.org/10.5281/zenodo.4269874)

README_CN.md

@@ -1,56 +0,0 @@
----
-license: bsd-3-clause
-task_categories:
-- reinforcement-learning
-tags:
-- power-systems
-- optimization
-- unit-commitment
-- mixed-integer-programming
----
-
-# 启停轨迹增强版机组组合数据集 (UCTD)
-
-## 1. 简介
-
-本数据集是基于修改版的 `UnitCommitment.jl` 框架生成的，专门用于**机器学习辅助数学优化 (ML4Opt)** 的研究。它包含了 IEEE 14 节点、IEEE 30 节点以及波兰国家电网 (2383 节点) 的机组组合 (SCUC) 优化命题。
-
-**核心特色**：本数据集集成了**发电机启停功率轨迹 (Power Trajectories)**。相比于传统模型，该约束能更真实地模拟发电机在启动和停机阶段的物理行为，是目前电力系统优化领域较为精细且硬核的数据集。
-
-## 2. 算例说明
-
-数据集共包含 **464** 个 `.mps` 文件，涵盖了从教学级到国家级规模的多种场景：
-
-- **Case14**: 基础教学级算例 (14 节点)，包含 67 天的负荷数据。
-- **Case30**: 中等规模算例 (30 节点)，包含 45 天的负荷数据。
-- **Case2383wp (挑战者集)**: 实际波兰电网规模 (2383 节点)，用于测试算法的可扩展性。
-
-## 3. 数据变体 (Variants)
-
-每个日期的数据都提供了 4 种建模变体：
-
-1. `hourly_noline`: 每小时粒度，仅包含机组物理约束。
-2. `hourly_withline`: 每小时粒度，包含全网潮流网络约束 (SCUC)。
-3. `subhourly_noline`: 15 分钟高频采样粒度，不含网络约束。
-4. `subhourly_withline`: 15 分钟高频采样粒度，包含全网网络约束。
-
-## 4. 文件命名规范
-
-格式：`{算例名}_{日期}_{粒度}_{变体}.mps`
-例如：`case30_2017-01-01_s_withline.mps` 代表 Case30 算例、15分钟粒度、含线路约束。
-
-## 5. 关键特性
-
-- **精细化物理约束**：包含发电机在启动和关闭过程中的功率出力轨迹。
-- **多时间粒度**：涵盖了传统的小时级调度和现代的 15 分钟级子小时调度。
-- **标准化格式**：采用工业界通用的 `.mps` 格式，支持 Gurobi, CPLEX, HiGHS 等所有主流求解器。
-
-## 6. 使用场景
-
-- **监督学习**：预测最优启停状态或发电出力水平。
-- **端到端优化**：训练图神经网络 (GNN) 将问题实例直接映射为解。
-- **求解器基准测试**：测试现代 MIP 求解器在大规模电网问题上的性能和可扩展性。
-
-## 7. 引用
-
-如果您在研究中使用了本数据集，请引用 `UnitCommitment.jl` 的原始论文，并注明本轨迹增强版数据集的来源。