<!--

Top level docbook User's-Guide for CLM4

-->
<?xml version='1.0'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [

  <!-- Files to link in -->
  <!ENTITY compsets_list       SYSTEM "compsets_list_ofIcases.xml">
  <!ENTITY buildnml_help       SYSTEM "buildnml_help.xml">
  <!ENTITY build_streams_help  SYSTEM "build_streams_help.xml">
  <!ENTITY res_list            SYSTEM "buildnml_resolutions.xml">
  <!ENTITY usecases_list       SYSTEM "buildnml_usecases.xml">
  <!ENTITY getreg_datasets     SYSTEM "getregional_datasets.xml">
  <!ENTITY config_help         SYSTEM "config_help.xml">
  <!ENTITY quickstart_guide    SYSTEM "quickstart_guide.xml">
  <!ENTITY quickstart_userdata SYSTEM "quickstart_usrdat.xml">
  <!ENTITY filecopies          SYSTEM "filecopies.xml">
  <!ENTITY co2streams_diff     SYSTEM "addco2_datm.buildnml.xml">
  <!ENTITY preface             SYSTEM "preface.xml">
  <!ENTITY custom              SYSTEM "custom.xml">
  <!ENTITY tools               SYSTEM "tools.xml">
  <!ENTITY special_cases       SYSTEM "special_cases.xml">
  <!ENTITY adding_files        SYSTEM "adding_files.xml">
  <!ENTITY single_point        SYSTEM "single_point.xml">
  <!ENTITY ptclmdoc            SYSTEM "ptclm.xml">
  <!ENTITY ptclm_help          SYSTEM "ptclm_help.xml">
  <!ENTITY ptclm_list          SYSTEM "ptclm_list.xml">
  <!ENTITY trouble             SYSTEM "trouble_shooting.xml">
  <!ENTITY appendix            SYSTEM "appendix.xml">
  <!ENTITY testing             SYSTEM "testing.xml">
  <!ENTITY mksurfdatapl        SYSTEM "mksurfdata.pl.xml">
  <!ENTITY clmtestdriver       SYSTEM "test_driver.sh.xml">
  <!ENTITY build_date          SYSTEM "build_date.xml">
  <!ENTITY cprnc_readme        SYSTEM "cprnc_readme.xml">
  <!ENTITY nmldfntbl           SYSTEM "namelist_definition_table.xml">
  <!ENTITY nmldfltbl           SYSTEM "namelist_defaults_clm_table.xml">
  <!ENTITY hisfldtbl           SYSTEM "history_fields_table.xml">
  <!ENTITY cfgdfntbl           SYSTEM "config_definition_table.xml">

  <!-- Aliases to use -->
  <!ENTITY buildnml          "<command>build-namelist</command>">
  <!ENTITY configure         "<command>configure</command>">
  <!ENTITY ncar              "<acronym>NCAR</acronym>">
  <!ENTITY ccsm              "<acronym>CCSM</acronym>">
  <!ENTITY ccsm4             "<acronym>CCSM4.0</acronym>">
  <!ENTITY cesm              "<acronym>CESM</acronym>">
  <!ENTITY cesm1             "<acronym>CESM1.0</acronym>">
  <!ENTITY cesm101           "<acronym>CESM1.0.1</acronym>">
  <!ENTITY cesm102           "<acronym>CESM1.0.2</acronym>">
  <!ENTITY cesm103           "<acronym>CESM1.0.3</acronym>">
  <!ENTITY cesmrel           "&cesm103;">
  <!ENTITY ptclm             "<acronym>PTCLM</acronym>">
  <!ENTITY ptclm1            "<acronym>PTCLM1</acronym>">
  <!ENTITY ptclm10           "<acronym>PTCLM1.110504</acronym>">
  <!ENTITY clm               "<acronym>CLM</acronym>">
  <!ENTITY clmcn             "<acronym>CLMCN</acronym>">
  <!ENTITY clmsp             "<acronym>CLMSP</acronym>">
  <!ENTITY clmu              "<acronym>CLMU</acronym>">
  <!ENTITY clm3              "<acronym>CLM3.0</acronym>">
  <!ENTITY clm35             "<acronym>CLM3.5</acronym>">
  <!ENTITY clm4              "<acronym>CLM4</acronym>">
  <!ENTITY clm40             "<acronym>CLM4.0.00</acronym>">
  <!ENTITY clm4010           "&clm4; in &cesm101;">
  <!ENTITY clm4014           "&clm4; in &cesm102;">
  <!ENTITY clm4032           "&clm4; in &cesm103;">
  <!ENTITY clmcesm101        "&clm4010;">
  <!ENTITY clmcesm102        "&clm4014;">
  <!ENTITY clmcesm103        "&clm4032;">
  <!ENTITY clmrel            "&clm4032;">
  <!ENTITY datm              "<acronym>DATM</acronym>">
  <!ENTITY KnownBugs         "<ulink url='../KnownBugs'><filename>models/lnd/clm/doc/KnownBugs</filename></ulink>">
  <!ENTITY netcdf            "<acronym>NetCDF</acronym>">
  <!ENTITY FORTRAN           "<acronym>FORTRAN</acronym>">
  <!ENTITY FORTRAN90         "<acronym>FORTRAN-90</acronym>">
  <!ENTITY mpi               "<acronym>MPI</acronym>">
  <!ENTITY pio               "<acronym>PIO</acronym>">
  <!ENTITY omp               "<acronym>OpenMP</acronym>">
  <!ENTITY ncl               "<acronym>NCL</acronym>">
  <!ENTITY perl              "<acronym>Perl</acronym>">
  <!ENTITY xml               "<acronym>XML</acronym>">
  <!ENTITY xmlchange         "<command>xmlchange</command>">
  <!ENTITY CO2               "CO<subscript>2</subscript>">
  <!ENTITY cesmwebmodelrel   "http://www.cesm.ucar.edu/models/cesm1.0/">

  <!-- Aliases of cpl7 scripts files -->
  <!ENTITY envrun            "<filename>env_run.xml</filename>">
  <!ENTITY envbuild          "<filename>env_build.xml</filename>">
  <!ENTITY envconf           "<filename>env_conf.xml</filename>">
  <!ENTITY usernlclm         "<filename>user_nl_clm</filename>">

  <!-- Aliases of cpl7 scripts env variables to use -->
  <!ENTITY PTSMODE           "<envar>PTS_MODE</envar>">
  <!ENTITY CSMDATA           "<envar>CSMDATA</envar>">
  <!ENTITY CLMFORCECOLD      "<envar>CLM_FORCE_COLDSTART</envar>">
  <!ENTITY CLMCONFIG         "<envar>CLM_CONFIG_OPTS</envar>">
  <!ENTITY CLMBLDNML         "<envar>CLM_BLDNML_OPTS</envar>">
  <!ENTITY CLMUSECASE        "<envar>CLM_NML_USE_CASE</envar>">
  <!ENTITY CLMNAMELIST       "<envar>CLM_NAMELIST_OPTS</envar>">
  <!ENTITY CLM1PT            "<literal>CLM_PT1_NAME</literal>">
  <!ENTITY CLMQIAN           "<literal>CLM_QIAN</literal>">
  <!ENTITY CPLHIST           "<literal>CPLHIST3HrWx</literal>">
  <!ENTITY CLMUSRDAT         "<envar>CLM_USRDAT_NAME</envar>">
  <!ENTITY CLMCO2            "<envar>CLM_CO2_TYPE</envar>">
  <!ENTITY DINLOC            "<envar>DIN_LOC_ROOT</envar>">

  <!-- Aliases of cpl7 scripts env variable literal values to use -->
  <!ENTITY CLMQIAN           "<literal>CLM_QIAN</literal>">

  <!ENTITY % ISOamsa.module "INCLUDE">
  <![ %ISOamsa.module; [
  <!ENTITY % ISOamsa PUBLIC "ISO 8879:1986//ENTITIES Added Math Symbols: Arrow Relations//EN"> 
   %ISOamsa;
  <!--end of ISOamsa.module-->]]>

  <!ENTITY % ISOgrk1.module "INCLUDE">
  <![ %ISOgrk1.module; [
  <!ENTITY % ISOgrk1 PUBLIC "ISO 8879:1986//ENTITIES Greek Letters//EN"> 
   %ISOgrk1;
  <!--end of ISOgrk1.module-->]]>

]>

<book label="CLM4_UsersGuide" status="draft">

<bookinfo>
<title>&cesm; Research Tools: &clmrel; User's Guide Documentation</title>

<keywordset>
    <keyword>CESM</keyword>
    <keyword>CLM</keyword>
    <keyword>community earth system model</keyword>
    <keyword>climate</keyword>
    <keyword>climate model</keyword>
    <keyword>earth system model</keyword>
    <keyword>land surface model</keyword>
    <keyword>hydrology</keyword>
    <keyword>biogeochemistry</keyword>
    <keyword>urban model</keyword>
    <keyword>documentation</keyword>
</keywordset>

<authorgroup>

<author>
    <firstname>Erik</firstname>
    <surname>Kluzek</surname>
   <affiliation>
   <orgname>NCAR</orgname>
   </affiliation>
</author>

</authorgroup>

<abstract>
<para>
The user's guide to &clmrel; which is the active land surface model component of &cesmrel;. 
The purpose of this guide is to instruct both the novice and experienced user, as well as
&clm; developers in the use of &clm4; for land-surface climate modeling.
</para>
</abstract>

<releaseinfo>$URL: https://svn-ccsm-models.cgd.ucar.edu/clm2/branch_tags/rasm_tags/rasm19_cesm1_1_1_n01_clm4_0_54/models/lnd/clm/doc/UsersGuide/clm_ug.xml $</releaseinfo>

<date>&build_date;</date>
                     
</bookinfo>

<dedication>
<para>
Dedicated to the Land Model Working Group, winners of the 2008 &ccsm; Distinguished Achievement Award.
May you continue to collaborate together well, and continue to drive
the science of land surface modeling forward with your diligent and persistent efforts.
</para>
</dedication>

<!-- Chapters -->
&preface;
&custom;
&tools;
&adding_files;
&special_cases;
&single_point;
&ptclmdoc;
&trouble;
&testing;
&appendix;

</book>
