Add support for specifying the output directory from the command line#3101
Open
lewisjared wants to merge 1 commit into
Open
Add support for specifying the output directory from the command line#3101lewisjared wants to merge 1 commit into
lewisjared wants to merge 1 commit into
Conversation
This was referenced Jun 5, 2026
bouweandela
reviewed
Jun 5, 2026
Member
bouweandela
left a comment
There was a problem hiding this comment.
Thanks @lewisjared! This is a feature that several people have asked about over the years.
Comment on lines
+629
to
+630
| **kwargs: | ||
| Command line arguments to override configuration parameters. |
Member
There was a problem hiding this comment.
This doesn't render correctly when running esmvaltool run --help:
NAME
esmvaltool run - Execute an ESMValTool recipe.
SYNOPSIS
esmvaltool run RECIPE <flags>
DESCRIPTION
`esmvaltool run` executes the given recipe. To see a list of available
recipes or create a local copy of any of them, use the
`esmvaltool recipes` command group.
A list of possible flags is given here:
https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart/configure.html#configuration-options
POSITIONAL ARGUMENTS
RECIPE
Path to the recipe to run.
FLAGS
-s, --session_name=SESSION_NAME
Type: Optional[]
Default: None
Name of the session output subdirectory (relative to the configured ``output_dir``). When given, this value is used instead of the default ``<recipe.stem>_<timestamp>``.
If the given name already exists, a suffix is added to the session name to avoid overwriting existing data. **kwargs: Command line arguments to override configuration parameters.
Additional flags are accepted.
NOTES
You can also use flags syntax for POSITIONAL ARGUMENTS
This file contains hidden or 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
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.
Description
Adds support for a
--session_nameCLI argument to allow users to specify the session name.This allows the ability to write results to a fixed and known directory.
Closes #3100
Before you get started
Checklist
It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.
To help with the number pull requests: