Update README.md

README.md

@@ -1,3 +1,200 @@
 ---
-license: bsd-3-clause-clear
+license: bsd-3-clause
+task_categories:
+- other
+language:
+- en
+tags:
+- mixed-integer-programming
+- power-systems
+- optimization
+- unit-commitment
+- mps
+- benchmark
+size_categories:
+- 10K<n<100K
+
 ---
+
+# UnitCommitment Trajectory MPS 数据集
+
+本仓库用于从 UnitCommitment.jl 的 Matpower 机组组合（UC）实例生成标准 `.mps` 文件，供混合整数规划（MIP）、机组组合（UC）及安全约束机组组合（SCUC）模型求解器测试与基准研究使用。
+
+仓库地址：[EridanusQ/UnitCommitment_Trajectory · Datasets at Hugging Face](https://huggingface.co/datasets/EridanusQ/UnitCommitment_Trajectory)
+
+## 1. 数据规模
+
+`UnitCommitment_Trajectory_Test/instances/matpower` 下共有 **26** 个 Matpower case，**9487** 个 `.json.gz` 输入实例。每个实例生成 4 个 `.mps`，全量输出预计 **37948** 个文件。
+
+| Case            | 输入实例数 |
+| :-------------- | ---------: |
+| case118         |        365 |
+| case1354pegase  |        365 |
+| case13659pegase |        365 |
+| case14          |        365 |
+| case1888rte     |        365 |
+| case1951rte     |        365 |
+| case2383wp      |        365 |
+| case2736sp      |        365 |
+| case2737sop     |        365 |
+| case2746wop     |        365 |
+| case2746wp      |        365 |
+| case2848rte     |        365 |
+| case2868rte     |        365 |
+| case2869pegase  |        365 |
+| case30          |        365 |
+| case300         |        365 |
+| case3012wp      |        365 |
+| case3120sp      |        365 |
+| case3375wp      |        365 |
+| case57          |        362 |
+| case6468rte     |        365 |
+| case6470rte     |        365 |
+| case6495rte     |        365 |
+| case6515rte     |        365 |
+| case89pegase    |        365 |
+| case9241pegase  |        365 |
+
+## 2. 目录结构
+
+```text
+UnitCommitment_Trajectory/
+├── README.md
+├── UnitCommitment_Trajectory_Test/
+│   ├── Project.toml
+│   ├── Manifest.toml
+│   ├── generate_dataset.jl          # 批量生成 MPS 主脚本
+│   ├── create_scuc_mps_files.jl     # 单算例调试脚本
+│   ├── instances/
+│   │   └── matpower/                # 原始 .json.gz 输入实例
+│   ├── benchmark/
+│   │   └── scripts/
+│   │       └── download_matpower_instances.py
+│   ├── src/                         # 修改版 UnitCommitment.jl 源码
+│   └── ...
+└── UnitCommitment_Trajectory_Dataset/  # 输出的 .mps 文件目录
+```
+
+> 后文所有命令均在 `UnitCommitment_Trajectory_Test` 目录下执行，路径均相对于该目录。
+
+## 3. 环境准备
+
+- **Julia**：建议 1.12 系列。
+- **Python 3**：仅用于下载脚本，无需额外依赖。
+
+```powershell
+cd UnitCommitment_Trajectory\UnitCommitment_Trajectory_Test
+julia --project=. -e "using Pkg; Pkg.instantiate()"
+```
+
+## 4. 下载原始 Matpower 输入数据
+
+下载脚本 `benchmark\scripts\download_matpower_instances.py` 从 `https://axavier.org/UnitCommitment.jl/0.4/instances` 获取数据，默认日期范围 `2017-01-01` 至 `2017-12-31`，保存到 `instances/matpower`，已存在且非空的文件会自动跳过。
+
+```powershell
+# 下载全年数据（最常用）
+python benchmark\scripts\download_matpower_instances.py
+
+# 查看支持的 case 列表
+python benchmark\scripts\download_matpower_instances.py --list-cases
+
+# 指定日期范围（示例）
+python benchmark\scripts\download_matpower_instances.py --start-date 2017-01-01 --end-date 2017-01-31
+```
+
+快速检查下载结果：
+
+```powershell
+Get-ChildItem instances\matpower -Recurse -Filter *.json.gz | Measure-Object
+```
+
+## 5. MPS 输出结构
+
+`generate_dataset.jl` 将结果输出到 `../UnitCommitment_Trajectory_Dataset`（即仓库根目录下的数据集目录）。每个 case 下生成四个变体子目录：
+
+```text
+case_name/
+├── hourly_noline/      # 小时级 UC，无线路约束
+├── hourly_withline/    # 小时级 SCUC，含线路约束
+├── subhourly_noline/   # 子小时 UC，无线路约束
+└── subhourly_withline/ # 子小时 SCUC，含线路约束
+```
+
+文件命名规则：`{case}_{date}_{resolution}_{network}.mps`  
+例如：`case30_2017-01-01_h_noline.mps`（`h` = hourly，`s` = subhourly）。
+
+## 6. 单算例测试
+
+用于验证环境与建模流程是否正常：
+
+```powershell
+julia --project=. create_scuc_mps_files.jl
+```
+
+成功后会在当前目录生成四个测试文件：`uc_default_noline.mps` 等。
+
+## 7. 全量生成 MPS 数据集
+
+### 7.1 基本用法
+
+确认输入数据就绪后，直接运行：
+
+```powershell
+julia --project=. generate_dataset.jl
+```
+
+脚本会自动扫描 `instances/matpower` 下所有包含 `.json.gz` 的 case。**全量生成非常耗时且占用大量磁盘空间**，大规模 case（如 `case13659pegase`、`case9241pegase`）尤为突出。
+
+### 7.2 只生成指定 Case
+
+```powershell
+$env:UC_CASES = "case3375wp,case9241pegase,c6515rte"
+julia --project=. generate_dataset.jl
+Remove-Item Env:\UC_CASES
+```
+
+单 case 同理：`$env:UC_CASES = "case118"`。干跑与指定 case 可组合使用。
+
+## 8. 检查 MPS 输出结果
+
+在 `UnitCommitment_Trajectory_Test` 目录下执行：
+
+```powershell
+# 文件总数
+Get-ChildItem ..\UnitCommitment_Trajectory_Dataset -Recurse -Filter *.mps | Measure-Object
+```
+
+## 9. 完整复现流程
+
+```powershell
+cd UnitCommitment_Trajectory\UnitCommitment_Trajectory_Test
+
+# 1. 初始化 Julia 环境
+julia --project=. -e "using Pkg; Pkg.instantiate()"
+
+# 2. 下载 Matpower 实例
+python benchmark\scripts\download_matpower_instances.py
+
+# 3. 检查下载数量
+Get-ChildItem instances\matpower -Recurse -Filter *.json.gz | Measure-Object
+
+# 4. 全量生成 MPS
+julia --project=. generate_dataset.jl
+
+# 5. 检查最终 MPS 文件数
+Get-ChildItem ..\UnitCommitment_Trajectory_Dataset -Recurse -Filter *.mps | Measure-Object
+```
+
+## 10. 轨迹约束与预处理说明
+
+本仓库基于修改版 UnitCommitment.jl，增加了启停轨迹约束与实例预处理逻辑。相关代码位于：
+
+- `src/model/formulations`：轨迹约束建模
+- `src/instance/modify.jl`：实例预处理
+
+更详细的说明与测试示例参见 `UnitCommitment_Trajectory_Test/README.md`。
+
+## 11. 引用
+
+原始 UnitCommitment.jl DOI：  
+[10.5281/zenodo.4269874](https://doi.org/10.5281/zenodo.4269874)