PROGRAM clm_to_dart

DART project logo

DART Documentation Main Index
version information for this file:
$Id: clm_to_dart.html 6382 2013-08-07 20:45:16Z nancy $

NAMELIST / MODULES / FILES / REFERENCES / ERRORS / PLANS / TERMS OF USE

Overview

clm_to_dart is the program that reads metadata from a CLM history file (usually linked to clm_history.nc), the model state from a CLM restart file (usually linked to clm_restart.nc) and creates a DART output/restart file (e.g. perfect_ics, filter_ics).

The list of variables used to create the DART state vector are specified in the input.nml file.

Conditions required for successful execution of clm_to_dart:

Since this program is called repeatedly for every ensemble member, we have found it convenient to link the CLM restart and history files to the default filenames clm_restart.nc, clm_history.nc, respectively. The default DART output filename is dart_ics - this may be moved or linked as necessary. The default filenames may be changed via the namelist.

[top]

NAMELIST

This namelist is read from the file input.nml. Namelists start with an ampersand '&' and terminate with a slash '/'. Character strings that contain a '/' must be enclosed in quotes to prevent them from prematurely terminating the namelist.

&clm_to_dart_nml
   clm_to_dart_output_file      = 'dart_ics',
   /

&model_nml
   clm_restart_filename         = 'clm_restart.nc',
   clm_history_filename         = 'clm_history.nc',
   calendar                     = 'Gregorian',
   clm_state_variables          = 'frac_sno',    'KIND_SNOWCOVER_FRAC',
                                  'SNOWDP',      'KIND_SNOW_THICKNESS',
                                  'T_SOISNO',    'KIND_SOIL_TEMPERATURE',
                                  'leafc',       'KIND_LEAF_CARBON'
   /

(partial list)


The clm_to_dart namelist items:

Item Type Description
clm_to_dart_output_file character(len=128) The name of the DART file containing the model state derived from the CLM restart file.


The &model_nml namelist here is a subset of the full namelist. Only the values used by the converter are listed here. The full description of the model_nml namelist is documented in the CLM model_mod documentation, but the most important variable for clm_to_dart is repeated here.

Item Type Description
clm_state_variables character(len=NF90_MAX_NAME) ::
dimension(160)
The list of variable names in the CLM restart file to use to create the DART state vector and their corresponding DART kind.


For example:

&clm_vars_nml
   clm_state_variables = 'frac_sno',   'KIND_SNOWCOVER_FRAC',
                         'H2OSNO',     'KIND_SNOW_WATER',
                         'SNOWDP',     'KIND_SNOW_THICKNESS',
                         'H2OSOI_LIQ', 'KIND_LIQUID_WATER',
                         'H2OSOI_ICE', 'KIND_ICE',
                         'T_SOISNO',   'KIND_SOIL_TEMPERATURE',
                         'leafc',      'KIND_LEAF_CARBON',
  /
[top]

MODULES USED

assim_model_mod
location_mod
model_mod
null_mpi_utilities_mod
obs_kind_mod
random_seq_mod
time_manager_mod
types_mod
utilities_mod
[top]

FILES Read

FILES Written

[top]

REFERENCES

none

[top]

ERROR CODES and CONDITIONS

none - all error messages come from modules that have their own documentation.

KNOWN BUGS

none

[top]

FUTURE PLANS

None.

[top]

Terms of Use

DART software - Copyright 2004 - 2013 UCAR.
This open source software is provided by UCAR, "as is",
without charge, subject to all terms of use at
http://www.image.ucar.edu/DAReS/DART/DART_download

Contact: DART core group
Revision: $Revision: 6382 $
Source: $URL: https://svn-dares-dart.cgd.ucar.edu/DART/releases/Lanai/models/clm/clm_to_dart.html $
Change Date: $Date: 2013-08-07 14:45:16 -0600 (Wed, 07 Aug 2013) $
Change history:  try "svn log" or "svn diff"