Skip to content

Commit 3543dee

Browse files
committed
include a description of WORKFLOW_SHARE_DIR/bin and lib/python
1 parent 84bb4b5 commit 3543dee

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

src/user-guide/writing-workflows/configuration.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ Other files and folders may be placed in the :term:`source directory` too:
5555
documentation, configuration files, etc. When the workflow is :ref:`installed
5656
<Installing-workflows>` these will be copied over to the :term:`run directory`.
5757

58+
If your workflow needs to create or install scripts or executables at runtime
59+
and you don't want Cylc to delete them on re-installation, you can create
60+
equivalent directories in the :ref:`WorkflowShareDirectories`.
61+
5862

5963
.. _SyntaxHighlighting:
6064

src/user-guide/writing-workflows/runtime.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,8 @@ exported to subshells:
306306
# relative to the workflow work directory
307307
308308
309+
.. _WorkflowShareDirectories:
310+
309311
Workflow Share Directories
310312
^^^^^^^^^^^^^^^^^^^^^^^^^^
311313

@@ -317,6 +319,16 @@ output files are typically held in cycle point sub-directories of this.
317319
The top level share directory location can be changed, e.g. to a large data
318320
area, by global config settings under :cylc:conf:`global.cylc[install][symlink dirs]`.
319321

322+
If your workflow creates or installs executables or python libraries
323+
as it is running, these can be placed in:
324+
325+
* ``share/bin`` - for executables.
326+
* ``share/lib/python`` - for Python modules.
327+
328+
These folders will be added to ``PATH`` and ``PYTHONPATH`` so they can be
329+
used by jobs in the same way as
330+
:ref:`top level "bin/" and "lib/python/" directories <WorkflowDefinitionDirectories>`.
331+
320332

321333
Task Work Directories
322334
^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)