diff --git a/docs/basics.rst b/docs/basics.rst index 7b334bdc70de3a14a38d5d6061f4179bf0a57dfb..aab879e0354d40d45e3856bc125698e769b17bc0 100644 --- a/docs/basics.rst +++ b/docs/basics.rst @@ -103,11 +103,11 @@ If a workflow has been added without check it can be check later with:: lpad check_wflow -i <firework ID> -Note: The correctness check is recommended for all exercises in this tutorial. +**NOTE:** The correctness check is recommended for all exercises in this tutorial. -View workflows --------------- +Visualize workflows +------------------- Already added workflows can be converted into DOT format and viewed graphically as PDF:: @@ -134,10 +134,14 @@ To run all fireworks in *READY* state in a sequence:: rlaunch rapidfire -Note: Every firework changes its state to *READY* after all its dependency fireworks -are completed (state *COMPLETED*) and the states of linked child fireworks are updated -as soon as a firework if completed. This means that any workflow will be run until -there are no more fireworks in *READY* state. +**NOTE:** Every firework changes its state to *READY* after all its parent +fireworks are completed (state *COMPLETED*) and the states of linked child +fireworks are updated as soon as a firework if completed. This means that any +workflow will be run until there are no more fireworks in *READY* state. + +**NOTE:** In singleshot mode ``rlaunch`` runs the firework in the directory where it is +started. In rapidfire mode ``rlaunch`` creates a runtime sibdirectory one per firework +and executes each firework in a separate directory. To suppress verbose information on the screen the *-s* flag can be added:: @@ -161,7 +165,7 @@ Alternatively the web GUI can be used:: lpad webgui -Note: Make sure that a web browser is configured in your terminal session and an +**NOTE:** Make sure that a web browser is configured in your terminal session and an X server is running on your machine and it is configured and tunneled properly in your terminal session.