Skip to content

[Feature]: Make debug and dry_run more visible to users #811

Description

@forsyth2

How will this affect the next version number?

New feature (increment MINOR version)

Is your feature request related to a problem?

Yes, users sometimes don't remember or don't know about these two config options (debug, which gives more verbose output and doesn't delete the temporary workdirs; dry_run which doesn't actually run the jobs but only creates the .bash and .settings files).

Describe the solution you'd like

zppy --help currently only gives:

zppy --help
usage: zppy -c <config>

Launch E3SM post-processing tasks

options:
  -h, --help            show this help message and exit
  -c, --config CONFIG   configuration file
  -l, --last-year LAST_YEAR
                        last year to process

Almost all zppy parameters are passed in via the config file rather than by command line. We may consider adding these two troubleshooting parameters as command line options, or at least noting their existence in the help message.

Personally, I'd prefer the latter since if they don't appear in the config file, then they won't be visible in the provenance cfg (though I believe the .settings files woulds still in fact include them).

Describe alternatives you've considered

No response

Additional context

From https://github.com/E3SM-Project/zppy/blob/main/zppy/defaults/default.ini:

# Set to True to keep temporary directories/files after zppy completes
debug = boolean(default=False)
# This should be set to True if you don't want the batch jobs to be submitted
dry_run = boolean(default=False)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions