Workflow end-to-end script should follow standard syntax for arguments, documentation needs updating

[mkavulich]

Original issue opened by @climbfuji migrated from regional_workflow repository: ufs-community/regional_workflow#607

Description

Currently the workflow end-to-end script uses a non-standard format for arguments passed to the script, for example:

./run_WE2E_tests.sh \
    tests_file="explist.txt" \
    machine="HERA" \
    account="gsd-hpcs"

Standard syntax would be

./run_WE2E_tests.sh \
    --tests_file="explist.txt" \
    --machine="HERA" \
    --account="gsd-hpcs"

or

./run_WE2E_tests.sh \
    -t "explist.txt" \
    -m "HERA" \
    -a "gsd-hpcs"

or a mixture of these. This should be changed, because it causes unnecessary confusion.

Also, the documentation in https://ufs-srweather-app.readthedocs.io/en/latest/WE2Etests.html is outdated.

Solution

Adopt standard syntax and update documentation.

Alternative Solutions

Do nothing and make life for users harder than necessary.

[mkavulich]

Resolved by #586