Skip to content

Allow configurable Cylc run directory - #7411

Draft
mulroony wants to merge 2 commits into
cylc:masterfrom
mulroony:configurable-cylc-run-dir
Draft

Allow configurable Cylc run directory#7411
mulroony wants to merge 2 commits into
cylc:masterfrom
mulroony:configurable-cylc-run-dir

Conversation

@mulroony

@mulroony mulroony commented Aug 3, 2026

Copy link
Copy Markdown

Allow the Cylc run directory to be configured

Closes #7410

Summary

Allow the CYLC_RUN_DIR environment variable to override the standard $HOME/cylc-run workflow run root.

The default remains unchanged when the variable is unset.

Changes

  • Use CYLC_RUN_DIR in local and remote workflow path construction.
  • Automatically forward CYLC_RUN_DIR over Cylc-managed SSH commands.
  • Export it in generated job scripts so clean job-submission environments retain the configured run root.
  • Document the environment variable and its interaction with symlink directories.
  • Preserve the precedence of explicit alternate run-directory arguments.

This differs from [install][symlink dirs]: symlink configuration moves workflow data but retains the canonical namespace under $HOME/cylc-run. CYLC_RUN_DIR moves that namespace itself for sites where home directories cannot be used for workflow runtime state.

Testing

  • 128 focused path, remote-command, job-file, and global-config unit tests passed.
  • 222 install, workflow-file, ID parsing, cleanup, completion, and integration tests passed.
  • Manual smoke test confirmed that cylc install places a workflow under CYLC_RUN_DIR and that cylc validate finds it there.

Check list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes.
  • Does not contain off-topic changes.
  • No dependency changes.
  • Appropriate tests are included.
  • Changelog fragment added after the PR number is assigned.
  • Cylc documentation PR opened, if requested by the maintainers.

Signed-off-by: Patrick Mulrooney <pmulrooney@ucsd.edu>
@hjoliver

hjoliver commented Aug 5, 2026

Copy link
Copy Markdown
Member

(See discussion on the associated issue #7410, on whether we need this or not).

@oliver-sanders
oliver-sanders marked this pull request as draft September 1, 2026 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove need for user home directory entirely.

2 participants