Changes between Version 9 and Version 10 of Developers/NamelistChecker

Timestamp:

2020-06-08T15:51:58+02:00 (5 years ago)

Author:

acc

Comment:

--

Developers/NamelistChecker

@@ -23 +23 @@
  * compare the contents lists for matching named blocks to confirm membership
  * report any mis-matches together with the line number in the configuration namelist
+ * where possible, suggest close matches that may indicate typos
 
 By default, the script will compare ''namelist_cfg'' and ''namelist_ref'' from the current directory. Alternative pairs can be named using the ''-c'' and ''-r'' command-line options:
@@ -37 +38 @@
   --cfg [CFGFILE], -c [CFGFILE]  configuration namelist
   --ref [REFFILE], -r [REFFILE]  reference namelist
+  --match [MFACTOR], -m [MFACTOR]   closeness factor (0-1)
 }}}
 
@@ -43 +45 @@
 {{{
 python nemo_nml_check.py
-No match for:  rn_rdt  in  namdom  (at line no.  39 )
+No match in matching blocks for:                           |  Possible close match:
+rn_rdt                 in namdom       (at line no.   39)  |  rn_dt
 }}}
 
@@ -117 +120 @@
 
 {{{
-python nemo_nml_check.py -c namelist_ref -r pseudo_nml_ref 
-No match for:  sn_wnum  in  namsbc_wave  (at line no.  497 )
-No match for:  sn_tauwoc  in  namsbc_wave  (at line no.  498 )
-No match for:  sn_tauwx  in  namsbc_wave  (at line no.  499 )
-No match for:  sn_tauwy  in  namsbc_wave  (at line no.  500 )
-No match for:  clname(1)  in  nam_tide  (at line no.  581 )
-No match for:  tname(1)  in  nam_diaharm  (at line no.  1188 )
-No match for:  tname(2)  in  nam_diaharm  (at line no.  1189 )
-No match for:  sn_cfctl%l_config  in  namctl  (at line no.  1322 )
-No match for:  sn_cfctl%l_runstat  in  namctl  (at line no.  1323 )
-No match for:  sn_cfctl%l_trcstat  in  namctl  (at line no.  1324 )
-No match for:  sn_cfctl%l_oceout  in  namctl  (at line no.  1325 )
-No match for:  sn_cfctl%l_layout  in  namctl  (at line no.  1326 )
-No match for:  sn_cfctl%l_mppout  in  namctl  (at line no.  1327 )
-No match for:  sn_cfctl%l_mpptop  in  namctl  (at line no.  1328 )
-No match for:  sn_cfctl%procmin  in  namctl  (at line no.  1329 )
-No match for:  sn_cfctl%procmax  in  namctl  (at line no.  1330 )
-No match for:  sn_cfctl%procincr  in  namctl  (at line no.  1331 )
-No match for:  sn_cfctl%ptimincr  in  namctl  (at line no.  1332 )
-}}}
-
-It is probably the case that the structure variables flagged (sn_*) are false positives. This is because only the structure name is declared in the namelist but individual members of the structure may be (and are) set in the ''namelist_ref''. Nonetheless, there are  a few normal variables to investigate and this does illustrate the potential usefulness of this tool.
+python nemo_nml_check.py -r pseudo_nml_ref -c namelist_ref -m 0.75
+No match in matching blocks for:                           |  Possible close match:
+sn_wnum                in namsbc_wave  (at line no.  497)  |  sn_wmp
+sn_tauwoc              in namsbc_wave  (at line no.  498)  |
+sn_tauwx               in namsbc_wave  (at line no.  499)  |
+sn_tauwy               in namsbc_wave  (at line no.  500)  |
+clname(1)              in nam_tide     (at line no.  581)  |  clname
+tname(1)               in nam_diaharm  (at line no. 1188)  |  tname
+tname(2)               in nam_diaharm  (at line no. 1189)  |  tname
+sn_cfctl%l_config      in namctl       (at line no. 1322)  |
+sn_cfctl%l_runstat     in namctl       (at line no. 1323)  |
+sn_cfctl%l_trcstat     in namctl       (at line no. 1324)  |
+sn_cfctl%l_oceout      in namctl       (at line no. 1325)  |
+sn_cfctl%l_layout      in namctl       (at line no. 1326)  |
+sn_cfctl%l_mppout      in namctl       (at line no. 1327)  |
+sn_cfctl%l_mpptop      in namctl       (at line no. 1328)  |
+sn_cfctl%procmin       in namctl       (at line no. 1329)  |
+sn_cfctl%procmax       in namctl       (at line no. 1330)  |
+sn_cfctl%procincr      in namctl       (at line no. 1331)  |
+sn_cfctl%ptimincr      in namctl       (at line no. 1332)  |
+}}}
+
+It is probably the case that the structure variables flagged (sn_*) are false positives. This is because only the structure name is declared in the namelist but individual members of the structure may be (and are) set in the ''namelist_ref''. Nonetheless, there are  a few normal variables to investigate and this does illustrate the potential usefulness of this tool. Note, the 'possible close matches' are provided by a simple string comparator. By default, only matches exceeding a closeness factor of 0.75 are reported. More (or fewer) possibilities can be provided by decreasing (or increasing) this factor between 0 and 1. This is done by providing the additional command line argument '-m fatc' as shown here (although it was unnecessary since 0.75 is the default value).
 
 Secondly, reversing the roles of the input namelists allows a check on whether or not all the available namelist variables have a default setting in ''namelist_ref'':
@@ -144 +148 @@
 {{{
 python nemo_nml_check.py -r namelist_ref -c pseudo_nml_ref 
-No match for:  ln_rnf_icb  in  namsbc_rnf  (at line no.  169 )
-No match for:  sn_i_rnf  in  namsbc_rnf  (at line no.  172 )
-No match for:  clname  in  nam_tide  (at line no.  195 )
-No match for:  ln_time_average_weight  in  namberg  (at line no.  582 )
-No match for:  tname  in  nam_diaharm  (at line no.  814 )
-No match for:  sn_cfctl  in  namctl  (at line no.  949 )
-No match for:  ln_sto_ldf  in  namsto  (at line no.  1056 )
-No match for:  rn_ldf_std  in  namsto  (at line no.  1057 )
-No match for:  rn_ldf_tcor  in  namsto  (at line no.  1058 )
-No match for:  ln_sto_hpg  in  namsto  (at line no.  1059 )
-No match for:  rn_hpg_std  in  namsto  (at line no.  1060 )
-No match for:  rn_hpg_tcor  in  namsto  (at line no.  1061 )
-No match for:  ln_sto_pstar  in  namsto  (at line no.  1062 )
-No match for:  rn_pstar_std  in  namsto  (at line no.  1063 )
-No match for:  rn_pstar_tcor  in  namsto  (at line no.  1064 )
-No match for:  nn_pstar_flt  in  namsto  (at line no.  1065 )
-No match for:  nn_pstar_ord  in  namsto  (at line no.  1066 )
-No match for:  ln_sto_trd  in  namsto  (at line no.  1067 )
-No match for:  rn_trd_std  in  namsto  (at line no.  1068 )
-No match for:  rn_trd_tcor  in  namsto  (at line no.  1069 )
-No match for:  ln_sto_trc  in  namsto  (at line no.  1078 )
-No match for:  nn_sto_trc  in  namsto  (at line no.  1079 )
-No match for:  rn_trc_stdxy  in  namsto  (at line no.  1080 )
-No match for:  rn_trc_stdz  in  namsto  (at line no.  1081 )
-No match for:  rn_trc_tcor  in  namsto  (at line no.  1082 )
-No match for:  nn_trc_ord  in  namsto  (at line no.  1083 )
-No match for:  nn_trc_flt  in  namsto  (at line no.  1084 )
-No match for:  rn_trc_lim  in  namsto  (at line no.  1085 )
+No match in matching blocks for:                           |  Possible close match:
+ln_rnf_icb             in namsbc_rnf   (at line no.  172)  |
+sn_i_rnf               in namsbc_rnf   (at line no.  175)  |  sn_t_rnf
+clname                 in nam_tide     (at line no.  198)  |  clname(1)
+ln_time_average_weight in namberg      (at line no.  594)  |
+tname                  in nam_diaharm  (at line no.  826)  |  tname(2)
+sn_cfctl               in namctl       (at line no.  984)  |
+ln_sto_ldf             in namsto       (at line no. 1100)  |
+rn_ldf_std             in namsto       (at line no. 1101)  |
+rn_ldf_tcor            in namsto       (at line no. 1102)  |
+ln_sto_hpg             in namsto       (at line no. 1103)  |
+rn_hpg_std             in namsto       (at line no. 1104)  |
+rn_hpg_tcor            in namsto       (at line no. 1105)  |
+ln_sto_pstar           in namsto       (at line no. 1106)  |
+rn_pstar_std           in namsto       (at line no. 1107)  |
+rn_pstar_tcor          in namsto       (at line no. 1108)  |
+nn_pstar_flt           in namsto       (at line no. 1109)  |
+nn_pstar_ord           in namsto       (at line no. 1110)  |
+ln_sto_trd             in namsto       (at line no. 1111)  |
+rn_trd_std             in namsto       (at line no. 1112)  |
+rn_trd_tcor            in namsto       (at line no. 1113)  |
+ln_sto_trc             in namsto       (at line no. 1122)  |
+nn_sto_trc             in namsto       (at line no. 1123)  |
+rn_trc_stdxy           in namsto       (at line no. 1124)  |
+rn_trc_stdz            in namsto       (at line no. 1125)  |
+rn_trc_tcor            in namsto       (at line no. 1126)  |
+nn_trc_ord             in namsto       (at line no. 1127)  |
+nn_trc_flt             in namsto       (at line no. 1128)  |
+rn_trc_lim             in namsto       (at line no. 1129)  |
 }}}
 
@@ -199 +204 @@
 {{{
 python nemo_nml_check.py -c ../cfgs/SHARED/namelist_top_ref -r pseudo_nml_top_ref
-No match for:  sn_trcdta(1)  in  namtrc_dta  (at line no.  61 )
-No match for:  ln_trdmld_trc_restart  in  namtrc_trd  (at line no.  124 )
-No match for:  ln_trdmld_trc_instant  in  namtrc_trd  (at line no.  125 )
-No match for:  ln_trdtrc( 1)  in  namtrc_trd  (at line no.  126 )
-No match for:  ln_trdtrc( 2)  in  namtrc_trd  (at line no.  127 )
-No match for:  ln_trdtrc(23)  in  namtrc_trd  (at line no.  128 )
-
+No match in matching blocks for:                           |  Possible close match:
+sn_trcdta(1)           in namtrc_dta   (at line no.   61)  |  sn_trcdta
+ln_trdmld_trc_restart  in namtrc_trd   (at line no.  124)  |  ln_trdmxl_trc_restart
+ln_trdmld_trc_instant  in namtrc_trd   (at line no.  125)  |  ln_trdmxl_trc_instant
+ln_trdtrc( 1)          in namtrc_trd   (at line no.  126)  |  ln_trdtrc
+ln_trdtrc( 2)          in namtrc_trd   (at line no.  127)  |  ln_trdtrc
+ln_trdtrc(23)          in namtrc_trd   (at line no.  128)  |  ln_trdtrc
 
 python nemo_nml_check.py -r ../cfgs/SHARED/namelist_top_ref -c pseudo_nml_top_ref
-No match for:  sn_trcobc  in  namtrc_bc  (at line no.  4 )
-No match for:  rn_trofac  in  namtrc_bc  (at line no.  5 )
-No match for:  sn_trcsbc  in  namtrc_bc  (at line no.  7 )
-No match for:  rn_trsfac  in  namtrc_bc  (at line no.  8 )
-No match for:  sn_trccbc  in  namtrc_bc  (at line no.  10 )
-No match for:  rn_trcfac  in  namtrc_bc  (at line no.  11 )
-No match for:  sn_tri_tracer  in  namtrc_ice  (at line no.  25 )
-No match for:  sn_tracer  in  namtrc  (at line no.  48 )
-No match for:  ln_trdmxl_trc_restart  in  namtrc_trd  (at line no.  59 )
-No match for:  ln_trdmxl_trc_instant  in  namtrc_trd  (at line no.  60 )
-No match for:  cn_trdrst_trc_in  in  namtrc_trd  (at line no.  61 )
-No match for:  cn_trdrst_trc_out  in  namtrc_trd  (at line no.  62 )
-No match for:  ln_trdtrc  in  namtrc_trd  (at line no.  63 )
-No match for:  sn_trcdta  in  namtrc_dta  (at line no.  67 )
-No match for:  rn_trfac  in  namtrc_dta  (at line no.  69 )
+No match in matching blocks for:                           |  Possible close match:
+sn_trcobc              in namtrc_bc    (at line no.    4)  |
+rn_trofac              in namtrc_bc    (at line no.    5)  |
+sn_trcsbc              in namtrc_bc    (at line no.    7)  |
+rn_trsfac              in namtrc_bc    (at line no.    8)  |
+sn_trccbc              in namtrc_bc    (at line no.   10)  |
+rn_trcfac              in namtrc_bc    (at line no.   11)  |
+sn_tri_tracer          in namtrc_ice   (at line no.   25)  |
+sn_tracer              in namtrc       (at line no.   48)  |
+ln_trdmxl_trc_restart  in namtrc_trd   (at line no.   59)  |  ln_trdmld_trc_restart
+ln_trdmxl_trc_instant  in namtrc_trd   (at line no.   60)  |  ln_trdmld_trc_instant
+cn_trdrst_trc_in       in namtrc_trd   (at line no.   61)  |
+cn_trdrst_trc_out      in namtrc_trd   (at line no.   62)  |
+ln_trdtrc              in namtrc_trd   (at line no.   63)  |  nn_trd_trc
+sn_trcdta              in namtrc_dta   (at line no.   67)  |  sn_trcdta(1)
+rn_trfac               in namtrc_dta   (at line no.   69)  |
 }}}
 
@@ -236 +242 @@
 {{{
 python nemo_nml_check.py -c ../cfgs/SHARED/namelist_pisces_ref -r pseudo_nml_pisces_ref
-No match for:  mprat2  in  namp5zmort  (at line no.  199 )
-No match for:  xpref2p  in  namp5zmes  (at line no.  233 )
+No match in matching blocks for:                           |  Possible close match:
+mprat2                 in namp5zmort   (at line no.  199)  |  mpratd
+xpref2p                in namp5zmes    (at line no.  233)  |  xpref2d
 
 python nemo_nml_check.py -r ../cfgs/SHARED/namelist_pisces_ref -c pseudo_nml_pisces_ref
-No match for:  mpratd  in  namp5zmort  (at line no.  357 )
-No match for:  xpref2n  in  namp5zmes  (at line no.  398 )
+No match in matching blocks for:                           |  Possible close match:
+mpratd                 in namp5zmort   (at line no.  357)  |  mprat2
+xpref2n                in namp5zmes    (at line no.  398)  |  xpref2c
 }}}