cfe icon indicating copy to clipboard operation
cfe copied to clipboard

Add support for short and long `soil_params` names in config

Open aaraney opened this issue 1 year ago • 2 comments
trafficstars

Currently, several NOAA-OWP maintained BMI modules (see https://github.com/NOAA-OWP/SoilFreezeThaw/pull/14#issuecomment-1864879127) share the convention of using soil_params.<x> where x is a parameter name in their config file format. However, when soil_params parameters are exposed as calibratable, the convention is to drop soil_params and just use the parameter name. To avoid confusion and increase consistency, this change enables specifying calibratable cfe soil_params in config files using just their name. Support for the existing soil_params names is maintained.

This PR adds support for specifying calibratable soil_params using their short form. The config readme is updated and clarifies what calibratable parameter names are used when passing to and from BMI.

Changes

  • The following parameters can be specified using either name in a config file: alpha_fc <=> soil_params.alpha_fc b <=> soil_params.b maxsmc <=> soil_params.maxsmc satdk <=> soil_params.satdk satpsi <=> soil_params.satpsi slope <=> soil_params.slope wltsmc <=> soil_params.wltsmc Klf <=> K_lf

aaraney avatar Jan 02 '24 15:01 aaraney

Thanks for the review, @ajkhattak! I'm AFK at the moment, but will get these resolved and pushed up today.

aaraney avatar Jan 16 '24 16:01 aaraney

@ajkhattak, just pushed up some changes and responded to your comments.

aaraney avatar Jan 16 '24 17:01 aaraney