GNU General Public License

This file is part of the Data Assimilation Research Testbed (DART).

DART is free software; you can redistribute it and/or modify it
and are expected to follow the terms of the GNU General Public
License as published by the Free Software Foundation.

DART is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with DART; if not, write to:

Free Software Foundation, Inc.
59 Temple Place, Suite 330
Boston, MA 02111-1307 USA
or see:
http://www.gnu.org/licenses/gpl.txt

Contact:	Jeff Anderson, Tim Hoar
Revision:	$Revision: 2858 $
Source:	$URL: http://subversion.ucar.edu/DAReS/DART/trunk/index.html $
Change Date:	$Date: 2007-04-12 11:04:11 -0600 (Thu, 12 Apr 2007) $
Change history:	try "svn log" or "svn diff"

DART Documentation Index - Jamaica Release

OVERVIEW / USER_DOCUMENTATION / PROGRAMS / MODELS / NAMELIST / MODULES / OTHER_DOCUMENTATION

Overview

This page contains links the documentation for this DART release. The overview for this release is doc/html/Jamaica_release.html and the differences from the previous release are highlighted in doc/html/Jamaica_diffs_from_I.html. General DART documentation can be found in the doc/html directory. Every source file has a corresponding .html files that contains specifics on public interfaces in each of the DART modules, for the executable programs which come with DART, and for how to interface new models into the DART system.

The best way to get to know the DART software is to follow along while reading the tutorial documents in the DART/tutorial directory.

User Documentation and Tutorials

Start here if you are looking for DART User-level documentation. DART comes with an extensive set of documentation including release notes for each version, a walk-through on-line tutorial, and a full set of pdf and framemaker tutorial materials.

A DART tutorial in PDF format is available.

All sections below this one are detailed information on the programming interfaces of all the DART modules, the namelist details, the executable programs which are part of DART. For introductory materials, see the links above.

Programs

DART consists of a library of functions and executable programs. The main DART executable is the filter program. Other programs generate data or format the diagnostic information.

The executable programs that come with dart include:

program filter
program preprocess
program perfect_model_obs
program ncep_obs:create_real_obs.html
program prep_bufr:prep_bufr.html
program create_fixed_network_seq
program create_obs_sequence
program integrate_model
program wakeup_filter
program merge_obs_seq
program rms_diag

Models

DART comes with several models which can be used to learn about data assimilation, to do actual experiments with real observations, or to use as a template for adding additional models to DART.

All models in the DART project have individual documentation pages, which can be found here (if an html document is not available, the link is to the .f90 source):

Overview for all models
template (source)
9var (html)
MITgcm_annulus (source)
PBL_1d (html)
bgrid_solo (source)
cam (html)
forced_barot (source)
forced_lorenz_96 (html)
ikeda (html)
lorenz_04 (html)
lorenz_63 (html)
lorenz_84 (html)
lorenz_96 (html)
lorenz_96_2scale (source)
null_model (source)
pe2lyr (source)
wrf (html)

Namelists

Generally read from the file input.nml. We adhere to the F90 standard of starting a namelist with an ampersand '&' and terminating with a slash '/'. Modules and programs which have namelists include:

&perfect_model_obs_nml
&filter_nml
&smoother_nml
&ensemble_manager_nml
&assim_tools_nml
&cov_cutoff_nml
&reg_factor_nml
&obs_sequence_nml
&assim_model_nml
&model_nml
&location_nml (1 d)
&location_nml (3d sphere)
&preprocess_nml
&obs_kind_nml
&utilities_nml
&mpi_utilities_nml
&obs_diag_nml (1 d)
&obs_diag_nml (3d sphere)
&merge_obs_seq_nml

Modules

All modules in the DART project have individual documentation pages, which can be found here:

adaptive_inflate/adaptive_inflate_mod
assim_model/assim_model_mod
assim_tools/assim_tools_mod
cov_cutoff/cov_cutoff_mod
ensemble_manager/ensemble_manager_mod
location/oned/location_mod
location/threed_sphere/location_mod
models/model_mod
mpi_utilities/mpi_utilities_mod
obs_def/DEFAULT_obs_def_mod
obs_def/obs_def_1d_state_mod
obs_def/obs_def_dew_point_mod
obs_def/obs_def_mod
obs_def/obs_def_radar_mod
obs_kind/DEFAULT_obs_kind_mod
obs_kind/obs_kind_mod
obs_model/obs_model_mod
obs_sequence/obs_sequence_mod
random_nr/random_nr_mod
random_seq/random_seq_mod
reg_factor/reg_factor_mod
smoother/smoother_mod
utilities/utilities_mod