Skip to content

Commit fa96db1

Browse files
Hyperloop documentation additions for requesting long train (#264)
* Explain changing derived data type of long trains * Explain changing derived data type of long trains in operator docs * Add long train derived data type img
1 parent 44b4f1f commit fa96db1

File tree

3 files changed

+16
-0
lines changed

3 files changed

+16
-0
lines changed

docs/hyperloop/operatordocumentation.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,15 @@ There are a number of settings that you can decide on when composing a train:
189189
<img src="../images/cloneTrain.png" width="70%">
190190
</div>
191191

192+
### <a name="request-long-train"></a>Request Long Train
193+
192194
* <a name="longTrain"></a>The _Request long train_ tab allows users to request a long train after the train ran on a short dataset. Short datasets are subsets of a big dataset (_set up in the Dataset settings_). First, a train run needs to be **Done on a smaller short dataset** before being run on a bigger dataset.
195+
* When requesting a long train, it is possible to request standard derived data from a short train with slim derived data.
196+
197+
<div align="center">
198+
<img src="../images/longTrainDerivedType.png" width="70%">
199+
</div>
200+
193201
* Any user who is part of the analysis can request a long train. Approval from the participating analyses PWGs conveners is required in order to submit a long train. Train operators or admins can also approve a long train, but it is usually done by the PWG.
194202

195203
<div align="center">

docs/hyperloop/userdocumentation.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -492,8 +492,16 @@ It is possible that a wagon test will produce multiple warnings. In that case, t
492492
<img src="../images/mergedOutput1.png" width="90%">
493493
</div>
494494

495+
496+
### <a name="request-long-train"></a> Request Long Train
497+
495498
* <a name="longTrain"></a>The _Request long train_ tab allows users to request a long train after the train ran on a short dataset. Short datasets are subsets of a big dataset (_set up in the Dataset settings_). First, a train run needs to be **Done on a smaller short dataset** before being run on a bigger dataset.
496499
* Any user who is part of the analysis can request a long train. Approval from the participating analyses PWGs conveners is required in order to submit a long train.
500+
<div align="center">
501+
<img src="../images/longTrainDerivedType.png" width="70%">
502+
</div>
503+
504+
* When requesting a long train, it is possible to request standard derived data from a short train with slim derived data by changing the derived data setting as shown above.
497505

498506
<div align="center">
499507
<img src="../images/requestLongTrain.png" width="70%">
308 KB
Loading

0 commit comments

Comments
 (0)