Add a force option to setup_xml to ignore unwritable directories

[DavidHuber-NOAA]

Description

This adds an option to issue warnings instead of errors for unwritable STMP, PTMP, or HOMEDIR directories.
Refs #3444

Type of change

• Bug fix (fixes something broken)
• New feature (adds functionality)

Change characteristics

• Is this a breaking change (a change in existing functionality)? NO
• Does this change require a documentation update? YES
• Does this change require an update to any of the following submodules? NO

How has this been tested?

Run setup_xml.py with and without the --force option when STMP was an unwritable directory. This returned a warning and an error, respectively.

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have documented my code, including function, input, and output descriptions
• My changes generate no new warnings
• New and existing tests pass with my changes
• Any new scripts have been added to the .github/CODEOWNERS file with owners

[RussTreadon-NOAA]

Thank you @DavidHuber-NOAA for modifying setup_xml.py. This doesn't work with GDASApp CI. When we run GDASApp CI, we execute

# Create the experiment
${HOMEgfs}/workflow/create_experiment.py --yaml ${expyaml} --overwrite

create_experiment.py invokes

    setup_xml_args = [str(experiment_dir)]

    logger.info(f"Call: setup_xml.main()")
    logger.debug(f"setup_xml.py {' '.join(setup_xml_args)}")
    setup_xml.main(setup_xml_args)

I don't see a way to pass --force into create_experiment.py for use by setup_xml.py.

[DavidHuber-NOAA]

OK, I will add the flag to create_experiment.py as well.

[DavidHuber-NOAA]

@RussTreadon-NOAA Please give this branch another try.

[RussTreadon-NOAA]

Tested the original and modified workflow/create_experiment.py and workflow/setup_xml.py as user role-da on Orion.

ctest -R test_gdasapp_C96C48_hybatmDA failed with unable to write errors using the original scripts

 19/136 Test #1991: test_gdasapp_C96C48_hybatmDA .............................................***Failed   12.41 sec
2025-03-14 12:27:21,368 - INFO     - root        : BEGIN: __main__.input_args
2025-03-14 12:27:21,369 - DEBUG    - root        : (  )
2025-03-14 12:27:21,372 - INFO     - root        :   END: __main__.input_args
2025-03-14 12:27:21,372 - DEBUG    - root        :  returning: Namespace(yaml=PosixPath('/work2/noaa/da/role-da/CI/orion/GDASApp/workflow/PR/1546/global-workflow/sorc\
/gdas.cd/bundle/../../../ci/cases/pr/C96C48_hybatmDA.yaml'), overwrite=True)
2025-03-14 12:27:21,433 - INFO     - root        : Call: setup_expt.main()
...
2025-03-14 12:27:26,192 - INFO     - root        : Call: setup_xml.main()
2025-03-14 12:27:26,192 - DEBUG    - root        : setup_xml.py /work2/noaa/da/role-da/CI/orion/GDASApp/workflow/PR/1546/global-workflow/sorc/gdas.cd/build/gdas/test/\
gw-ci/../../test/gw-ci/C96C48_hybatmDA/EXPDIR/C96C48_hybatmDA
/work2/noaa/global is unwritable.
/work2/noaa/global is unwritable.
Traceback (most recent call last):
  File "/work2/noaa/da/role-da/CI/orion/GDASApp/workflow/PR/1546/global-workflow/workflow/create_experiment.py", line 108, in <module>
    setup_xml.main(setup_xml_args)
  File "/work2/noaa/da/role-da/CI/orion/GDASApp/workflow/PR/1546/global-workflow/workflow/setup_xml.py", line 98, in main
    raise PermissionError(f'The {dk} path {base[dk]} cannot be written to!  Please correct this path and try again')
PermissionError: The HOMEDIR path /work2/noaa/global/role-da/ORION cannot be written to!  Please correct this path and try again

ctest -R test_gdasapp_C96C48_hybatmDA passed with the updated scripts.

(gdasapp) orion-login-2:/work2/noaa/da/role-da/CI/orion/GDASApp/workflow/PR/1546/global-workflow/sorc/gdas.cd/build$ ctest -R test_gdasapp_C96C48_hybatmDA
Test project /work2/noaa/da/role-da/CI/orion/GDASApp/workflow/PR/1546/global-workflow/sorc/gdas.cd/build
      Start 1991: test_gdasapp_C96C48_hybatmDA
 1/19 Test #1991: test_gdasapp_C96C48_hybatmDA ..................................   Passed   13.46 sec

Approve.

[RussTreadon-NOAA]

Thank you @DavidHuber-NOAA for the quick fix. Thank you @aerorahul for the quick review & merge.