https://github.com/Benjamin-Gunn/DART/tree/state-variable-namelist

Skeleton program moved to my fork: https://github.com/hkershaw-brown/DART/tree/state-variable-namelist

Ben J. has a pull request on this also

Generic routine now available in default_model_mod.f90 on the state_vars_namelist branch -

Initial questions:

• Is this the best location for this routine?
• Some versions of this routine allow for more columns to present in the table than just netcdf variable name, dart qty, update. Do we want to remove these fields and only allow for the three listed above?

EX (tiegcm):

I believe the default_model_mod is the best location for this routine. Here is why:

• It nudges people to use the off-the-shelf version, if the template model_mod.90 use this vertify_state_variables routine. People who need more, can write their own version (e.g. in the same way as way pert_model_copies in the default_model_mod can be used or you can write your own)

removing the extra fields:
I do want to remove these fields, however, we have taken the cautious (maybe cowardly) approach to leaving model_mod namelist options alone to miminize breaking whatever scripting/setup people have for dart

• I think it is worth looking at these variations on a theme and why they have the extra columns, for example, TIEGCM (I think) is because it is reading from two files, so could you replace

verify_state_variables(big list which applies to 2 fies)

with

verify_state_variables(for file1)
verify_state_variables(for file2)

?

Also this routine is ripe for a unit test, can you throw a unit test in
https://github.com/NCAR/DART-tests/tree/main/unit (I'll give you write permission on main - with great power comes great responsibly, yada yada)

Also this routine is ripe for a unit test, can you throw a unit test in https://github.com/NCAR/DART-tests/tree/main/unit (I'll give you write permission on main - with great power comes great responsibly, yada yada)

@hkershaw-brown Added a basic unit test to the DART-tests repo on the main branch and to the state_vars_namelist branch on the DART repo

ok next question, what do you think of the name 'verify_state_variables'?

and next next question, unit test,
how about using fotran-test anything and testing some namelist reads against some known values?

ok next question, what do you think of the name 'verify_state_variables'?

This was actually something I was going to ask you. It's not horrible, but I feel the subroutine is more about reading the namelist item into a table than it is about the verifying. Maybe a name that says both? Like read_and_verify_state_vars

I think it could be good to mention the namelist in the subroutine name as well, but read_and_verify_state_vars_namelist is maybe too long?

and next next question, unit test, how about using fotran-test anything and testing some namelist reads against some known values?

Yep this is on my to-do list

@hkershaw-brown

On branch state_vars_namelist:

• Generic subroutine renamed get_state_variables
• Updating the generic routine by including the type state_vars_type and storing the contents of the nml entry here
• Including a conditional use_clamping that tells whether or not the model's nml entry includes clamping values; executing a separate do loop over the rows if true to allow for reading in these values
• Developer test updated as suggested
• Removing MOM6 version of subroutine and making necessary adjustments (serves as an example for future model_mods that will use this routine and existing model_mods that can be converted to use this routine)