Skip to content

Commit

Permalink
Rename linked datasets to short datasets in Hyperloop documentation (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolaspoffley committed Apr 18, 2024
1 parent 67fb985 commit 4c9dfba
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions docs/hyperloop/notifications.md
Expand Up @@ -23,7 +23,7 @@ title: Notifications
* Notifies the user that an update has been made to one of the datasets included in his or her analyses. The notification message contains a link to the history of the dataset that has been modified, as well as a link to the analysis this dataset is included in. The update here indicates that:
* The list of runs to be excluded in a production has been modified
* The dataset has been staged or unstaged to a target
* A linked dataset had been added or removed
* A short dataset had been added or removed
* The automatic composition settings have changed, e.g. the schedule

<div align="center">
Expand Down Expand Up @@ -74,9 +74,9 @@ title: Notifications
<img src="../images/mergelistUpdate.png" width="90%">
</div>

## <a name="linkedDataset"></a>Linked datasets
## <a name="linkedDataset"></a>Short datasets

* When a dataset has linked datasets, it cannot be part of an analysis. If a dataset was part of an analysis, and then the dataset is modified to have linked datasets, then the dataset is removed from the analysis. If there were enabled wagons, they are disabled.
* When a dataset has short datasets, it cannot be part of an analysis. If a dataset was part of an analysis, and then the dataset is modified to have short datasets, then the dataset is removed from the analysis. If there were enabled wagons, they are disabled.

## <a name="infoWagonDisabled"></a>Disabled wagon

Expand Down
8 changes: 4 additions & 4 deletions docs/hyperloop/operatordocumentation.md
Expand Up @@ -59,8 +59,8 @@ There are a number of settings that you can decide on when composing a train:

### <a name="stagedsubmission"></a>Staged Submission

* Linked datasets are subsets of a big dataset
* First, a train run needs to be _Done_ on a smaller linked dataset before being run on a bigger dataset
* Short datasets are subsets of a big dataset
* 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**, by going on the train result to the _Request long train_ tab
* Choose the dataset, target and wagons you want to include and click the _Compose and request approval_ button.
* Approval from the participating analyses PWGs conveners is required in order to submit a long train
Expand Down Expand Up @@ -189,7 +189,7 @@ 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="longTrain"></a>The _Request long train_ tab allows users to request a long train after the train ran on a linked dataset. Linked datasets are subsets of a big dataset (_set up in the Dataset settings_). First, a train run needs to be **Done on a smaller linked dataset** before being run on a bigger dataset.
* <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. Train operators or admins can also approve a long train, but it is usually done by the PWG.

<div align="center">
Expand Down Expand Up @@ -246,7 +246,7 @@ There are a number of settings that you can decide on when composing a train:
<img src="../images/editDatasetOptions.png" width="70%">
</div>

* <a name="datasetoptions"></a>In the **Options** box, you can add linked datasets to the current dataset, which will be used for the [**staged submission**](#stagedsubmission). Enabling _Run final merging over all runs in this dataset_ will merge all the runs of all the productions during the final merging.
* <a name="datasetoptions"></a>In the **Options** box, you can add short datasets to the current dataset, which will be used for the [**staged submission**](#stagedsubmission). Enabling _Run final merging over all runs in this dataset_ will merge all the runs of all the productions during the final merging.
* <a name="datasetstaging"></a>In the **Analysis Facility Staging**, the operator is able to stage or unstage the data to the available targets displayed in the dropdown.
* Choose a target from the dropdown list, and you will be notified of the amount of data required for the staging process. Confirm by clicking OK. The staging process will start once clicking the _Save all changes_ button at the top right of the page.
* You can hover over the staging percentage to get a detailed status of the staging progress. By clicking on the percentage, you will be lead to a new tab where you can see the elaborate overview of the transfer requests on MonALISA.
Expand Down
2 changes: 1 addition & 1 deletion docs/hyperloop/userdocumentation.md
Expand Up @@ -492,7 +492,7 @@ 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="longTrain"></a>The _Request long train_ tab allows users to request a long train after the train ran on a linked dataset. Linked datasets are subsets of a big dataset (_set up in the Dataset settings_). First, a train run needs to be **Done on a smaller linked dataset** before being run on a bigger dataset.
* <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">
Expand Down

0 comments on commit 4c9dfba

Please sign in to comment.