Offline driver initialisation refactor continued

[SeanBryan51]

This change further consolidates the initialisation logic within the offline drivers to remove code duplication and improve code clarity across each of the drivers (see #425, #440 and #469).

As part of the refactoring changes, new optional namelist options (filename%new_sumbal and filename%trunk_sumbal) are introduced to replace hard coded filenames and optional namelist option CASAonly is restored for consistency with the documentation.

Type of change

• Code refactor
• New feature
• New or updated documentation

Checklist

• The new content is accessible and located in the appropriate section.
• I have checked that links are valid and point to the intended content.
• I have checked my code/text and corrected any misspellings

---

📚 Documentation preview 📚: https://cable--472.org.readthedocs.build/en/472/

[SeanBryan51]

Note: testing with cable_user%consistency_check = .TRUE. produces the expected behaviour.

[micaeljtoliveira]

@SeanBryan51 Overall looks quite good! Very nice to see the code becoming simpler and easier to understand.

I'm afraid I had forgotten to merge #469, but that's now done. Would you mind rebasing your branch onto main so that it's a bit easier to review the detailed changes?

[SeanBryan51]

@micaeljtoliveira rebased off main

[micaeljtoliveira]

@SeanBryan51 Thanks for rebasing. Not much else to say at this point, all looks quite good :)

Are you planning on doing more changes in this PR?

[SeanBryan51]

@micaeljtoliveira I have a couple small commits coming which refactor the initialisation of LALLOC and NRRRR variables in the driver. Once those are in and I've cleaned up the code, the PR should be in its final state to be merged.

[SeanBryan51]

@micaeljtoliveira no more changes from this point - ready for review

[SeanBryan51]

I've tested these changes with benchcab run and bitwise comparison checks pass:

PBS log file:

2024-11-21 17:30:41,779 - INFO - benchcab.benchcab.py:380 - Running comparison tasks...
2024-11-21 17:30:41,808 - INFO - benchcab.benchcab.py:381 - tasks: 168 (models: 2, sites: 42, science configurations: 4)
2024-11-21 17:33:35,109 - INFO - benchcab.benchcab.py:391 - 0 failed, 168 passed

Benchcab version: 4.2.0

config.yaml:

realisations:
  - repo:
      git:
        branch: main
  - repo:
      git:
        branch: 425-offline-driver-initialisation-refactor-part-2

modules: [
  intel-compiler/2021.1.1,
  netcdf/4.7.4,
  openmpi/4.1.0
]

Spatial (MPI) runs all execute as expected (note outputs do not reproduce as per issue #463).

[ccarouge]

All good. A suggestion to improve the text for the documentation.

[ccarouge]

This block is highly dependent on the previous block copied below:

    IF (icycle > CASAONLY_ICYCLE_MIN) THEN
      icycle                     = icycle - CASAONLY_ICYCLE_MIN
      CASAONLY                   = .TRUE.
      CABLE_USER%CASA_DUMP_READ  = .TRUE.
      CABLE_USER%CASA_DUMP_WRITE = .FALSE.

happening so that if icycle=12 in the namelist for example, it still works and doesn't error.

But you are quite right that this l_casacnp and icycle stuff need a rethink.