search

cylc / cylc-doc

Documentation (User Guide, Cheat Sheets, etc.) for the Cylc Workflow Engine.
https://cylc.github.io/cylc-doc/
GNU General Public License v3.0
8 stars 19 forks source link

Request for clarification about CYLC variables for SHARE_DIR and WORK_DIR #689

Closed ColemanTom closed 4 months ago

ColemanTom commented 4 months ago

Looking at https://cylc.github.io/cylc-doc/stable/html/reference/job-script-vars/index.html for CYLC_WORKFLOW_SHARE_DIR it says this could be for a task and to see below. I'm not sure what below I should be seeing. There is no other SHARE_DIR variable.

Similarly, for CYLC_WORKFLOW_WORK_DIR it says see below and I assume that means to look at CYLC_TASK_WORK_DIR but it is unclear. Perhaps you could reference the other variable which may be of interest?

oliver-sanders commented 4 months ago

There's also some missing context about the purpose of these directories.

Rolling this into: https://github.com/cylc/cylc-doc/issues/584

oliver-sanders commented 4 months ago

The CYLC_WORKFLOW_SHARE_DIR is always ~/cylc-run/<workflow-id>/share and the CYLC_WORKFLOW_WORK_DIR is always ~/cylc-run/<workflow-id>/work. I think the (see below) but has probably become dislodged from its original context.