Datasets:

EridanusQ
/

UnitCommitment_Trajectory_Dataset

@@ -4,6 +4,7 @@ task_categories:
 - other
 language:
 - en
 tags:
 - mixed-integer-programming
 - power-systems
@@ -12,189 +13,135 @@ tags:
 - 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)

 - other
 language:
 - en
+- zh
 tags:
 - mixed-integer-programming
 - power-systems
 - mps
 - benchmark
 size_categories:
+- 1K<n<10K
 ---
+# UnitCommitment Trajectory Dataset
+This repository stores generated Unit Commitment trajectory benchmark data.
+The project is split into two repositories:
+- Code repository: `EridanusQ/UnitCommitment_Trajectory`
+  - generation scripts
+  - modified UnitCommitment.jl source code
+  - Matpower instance download and preprocessing workflow
+  - documentation for reproducing the MPS generation process
+- Dataset repository: `EridanusQ/UnitCommitment_Trajectory_Dataset`
+  - this Hugging Face Dataset repository
+  - generated `.mps` benchmark files
+  - one data case per Git branch
+  - each branch stores the case as a compressed `.tar.gz` archive
+## Repository Layout
+The `main` branch is the landing page for the dataset repository. Data are stored on separate branches.
+| Branch | Archive | Contents |
+| --- | --- | --- |
+| `case3375wp` | `case3375wp.tar.gz` | Generated MPS files for `case3375wp` |
+| `case6515rte` | `case6515rte.tar.gz` | Generated MPS files for `case6515rte` |
+| `case9241pegase` | `case9241pegase.tar.gz` | Generated MPS files for `case9241pegase` |
+More case branches can be added using the same convention:
+```text
+branch name:   <case_name>
+archive name:  <case_name>.tar.gz
+archive root:  <case_name>/
 ```
+## Archive Contents
+After extracting a case archive, the directory structure is:
 ```text
 case_name/
+├── hourly_noline/
+├── hourly_withline/
+├── subhourly_noline/
+└── subhourly_withline/
 ```
+The four variants represent:
+| Directory | Description |
+| --- | --- |
+| `hourly_noline` | Hourly UC instances without transmission line constraints |
+| `hourly_withline` | Hourly SCUC instances with transmission line constraints |
+| `subhourly_noline` | Sub-hourly UC instances without transmission line constraints |
+| `subhourly_withline` | Sub-hourly SCUC instances with transmission line constraints |
+File names follow:
+```text
+<case>_<date>_<resolution>_<network>.mps
 ```
+For example:
+```text
+case3375wp_2017-05-01_s_withline.mps
+case6515rte_2017-08-01_h_noline.mps
+case9241pegase_2017-02-25_h_noline.mps
+```
+where `h` means hourly and `s` means sub-hourly.
+## Download
+### Download With Hugging Face CLI
 ```powershell
+huggingface-cli download EridanusQ/UnitCommitment_Trajectory_Dataset `
+  case3375wp.tar.gz `
+  --repo-type dataset `
+  --revision case3375wp `
+  --local-dir data/case3375wp
 ```
+Replace `case3375wp` with the target branch/case name.
+### Download With Git LFS
 ```powershell
+git lfs install
+git clone -b case3375wp https://huggingface.co/datasets/EridanusQ/UnitCommitment_Trajectory_Dataset
 ```
+Then extract the archive:
 ```powershell
+tar -xzf case3375wp.tar.gz
 ```
+## Dataset Generation
+The generated data come from Matpower Unit Commitment instances and are exported as standard `.mps` files for mixed-integer programming solver benchmarking.
+The generation workflow is maintained in the separate code repository, not in this dataset repository. Please use the code repository for:
+- environment setup
+- downloading source Matpower instances
+- modifying or inspecting UnitCommitment.jl model code
+- regenerating MPS files
+- reproducing the trajectory constraints and preprocessing logic
+This dataset repository is intended to be lightweight to browse: each branch contains only the compressed generated output for one case.
+## Storage Policy
+Do not commit expanded `.mps` directories to this repository. For each case:
+1. Generate the case directory locally.
+2. Compress it as `<case_name>.tar.gz`.
+3. Commit the archive to the matching branch.
+4. Track the archive with Git LFS.
+This keeps each branch easy to download and avoids thousands of large text files in the Git tree.
+## Citation
+The original UnitCommitment.jl project is available at:
+[10.5281/zenodo.4269874](https://doi.org/10.5281/zenodo.4269874)