Skip to content

Commit

Permalink
Hyperloop documentation additions for requesting long train (#264)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
nicolaspoffley authored Sep 9, 2024
1 parent 44b4f1f commit fa96db1
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/hyperloop/operatordocumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,15 @@ There are a number of settings that you can decide on when composing a train:
<img src="../images/cloneTrain.png" width="70%">
</div>

### <a name="request-long-train"></a>Request Long Train

* <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.
* When requesting a long train, it is possible to request standard derived data from a short train with slim derived data.

<div align="center">
<img src="../images/longTrainDerivedType.png" width="70%">
</div>

* 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.

<div align="center">
Expand Down
8 changes: 8 additions & 0 deletions docs/hyperloop/userdocumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -492,8 +492,16 @@ It is possible that a wagon test will produce multiple warnings. In that case, t
<img src="../images/mergedOutput1.png" width="90%">
</div>


### <a name="request-long-train"></a> Request Long Train

* <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.
* 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.
<div align="center">
<img src="../images/longTrainDerivedType.png" width="70%">
</div>

* 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.

<div align="center">
<img src="../images/requestLongTrain.png" width="70%">
Expand Down
Binary file added docs/images/longTrainDerivedType.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fa96db1

Please sign in to comment.