docs(workflow): add how to run non-contiguous dates and case lists #211
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
…low)--add-larger-examples
…com/WilhelmusLab/ice-floe-tracker-pipeline into docs(workflow)--add-larger-examples
cpaniaguam
requested changes
Dec 19, 2024
| ```bash | ||
| cylc tui | ||
| ``` | ||
| In the TUI you can view logs, and "trigger" (i.e., rerun) tasks which failed. |
There was a problem hiding this comment.
Suggested change
| In the TUI you can view logs, and "trigger" (i.e., rerun) tasks which failed. | |
| In the TUI you can view logs, and "trigger" (i.e., rerun) failed tasks. |
Comment on lines
+75
to
+78
| for fullname in $(pipx run example/util/get_fullnames.py "${datafile}" "${index_col}" --start 1 --stop 10); | ||
| do | ||
| cylc vip . -n ${name} --run-name=${fullname} $(pipx run example/util/template.py ${datafile} ${index_col} ${fullname}); | ||
| done |
There was a problem hiding this comment.
Suggested change
| for fullname in $(pipx run example/util/get_fullnames.py "${datafile}" "${index_col}" --start 1 --stop 10); | |
| do | |
| cylc vip . -n ${name} --run-name=${fullname} $(pipx run example/util/template.py ${datafile} ${index_col} ${fullname}); | |
| done | |
| cases=$(pipx run example/util/get_fullnames.py "${datafile}" "${index_col}" --start 1 --stop 10) | |
| for fullname in ${cases}; do | |
| cylc vip . -n ${name} --run-name=${fullname} $(pipx run example/util/template.py ${datafile} ${index_col} ${fullname}); | |
| done |
| cylc tui | ||
| ``` | ||
|
|
||
| The `template.py` script provided doesn't currently have support for setting any other parameters, but could be extended if needed. |
There was a problem hiding this comment.
I think it'd be nice to have a link to template.py as you've provided for the config files.
| ``` | ||
|
|
||
| The `template.py` script provided doesn't currently have support for setting any other parameters, but could be extended if needed. | ||
|
|
||
| ## Oscar | ||
|
|
||
| Contact the Wilhelmus Lab members for access to the pipeline environment on Oscar, Brown University's High Performance Computing cluster. |
There was a problem hiding this comment.
Suggested change
| Contact the Wilhelmus Lab members for access to the pipeline environment on Oscar, Brown University's High Performance Computing cluster. | |
| Contact the Wilhelmus Lab members for access to the pipeline environment on Brown University's High Performance Computing cluster (Oscar). |
Comment on lines
+16
to
+28
| def main( | ||
| datafile: pathlib.Path, | ||
| index_col: str, | ||
| start: Optional[int] = None, | ||
| stop: Optional[int] = None, | ||
| step: Optional[int] = None, | ||
| ): | ||
| f = pandas.read_csv(datafile) | ||
| print("\n".join(f[index_col].values[start:stop:step])) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| typer.run(main) |
There was a problem hiding this comment.
It feels to me like this cli would benefit from some annotations/documentation. Is this warranted? What's your vision?
There was a problem hiding this comment.
Here is what the help looks like right now; looks a bit too bare.
$ python get_fullnames.py --help
Usage: delete.py [OPTIONS] DATAFILE INDEX_COL
╭─ Arguments ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * datafile PATH [default: None] [required] │
│ * index_col TEXT [default: None] [required] │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --start INTEGER [default: None] │
│ --stop INTEGER [default: None] │
│ --step INTEGER [default: None] │
│ --help Show this message and exit. There was a problem hiding this comment.
Consider annotating get_fullnames.py in a similar fashion as this one. I can easily infer what this one script is for thanks to its annotations.
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.
No description provided.