user-guide: examples #666
Merged
user-guide: examples #666
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Document the major design patters for implementing Cylc workflows. * Along with cylc/cylc-flow#5773, this closes cylc#627 * Add some functional examples for users to play with. * The aim is to help assist workflow writers by providing them with minimal templates to flush out.
oliver-sanders
commented
Oct 17, 2023
8 tasks
markgrahamdawson
previously approved these changes
Dec 13, 2023
|
The tests will fail until the cylc-flow PR is merged. To build locallay, you'll need to checkout this branch (cylc-doc) and the corresponding cylc-flow branch then |
markgrahamdawson
approved these changes
Dec 14, 2023
MetRonnie
reviewed
Dec 21, 2023
|
|
||
| # rm cylc-flow-examples || true | ||
| examples="$(python -c 'import cylc.flow; from pathlib import Path; print(Path(cylc.flow.__file__).parent)')/etc/examples" | ||
| for example in $(echo "${examples}/"*); do |
There was a problem hiding this comment.
Might be a bit less awkward if this whole file was a python script?
There was a problem hiding this comment.
I generally use Bash for simple systemy things like this.
There was a problem hiding this comment.
If you want to switch to the light side 😛
#!/usr/bin/env python3
from pathlib import Path
import cylc.flow
examples_dir = Path(cylc.flow.__file__).parent / "etc/examples"
for example in examples_dir.iterdir():
if example.is_dir():
target = Path("src/user-guide/examples") / example.name
target.unlink(missing_ok=True)
target.symlink_to(example)
MetRonnie
approved these changes
Jan 30, 2024
|
|
||
| # rm cylc-flow-examples || true | ||
| examples="$(python -c 'import cylc.flow; from pathlib import Path; print(Path(cylc.flow.__file__).parent)')/etc/examples" | ||
| for example in $(echo "${examples}/"*); do |
There was a problem hiding this comment.
If you want to switch to the light side 😛
#!/usr/bin/env python3
from pathlib import Path
import cylc.flow
examples_dir = Path(cylc.flow.__file__).parent / "etc/examples"
for example in examples_dir.iterdir():
if example.is_dir():
target = Path("src/user-guide/examples") / example.name
target.unlink(missing_ok=True)
target.symlink_to(example)
|
Upstream branch merged, tests now running. One spelling mistake causing the failures, fixed in: cylc/cylc-flow#5951 |
|
Passed, merging |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Requirements check-list
CONTRIBUTING.mdand added my name as a Code Contributor.