Use click to allow command line arguments #79
Merged
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
Click seems better suited to this task than argparse since pyproject.toml wants to call run() from cupid/run.py rather than running run.py as a command line script. First pass added --serial and --time-series flags; the former can be updated to skip creating the LocalCluster object in notebooks, the latter can be updated to run time series generation directly.
Also make use of serial in ocean and ice notebooks
click is already in the cupid-dev environment, but it was not listed as a dependency in the pyproject.toml file
For now, this option raises a NotImplementedError exception. The branch that incorporates time series should remove that block (as well as the "import sys" line)
A few notes:
|
|
Should we also include the flag options in the README, or at least mention that descriptions are available with |
Yes! I'll update the README now. |
rmshkv
approved these changes
Mar 8, 2024
There was a problem hiding this comment.
This is a good first pass at these features, thanks for diving into this Mike!
Another thought is we probably want to include some more extensive documentation for people developing notebooks about including the serial parameter and logic with the local cluster, maybe in a separate page about parallelization, but I don't think that has to happen with this PR.
TeaganKing
approved these changes
Mar 8, 2024
|
I made a note in #73 about documentation, so will merge and close this. |
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.
Sorry about the misleading branch name, but
clickseems better suited to this task thanargparsesincepyproject.tomlwants to callrun()fromcupid/run.pyrather than runningrun.pyas a command line script.Fixes #72