[Dart-dev] <P>Jump/ Revision: 11406

Tue Mar 28 16:51:02 MDT 2017

raeder at ucar.edu
2017-03-28 16:51:00 -0600 (Tue, 28 Mar 2017)
645
Move filter.nml to modules/assimilation/filter_mod.nml,
so that it's in the same directory as the module which defines it.

Split the previous programs/filter/filter.html into a new version,
which focuses on the filter overview, and modules/assimilation/filter_mod.html,
which focuses on the filter_mod_nml.
Also general updating of the content to be consistent with the Manhattan release -
fixed filenames, 4 state space output stages, etc. - and condensing and clarifying
some text.

The htmls would like to be reviewed by someone else's eyes.

NOT done; 
   > updating the ERROR codes sections of the html files.
   > testing all the links.




Added: DART/branches/rma_trunk/assimilation_code/modules/assimilation/filter_mod.html
===================================================================

--- DART/branches/rma_trunk/assimilation_code/modules/assimilation/filter_mod.html	                        (rev 0)
+++ DART/branches/rma_trunk/assimilation_code/modules/assimilation/filter_mod.html	2017-03-28 22:51:00 UTC (rev 11406)
@@ -0,0 +1,640 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+          "http://www.w3.org/TR/html4/strict.dtd">
+<HTML>
+<HEAD>
+<TITLE>module filter_mod</TITLE>
+<link rel="stylesheet" type="text/css" href="../../../documentation/html/doc.css" />
+<link href="../../../documentation/images/dart.ico" rel="shortcut icon" />
+</HEAD>
+<BODY>
+<A NAME="TOP"></A>
+
+<H1>MODULE filter_mod</H1>
+
+<table border=0 summary="dart header" cellpadding=5>
+<tr>
+    <td valign=middle>
+    <img src="../../../documentation/images/Dartboard7.png" alt="DART project logo" height=70 />
+    </td>
+    <td>
+       <P>Jump to <a href="../../../documentation/index.html">DART Documentation Main Index</a><br />
+          <small><small>version information for this file: <br />
+          <!-- version tag follows, do not edit -->
+          $Id$</small></small>
+       </P></td>
+</tr>
+</table>
+
+<A HREF="#Namelist">NAMELIST</A> /
+<A HREF="#Modules">MODULES</A> /
+<A HREF="#FilesUsed">FILES</A> /
+<!-- <A HREF="#References">REFERENCES</A> / -->
+<A HREF="#Errors">ERRORS</A> /
+<A HREF="#FuturePlans">PLANS</A> /
+<A HREF="#Legalese">TERMS OF USE</A>
+
+<H2>Overview</H2>
+
+<P>
+   Main module for driving ensemble filter assimilations. 
+   Used by filter.f90, perfect_model_obs.f90, model_mod_check.f90, 
+   and a variety of test programs.
+   See the <A href="../../programs/filter/filter.html">filter description</A>
+   for a general description of filter capabilities and controls.
+</P>
+<P>
+   <em class=program>filter_mod</em> is a Fortran 90 module, and provides a large
+   number of options for controlling execution behavior and parameter configuration
+   that are driven from its namelist. 
+   See the <a href=#Namelist>namelist</a> section below for more details.
+   The number of assimilation steps to be done 
+   is controlled by the input observation sequence and by the 
+   time-stepping capabilities of the model being used in the assimilation.
+<P>
+   See the <A href="http://www.image.ucar.edu/DAReS/DART">DART web site</A> 
+   for more documentation, including a discussion of the capabilities of the
+   assimilation system, a diagram of the entire execution cycle, the options
+   and features.
+</P>
+
+
+<P><!-- make sure the 'top' is aligned correctly --></P>
+
+<!--==================================================================-->
+<!--=================== DESCRIPTION OF A NAMELIST ====================-->
+<!--==================================================================-->
+
+<A NAME="Namelist"></A>
+<div class="top">[<a href="#">top</a>]</div><hr />
+<H2>NAMELIST</H2>
+<P>
+This namelist is read from the file <em class=file>input.nml</em>.
+Namelists start with an ampersand
+'&amp;' and terminate with a slash '/'.
+Character strings that contain a '/' must be
+enclosed in quotes to prevent them from 
+prematurely terminating the namelist.
+</P>
+
+<div class=namelist>
+<pre>
+&amp;filter_nml
+   single_file_in               = .false.,
+   input_state_files            = 'null',
+   input_state_file_list        = 'null',
+   init_time_days               = 0,
+   init_time_seconds            = 0,
+   perturb_from_single_instance = .false.,
+   perturbation_amplitude       = 0.2,
+
+   stages_to_write              = 'output'
+
+   single_file_out              = .false.,
+   output_state_files           = 'null',
+   output_state_file_list       = 'null',
+   output_interval              = 1,
+   output_members               = .true.,
