Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added note about PYTHONPATH & CYLC_PYTHONPATH #665

Merged
merged 8 commits into from
Nov 15, 2023
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions src/reference/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ Cylc 8.3.0
:cylc-uiserver: `1.4 <https://github.com/cylc/cylc-uiserver/blob/1.4.x/CHANGES.md>`__
:cylc-rose: `1.4 <https://github.com/cylc/cylc-rose/blob/1.4.x/CHANGES.md>`__

Cylc ignores `PYTHONPATH`
wxtim marked this conversation as resolved.
Show resolved Hide resolved
^^^^^^^^^^^^^^^^^^^^^^^^^

Cylc now ignores ``$PYTHONPATH`` to make it more robust to task
environments which set this value. If you want to add to the Cylc
environment itself, e.g. to install a Cylc extension,
use ``$CYLC_PYTHONPATH``.


Upgrade To The Latest Jupyter Releases
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -156,11 +164,11 @@ Combined Commands

Two new commands have been added as short-cuts for common working patterns:

``cylc vip``
``cylc vip``
Validate, install and plays a workflow, equivalent to:

.. code-block:: bash

cylc validate <path>
cylc install <path>
cylc play <id>
Expand Down
2 changes: 1 addition & 1 deletion src/user-guide/writing-workflows/external-triggers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ properties:
- they can be located either:

- in ``<workflow-dir>/lib/python/``;
- or anywhere in your Python library path.
- or anywhere in your ``$CYLC_PYTHONPATH``.
MetRonnie marked this conversation as resolved.
Show resolved Hide resolved

- they can take arbitrary positional and keyword arguments
- workflow and task identity, and cycle point, can be passed to trigger
Expand Down
2 changes: 1 addition & 1 deletion src/user-guide/writing-workflows/runtime.rst
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ as it is running, these can be placed in:
* ``share/bin/`` - for executables. This location is automatically added to ``PATH``
(before the top-level ``bin/`` in the run dir).
* ``share/lib/python/`` - for Python modules. This location is automatically added
to ``PYTHONPATH`` (before the top-level ``lib/python/`` in the run dir).
to ``$PYTHONPATH`` (before the top-level ``lib/python/`` in the run dir).

.. note::

Expand Down
Loading