From 273918f084a4fb113bf1c7ebf293c1d42ce25682 Mon Sep 17 00:00:00 2001 From: Martin Schupfner Date: Fri, 6 Feb 2026 10:00:49 +0100 Subject: [PATCH 1/2] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8329042..de48da0 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ `esgf-qa` provides a flexible quality assurance (QA) workflow for evaluating dataset compliance using the [ioos/compliance-checker](https://github.com/ioos/compliance-checker) framework (including [CF](https://cfconventions.org/) compliance checks) -and various community plugins (`cc-plugin`s), such as +and any community plugins (`cc-plugin`s), such as [ESGF/cc-plugin-wcrp](https://github.com/ESGF/cc-plugin-wcrp) and [euro-cordex/cc-plugin-cc6](https://github.com/euro-cordex/cc-plugin-cc6). @@ -88,7 +88,7 @@ $ esgqa [-h] [-P ] [-o ] [-t ] [-O OPTION] - `-h, --help`: show this help message and exit - `-P, --parallel_processes`: Specify the maximum number of parallel processes. Default: 0 (= number of cores). - `-o, --output_dir OUTPUT_DIR`: Directory to store QA results. Needs to be non-existing or empty or from previous QA run. If not specified, will store results in `./cc-qa-check-results/YYYYMMDD-HHmm_`. - - `-t, --test TEST`: The test to run (`'wcrp_cmip6:latest'`, `'wcrp_cordex_cmip6:latest'` or `'cf:'`, can be specified multiple times, eg.: `'-t wcrp_cmip6:latest -t cf:1.7'`) - default: running latest CF checks `'cf:latest'`. If the version is omitted, `latest` will be used. + - `-t, --test TEST`: The test to run (eg. `'wcrp_cmip6:latest'`, `'wcrp_cordex_cmip6:latest'` or `'cf:'`, can be specified multiple times, eg.: `'-t wcrp_cmip6:latest -t cf:1.7'`) - default: running latest CF checks `'cf:latest'`. If the version is omitted, `latest` will be used. - `-O, --option OPTION`: Additional options to be passed to the checkers. Format: `':[:]'`. Multiple invocations possible. - `-i, --info INFO`: Information used to tag the QA results, eg. the simulation id to identify the checked run. Suggested is the original experiment-id you gave the run. - `-r, --resume`: Specify to continue a previous QC run. Requires the `` argument to be set. @@ -111,7 +111,7 @@ $ esgqa -o QA_results/IAEVALL02_2025-10-20 -r For a custom MIP with defined CMOR tables (`"mip"` is not a placeholder but an actual basic checker of the `cc_plugin_cc6`): ```shell -$ esgqa -o /path/to/test/results -t "mip:latest" -O "mip:tables:/path/to/mip_cmor_tables/Tables" /path/to/MIP/datasets/` +$ esgqa -o /path/to/test/results -t "mip:latest" -O "mip:tables:/path/to/mip_cmor_tables/Tables" /path/to/MIP/datasets/ ``` For CF checks and basic time and consistency / continuity checks: From b72f13ff34ac2b223c278b99366c8de11f23d167 Mon Sep 17 00:00:00 2001 From: sol1105 Date: Fri, 6 Feb 2026 11:00:16 +0100 Subject: [PATCH 2/2] Update CLI help text --- esgf_qa/run_qa.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/esgf_qa/run_qa.py b/esgf_qa/run_qa.py index dc9d8ef..6482064 100644 --- a/esgf_qa/run_qa.py +++ b/esgf_qa/run_qa.py @@ -516,13 +516,17 @@ def main(): "--option", default=[], action="append", - help="Additional options to be passed to the checkers. Format: ':[:]'. Multiple invocations possible.", + help="Additional options to be passed to the checkers. Format: ':[:]'. " + "Multiple invocations possible.", ) parser.add_argument( "-t", "--test", action="append", - help="The test to run ('cc6:latest' or 'cf:', can be specified multiple times, eg.: '-t cc6:latest -t cf:1.8') - default: running 'cc6:latest' and 'cf:1.11'.", + help="The test(s) to run in format '[:]', (eg. 'wcrp_cmip7', " + "'wcrp_cmip6:latest' or 'cf:', can be specified multiple times, " + "eg.: '-t cc6:latest -t cf:1.11') - default: running 'cf:latest'. " + "The default version selected for each checker is 'latest'.", ) parser.add_argument( "-i",