----------------------------------------------------
lines 6-109 of file: at_cascade/cascade_root_node.py
----------------------------------------------------

{xrst_begin cascade_root_node}
{xrst_spell
  var
}

Cascade Fits Starting at Root Node
##################################

Prototype
*********
{xrst_literal
    # BEGIN_DEF
    # END_DEF
}

all_node_database
*****************
is a python string specifying the location of the
:ref:`all_node_db-name`
relative to the current working directory.

fit_goal_set
************
This is a ``set`` with elements of type ``int`` (``str``)
specifying the node_id (node_name) for each element of the
:ref:`glossary@fit_goal_set` .
Each such node must be the root node, or a descendant of the root node.
In addition, it must be in the :ref:`fit_goal_table-name` ,
or an ancestor of a node in the fit goal table.

no_ode_fit
**********
if ``True`` ( ``False`` ) the :ref:`no_ode_fit-name` routine
will (will not) be used to modify the mean of the parent value
and difference priors.

fit_type_list
*************
This is a list with one or two elements
and its possible elements are ``both`` and ``fixed``.
For each job, the first type of fit is attempted.
If it fails, and there is a second type of fit, it is attempted.
If it also fails, the corresponding job fails.

root_fit_database
*****************
This database is located at

    *result_dir*\ ``/``\ *root_node_name*\ ``/dismod.db``

see :ref:`option_all_table@result_dir`
and :ref:`option_all_table@root_node_name`.
If *no_ode_fit* is ``True`` ( ``False`` ) the priors in the
*root_database* are modified (are not modified)
before the root node is fit;
see :ref:`option_all_table@root_database` .
Upon return, this is a :ref:`glossary@fit_database` with the
extra properties listed below:

Version
=======
The ``at_cascade`` and ``dismod_at`` version numbers
are stored at the beginning of the log table in the
*root_fit_database* .

Output dismod.db
****************
Upon return for cascade_root_node,
the results for the fits are in ``dismod.db`` in the corresponding
directory relative to *result_dir*; i.e., sub-directory of *result_dir* .
The *.csv* files can be created using the
dismod_at db2csv command.
The dismod_at function ``plot_rate_fit`` and ``plot_data_fit``
can be used to crate the corresponding plots.

The root level fit the directory is
:ref:`option_all_table@root_node_name` .
If the current fit is just before a split,
there will be a sub-directory for the fit of each
:ref:`split_reference_table@split_reference_name` after the split.
Otherwise there will be a sub-directory for the fit of each child of the
node corresponding to the current fit.
You can determine the directory, relative to *result_dir*
corresponding to a fit using the :ref:`get_database_dir-name` function.


fit_var
=======
The fit_var table correspond to the posterior
mean for the model variables for  this job; i.e., this
:ref:`create_job_table@job_table@fit_node_id` and
:ref:`create_job_table@job_table@split_reference_id`.

sample
======
The sample table contains the corresponding samples from the posterior
distribution for the model variables for this job.

log
===
The log table contains a summary of the operations preformed on dismod.db
between it's input and output state.

{xrst_end cascade_root_node}