Skip to content

Commit 3e80cd4

Browse files
committed
Merge branch 'feature.support_share/bin_and_share/lib' of github.com:wxtim/cylc-doc into feature.support_share/bin_and_share/lib
* 'feature.support_share/bin_and_share/lib' of github.com:wxtim/cylc-doc: Update src/user-guide/writing-workflows/runtime.rst Update src/user-guide/installing-workflows.rst Apply suggestions from code review Update src/user-guide/writing-workflows/runtime.rst Update src/user-guide/writing-workflows/runtime.rst Update src/user-guide/writing-workflows/runtime.rst Apply suggestions from code review add some extra links Update src/user-guide/writing-workflows/configuration.rst
2 parents 704c321 + 32dabe1 commit 3e80cd4

File tree

3 files changed

+23
-9
lines changed

3 files changed

+23
-9
lines changed

src/user-guide/installing-workflows.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,12 @@ The run directory now looks as follows:
398398
│ └── <time-stamp>-reinstall.log
399399
└── .service
400400
401+
.. note::
402+
403+
If your workflow needs to create or install scripts or executables at runtime
404+
and you don't want Cylc to delete them on re-installation, you can use
405+
``bin`` and ``lib/python`` directories in the :ref:` workflow share directory <WorkflowShareDirectories>`.
406+
401407

402408
Expected Errors
403409
---------------

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,11 @@ 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`.
58+
.. note::
59+
60+
If your workflow needs to create or install scripts or executables at runtime
61+
and you don't want Cylc to delete them on re-installation, you can use
62+
equivalent directories in the :ref:`WorkflowShareDirectories`.
6163

6264

6365
.. _SyntaxHighlighting:

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

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -319,15 +319,21 @@ output files are typically held in cycle point sub-directories of this.
319319
The top level share directory location can be changed, e.g. to a large data
320320
area, by global config settings under :cylc:conf:`global.cylc[install][symlink dirs]`.
321321

322-
If your workflow creates or installs executables or python libraries
322+
If your workflow creates or installs executables or Python libraries
323323
as it is running, these can be placed in:
324324

325-
* ``share/bin`` - for executables.
326-
* ``share/lib/python`` - for Python modules.
325+
* ``share/bin/`` - for executables. This location is automatically added to ``PATH``
326+
(before the top-level ``bin/`` in the run dir).
327+
* ``share/lib/python/`` - for Python modules. This location is automatically added
328+
to ``PYTHONPATH`` (before the top-level ``lib/python/`` in the run dir).
327329

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>`.
330+
.. note::
331+
332+
Cylc will not create these folders.
333+
334+
.. seealso::
335+
336+
:ref:`Top level "bin/" and "lib/python/" directories <WorkflowDefinitionDirectories>`.
331337

332338

333339
Task Work Directories

0 commit comments

Comments
 (0)