Skip to content

Commit

Permalink
Add description to Hyperloop documentation for identical wagon detect…
Browse files Browse the repository at this point in the history
…ion (#259)

* Update userdocumentation.md

Rename 'linked datasets' to 'short datasets' in userdocumentation

* Update operatordocumentation.md

Rename 'linked datasets' to 'short datasets' in operatordocumentation.md

* Update notifications.md

Rename 'linked datasets' to 'short datasets' in notifications.md

* Add image of identical wagon error

* Update notifications.md

Add description of identical user to service wagon error.
  • Loading branch information
nicolaspoffley authored May 21, 2024
1 parent ac5ef62 commit 1744c96
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/hyperloop/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,16 @@ Informs the user when a wagon has been disabled in different circumstances:
<img src="../images/notificationWorkflow.png" width="90%">
</div>

* The wagon is disabled if one of the user defined dependencies of the wagon is considered identical to a service wagon. In order to most efficiently make use of the Grid and the analysis factilities, copies of core services are not permitted as it prevents combining several users into one train.

<div align="center">
<img src="../images/notificationIdenticalWagon.png" width="90%">
</div>

A service wagon is considered identical to a user wagon if it shares the same activated output tables, the same workflow, and it has matching configurables. To fix this error, please use the listed service wagon as a dependency instead of the copy.



## <a name="inconsistentParameters"></a>Inconsistent parameters

* Hyperloop makes a comparison between the wagon configuration and the configuration defined in O2 for the package tag selected for the wagon. If they do not coincide, the user will be informed about the mismatch. The comparison is case sensitive, therefore a Configurable will not match if its name does not contain the identical lowercase / uppercase combination.
Expand Down
Binary file added docs/images/notificationIdenticalWagon.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 1744c96

Please sign in to comment.