Deploy preview for PR 57 🛫

pr-preview/pr-57/_sources/config.rst.txt

@@ -64,13 +64,13 @@ This is a non-exhaustive list containing the most important configuration variab
 +------------------------+-------------------------------------------------------------------------+
 | ``user_mail``          | The user's email address, determined based on system configuration.     |
 +------------------------+-------------------------------------------------------------------------+
-|| ``user_name``         || The username of the current user, obtained from the ``$USER``          |
-||                       || environment variable.                                                  |
+|| ``user_name``         || Your email address to receive notifications. Either provide it         |
+||                       || directly here or in ``~/.forward``.                                    |
 +------------------------+-------------------------------------------------------------------------+
 | ``workflow``           | The name of the workflow from ``workflows.yaml`` or a self-defined one. |
 +------------------------+-------------------------------------------------------------------------+
-|| ``work_root``         || The root directory for processing chain execution, typically located   |
-||                       || under the source directory.                                            |
+|| ``work_root``         || The working directory where all output is stored. Should be somewhere  |
+||                       || on ``$SCRATCH$``. By default, it is set to ``<chain_src_dir>/work``.   |
 +------------------------+-------------------------------------------------------------------------+
 
 

pr-preview/pr-57/config.html

@@ -270,8 +270,8 @@ <h2>Configuration Variables<a class="headerlink" href="#configuration-variables"
 </div>
 </td>
 <td><div class="line-block">
-<div class="line">The username of the current user, obtained from the <code class="docutils literal notranslate"><span class="pre">$USER</span></code></div>
-<div class="line">environment variable.</div>
+<div class="line">Your email address to receive notifications. Either provide it</div>
+<div class="line">directly here or in <code class="docutils literal notranslate"><span class="pre">~/.forward</span></code>.</div>
 </div>
 </td>
 </tr>
@@ -284,8 +284,8 @@ <h2>Configuration Variables<a class="headerlink" href="#configuration-variables"
 </div>
 </td>
 <td><div class="line-block">
-<div class="line">The root directory for processing chain execution, typically located</div>
-<div class="line">under the source directory.</div>
+<div class="line">The working directory where all output is stored. Should be somewhere</div>
+<div class="line">on <code class="docutils literal notranslate"><span class="pre">$SCRATCH$</span></code>. By default, it is set to <code class="docutils literal notranslate"><span class="pre">&lt;chain_src_dir&gt;/work</span></code>.</div>
 </div>
 </td>
 </tr>