EridanusQ commited on
Commit
441b9a8
·
1 Parent(s): 854c968

document direct-layout case archives

Browse files
Files changed (2) hide show
  1. .gitignore +2 -1
  2. README.md +53 -6
.gitignore CHANGED
@@ -1,2 +1,3 @@
1
  /.idea/
2
- /npm-cache
 
 
1
  /.idea/
2
+ /npm-cache
3
+ /case*/
README.md CHANGED
@@ -37,11 +37,15 @@ The project is split into two repositories:
37
 
38
  The `main` branch is the landing page for the dataset repository. Data are stored on separate branches.
39
 
40
- | Branch | Archive | Contents |
41
- | --- | --- | --- |
42
- | `case3375wp` | `case3375wp.tar.gz` | Generated MPS files for `case3375wp` |
43
- | `case6515rte` | `case6515rte.tar.gz` | Generated MPS files for `case6515rte` |
44
- | `case9241pegase` | `case9241pegase.tar.gz` | Generated MPS files for `case9241pegase` |
 
 
 
 
45
 
46
  More case branches can be added using the same convention:
47
 
@@ -53,7 +57,7 @@ archive root: <case_name>/
53
 
54
  ## Archive Contents
55
 
56
- After extracting a case archive, the directory structure is:
57
 
58
  ```text
59
  case_name/
@@ -63,6 +67,49 @@ case_name/
63
  └── subhourly_withline/
64
  ```
65
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
66
  The four variants represent:
67
 
68
  | Directory | Description |
 
37
 
38
  The `main` branch is the landing page for the dataset repository. Data are stored on separate branches.
39
 
40
+ | Branch | Archive | MPS files | Archive layout |
41
+ | --- | --- | ---: | --- |
42
+ | `case14` | `case14.tar.gz` | 1460 | direct variant layout |
43
+ | `case30` | `case30.tar.gz` | 1460 | direct variant layout |
44
+ | `case57` | `case57.tar.gz` | 1448 | direct variant layout |
45
+ | `case118` | `case118.tar.gz` | 1460 | direct variant layout |
46
+ | `case3375wp` | `case3375wp.tar.gz` | 96 | horizon layout |
47
+ | `case6515rte` | `case6515rte.tar.gz` | 96 | horizon layout |
48
+ | `case9241pegase` | `case9241pegase.tar.gz` | 96 | horizon layout |
49
 
50
  More case branches can be added using the same convention:
51
 
 
57
 
58
  ## Archive Contents
59
 
60
+ After extracting a case archive, the archive root is always the case directory:
61
 
62
  ```text
63
  case_name/
 
67
  └── subhourly_withline/
68
  ```
69
 
70
+ There are two layouts inside the four variant directories.
71
+
72
+ ### Direct Variant Layout
73
+
74
+ Smaller full-year cases use this layout:
75
+
76
+ ```text
77
+ case_name/
78
+ ├── hourly_noline/*.mps
79
+ ├── hourly_withline/*.mps
80
+ ├── subhourly_noline/*.mps
81
+ └── subhourly_withline/*.mps
82
+ ```
83
+
84
+ Current direct-layout branches:
85
+
86
+ ```text
87
+ case14
88
+ case30
89
+ case57
90
+ case118
91
+ ```
92
+
93
+ ### Horizon Layout
94
+
95
+ Larger sampled cases use an additional horizon layer:
96
+
97
+ ```text
98
+ case_name/
99
+ ├── hourly_noline/{3_days,7_days,14_days}/*.mps
100
+ ├── hourly_withline/{3_days,7_days,14_days}/*.mps
101
+ ├── subhourly_noline/{3_days,7_days,14_days}/*.mps
102
+ └── subhourly_withline/{3_days,7_days,14_days}/*.mps
103
+ ```
104
+
105
+ Current horizon-layout branches:
106
+
107
+ ```text
108
+ case3375wp
109
+ case6515rte
110
+ case9241pegase
111
+ ```
112
+
113
  The four variants represent:
114
 
115
  | Directory | Description |