[Dart-dev] DART/branches Revision: 12610

[dart at ucar.edu]

hendric at ucar.edu
2018-05-31 14:11:14 -0600 (Thu, 31 May 2018)
167

updating html documentation for closest_member_tool.  now
has a slightly different namelist that no longer requires
the mean from filter and can be run in parallel.




Modified: DART/branches/rma_closest_member_tool/assimilation_code/programs/closest_member_tool/closest_member_tool.html
===================================================================
--- DART/branches/rma_closest_member_tool/assimilation_code/programs/closest_member_tool/closest_member_tool.html	2018-05-31 19:14:14 UTC (rev 12609)
+++ DART/branches/rma_closest_member_tool/assimilation_code/programs/closest_member_tool/closest_member_tool.html	2018-05-31 20:11:14 UTC (rev 12610)
@@ -37,7 +37,8 @@
 
 <P>
 Utility program to compare the ensemble mean to a group of ensemble
-member restart files.  The program prints out a sorted order of which
+member restart files, which can now be run in parallel for large models.  
+The program prints out a sorted order of which
 members are 'closest' to the mean, where the method used to determine 
 'close' is selectable by namelist option.  It also creates a file with
 a single number or character string in it, for ease in scripting, which
@@ -127,13 +128,13 @@
 <div class=namelist>
 <pre>
 &closest_member_tool_nml
-   input_restart_file_list   = 'null'
-   mean_restart_file_list    = 'null'
-   output_file_name          = 'closest_restart'
-   ens_size                  = 20
-   single_restart_file_in    = .false.
-   difference_method         = 4
-   use_only_kinds            = ''
+   input_restart_files     = ''
+   input_restart_file_list = ''      
+   output_file_name        = 'closest_restart'      
+   ens_size                = 20
+   single_restart_file_in  = 4      
+   difference_method       = 4      
+   use_only_qtys           = ''
   /
 </pre>
 </div>
@@ -151,28 +152,19 @@
 
 <TBODY valign=top>
 
-<TR><TD>input_restart_file_list</TD>
-    <TD>character(len=256),dimension(500)</TD>
+<TR><TD>input_restart_files</TD>
+    <TD>character(len=256),dimension(ens_size x num_domains)</TD>
 <TD>an array of filenames each containing a list DART restart data.
-<!-- @>todo  If 'single_restart_file_in' is
-.true., this is the exact filename.  If 'single_restart_file_in' is .false.
-this is the base name and '.NNNN' will be appended to each name before being opened. -->
 </TD></TR>
 
-<TR><TD>mean_restart_file_list</TD>
-    <TD>character(len=256),dimension(500)</TD>
-    <TD><!-- @>todo File created by this program with either the ensemble number or full
-restart filename for the closest member.  If 'single_restart_file_in' is
-.true., the file contains the ensemble number.  If 'single_restart_file_in' is
-.false. the file contains the base name and '.NNNN' appended for the closest member. -->
+<TR><TD>input_restart_file_list</TD>
+    <TD>character(len=256),dimension(num_domains)</TD>
+<TD>a file containing a list of filenames for DART restart data, one for each domain.
 </TD></TR>
 
 <TR><TD>output_file_name</TD>
     <TD>character(len=256)</TD>
-    <TD><!-- @>todo File created by this program with either the ensemble number or full
-restart filename for the closest member.  If 'single_restart_file_in' is
-.true., the file contains the ensemble number.  If 'single_restart_file_in' is
-.false. the file contains the base name and '.NNNN' appended for the closest member. -->
+    <TD>
 </TD></TR>
 
 <TR><TD>ens_size</TD>
@@ -180,11 +172,11 @@
     <TD>Total number of ensemble members.
 </TD></TR>
 
-<TR><TD>single_restart_file_in</TD>
+<!--TR><TD>single_restart_file_in</TD> @>todo : not tested yet
     <TD>logical</TD>
     <TD>Whether the input filename contains a single ensemble member per file or
-multiple members concatinated in the same file.
-</TD></TR>
+        multiple members concatinated in the same file.
+</TD></TR-->
 
 <TR><TD>difference_method</TD>
     <TD>integer</TD>
@@ -218,7 +210,7 @@
 
 <!--==================================================================-->
 
-<A NAME="Modules"></A>
+<!-- A NAME="Modules"></A> @>todo modules have too many dependencies to make this meaninful
 <div class="top">[<a href="#">top</a>]</div><hr />
 <H2>MODULES USED</H2>
 <PRE>
@@ -228,7 +220,7 @@
 sort_mod
 assim_model_mod
 mpi_utilities_mod
-</PRE>
+</PRE-- >