<?xml version="1.0"?>

<entry_id version="3.0">
  <!-- modifier_mode allowed values are
       '*' 0 or more modifiers (default)
       '1' exactly 1 modifier
       '?' 0 or 1 modifiers
       '+' 1 or more modifiers

       This file may have atm desc entries.
  -->
  <description modifier_mode="1">
    <desc atm="DATM[%QIA][%WISOQIA][%CRU][%CRUv7][%GSWP3v1][%ICONEXAMPLE][%ICONhistorical][%ICONCNRMSSP370][%ICONNORESMhistorical][%ICONNORESMSSP370][%HCLIMhistorical][%HCLIMCNRMhistorical][%HCLIMNORESMhistorical][%MOSARTTEST][%NLDAS2][%CPLHIST][%1PT][%NYF][%IAF][%JRA][%JRA-1p4-2018][%JRA-RYF8485][%JRA-RYF9091][%JRA-RYF0304][%SIMPLE]"> Data driven ATM </desc>
    <desc option="QIA"> QIAN data set </desc>
    <desc option="WISOQIA">QIAN with water isotopes</desc>
    <desc option="CRU"> CRUNCEP data set </desc>
    <desc option="CRUv7"> CLM CRU NCEP v7 data set </desc>
    <desc option="GSWP3v1"> GSWP3v1 data set </desc>
    <desc option="ICONEXAMPLE"> ICON example data set </desc>
    <desc option="ICONhistorical"> ICON+CNRM-ESM2-1 historical (1985-2014) </desc>
    <desc option="ICONCNRMSSP370"> ICON+CNRM-ESM2-1 SSP370 (2015-2099) </desc>
    <desc option="ICONNORESMhistorical"> ICON+NorESM2-MM historical (1985-2014) </desc>
    <desc option="ICONNORESMSSP370"> ICON+NorESM2-MM SSP370 (2015-2099) </desc>
    <desc option="HCLIMhistorical"> HCLIM historical (1985-2014) </desc>
    <desc option="HCLIMCNRMhistorical"> HCLIM+CNRM-ESM2-1 historical (1985-2014) </desc>
    <desc option="HCLIMNORESMhistorical"> HCLIM+NorESM2-MM historical (1985-2014) </desc>
    <desc option="NLDAS2"> NLDAS2 regional 0.125 degree data set over the U.S. (25-53N, 235-293E). WARNING: Garbage data will be produced for runs extending beyond this regional domain. </desc>
    <desc option="CPLHIST"> Coupler hist data set (in this mode, it is strongly recommended that the model domain and the coupler history forcing are on the same domain)</desc>
    <desc option="1PT">single point tower site data set </desc>
    <desc option="NYF">COREv2 normal year forcing</desc>
    <desc option="IAF">COREv2 interannual forcing</desc>
    <desc option="JRA">interannual JRA55 forcing</desc>
    <desc option="JRA-1p4-2018">interannual JRA55 forcing, v1.4, through 2018</desc>
    <desc option="JRA-RYF8485"> JRA55 Repeat Year Forcing v1.3 1984-1985</desc>
    <desc option="JRA-RYF9091"> JRA55 Repeat Year Forcing v1.3 1990-1991</desc>
    <desc option="JRA-RYF0304"> JRA55 Repeat Year Forcing v1.3 2003-2004</desc>
    <desc option="ERA5">ERA5 interannual forcing</desc>
    <desc option="SIMPLE">Namelist-configurable, constant datm forcing for simple experiments</desc>
  </description>

  <entry id="COMP_ATM">
    <type>char</type>
    <valid_values>datm</valid_values>
    <default_value>datm</default_value>
    <group>case_comp</group>
    <file>env_case.xml</file>
    <desc>Name of atmospheric component</desc>
  </entry>

  <entry id="DATM_MODE">
    <type>char</type>
    <valid_values>CORE2_NYF,CORE2_IAF,CLM_QIAN,CLM_QIAN_WISO,1PT,CLMCRUNCEP,CLMCRUNCEPv7,CLMGSWP3v1,CLMICONEXAMPLE,CLMICONhistorical,CLMICONCNRMSSP370,CLMICONNORESMhistorical,CLMICONNORESMSSP370,CLMHCLIMhistorical,CLMHCLIMCNRMhistorical,CLMHCLIMNORESMhistorical,CLMNLDAS2,CPLHIST,CORE_IAF_JRA,CORE_IAF_JRA_1p4_2018,ERA5,SIMPLE</valid_values>
    <default_value>CORE2_NYF</default_value>
    <group>run_component_datm</group>
    <file>env_run.xml</file>
    <desc>Mode for data atmosphere component.
      CORE2_NYF (CORE2 normal year forcing) are modes used in forcing prognostic ocean/sea-ice components.
      CLMCRUNCEPv7, CLMGSWP3v1, CLMICONEXAMPLE, CLMICONhistorical, CLMICONCNRMSSP370, CLMICONNORESMhistorical, CLMICONNORESMSSP370, CLMHCLIMhistorical, CLMHCLIMCNRMhistorical, CLMHCLIMNORESMhistorical, CLMNLDAS2 and 1PT are modes using observational data for forcing prognostic land components.
      WARNING for CLMNLDAS2: This is a regional forcing dataset over the U.S. (25-53N, 235-293E). Garbage data will be produced for runs extending beyond this regional domain. </desc>
    <values match="last">
      <value compset="DATM%NYF">CORE2_NYF</value>
      <value compset="DATM%IAF">CORE2_IAF</value>
      <value compset="DATM%JRA">CORE_IAF_JRA</value>
      <value compset="DATM%JRA-1p4-2018">CORE_IAF_JRA_1p4_2018</value>
      <value compset="DATM%QIA">CLM_QIAN</value>
      <value compset="DATM%WISOQIA">CLM_QIAN_WISO</value>
      <value compset="DATM%CRUv7">CLMCRUNCEPv7</value>
      <value compset="DATM%GSWP3v1">CLMGSWP3v1</value>
      <value compset="DATM%ICONEXAMPLE">CLMICONEXAMPLE</value>
      <value compset="DATM%ICONhistorical">CLMICONhistorical</value>
      <value compset="DATM%ICONCNRMSSP370">CLMICONCNRMSSP370</value>
      <value compset="DATM%ICONNORESMhistorical">CLMICONNORESMhistorical</value>
      <value compset="DATM%ICONNORESMSSP370">CLMICONNORESMSSP370</value>
      <value compset="DATM%HCLIMhistorical">CLMHCLIMhistorical</value>
      <value compset="DATM%HCLIMCNRMhistorical">CLMHCLIMCNRMhistorical</value>
      <value compset="DATM%HCLIMNORESMhistorical">CLMHCLIMNORESMhistorical</value>
      <value compset="DATM%NLDAS2">CLMNLDAS2</value>
      <value compset="DATM%1PT">1PT</value>
      <value compset="DATM%ERA5">ERA5</value>
      <value compset="DATM%CPLHIST">CPLHIST</value>
      <value compset="DATM%SIMPLE">SIMPLE</value>
    </values>
  </entry>

  <entry id="DATM_PRESAERO">
    <type>char</type>
    <valid_values>none,clim_1850,clim_2000,clim_2010,hist,SSP1-1.9,SSP1-2.6,SSP2-4.5,SSP3-7.0,SSP4-3.4,SSP4-6.0,SSP5-3.4,SSP5-8.5,cplhist</valid_values>
    <default_value>clim_2000</default_value>
    <values match="last">
      <value compset="^1850_"   >clim_1850</value>
      <value compset="^2000_"   >clim_2000</value>
      <value compset="^2010_"   >clim_2010</value>
      <value compset="^SSP119_" >SSP1-1.9</value>
      <value compset="^SSP126_" >SSP1-2.6</value>
      <value compset="^SSP245_" >SSP2-4.5</value>
      <value compset="^SSP370_" >SSP3-7.0</value>
      <value compset="^SSP434_" >SSP4-3.4</value>
      <value compset="^SSP460_" >SSP4-6.0</value>
      <value compset="^SSP534_" >SSP5-3.4</value>
      <value compset="^SSP585_" >SSP5-8.5</value>
      <value compset="^HIST_"   >hist</value>
      <value compset="^20TR_"   >hist</value>
      <value compset="_DATM%CPLHIST">cplhist</value>
      <value compset="_DATM.*_DICE.*_DOCN.*_DROF">none</value>
    </values>
    <group>run_component_datm</group>
    <file>env_run.xml</file>
    <desc>DATM prescribed aerosol forcing</desc>
  </entry>

  <entry id="DATM_PRESNDEP">
    <type>char</type>
    <valid_values>none,clim_1850,clim_2000,clim_2010,hist,SSP1-2.6,SSP2-4.5,SSP3-7.0,SSP5-3.4,SSP5-8.5,cplhist</valid_values>
    <default_value>clim_2000</default_value>
    <values match="last">
      <value compset="^1850_"   >clim_1850</value>
      <value compset="^2000_"   >clim_2000</value>
      <value compset="^2010_"   >clim_2010</value>
      <value compset="^SSP126_" >SSP1-2.6</value>
      <value compset="^SSP245_" >SSP2-4.5</value>
      <value compset="^SSP370_" >SSP3-7.0</value>
      <value compset="^SSP585_" >SSP5-8.5</value>
      <value compset="^HIST_"   >hist</value>
      <value compset="^20TR_"   >hist</value>
      <value compset="_DATM%CPLHIST">cplhist</value>
      <value compset="_DATM.*_DICE.*_DOCN.*_DROF">none</value>
    </values>
    <group>run_component_datm</group>
    <file>env_run.xml</file>
    <desc>DATM prescribed nitrogen deposition forcing</desc>
  </entry>

  <entry id="DATM_PRESO3">
    <type>char</type>
    <valid_values>none,clim_1850,clim_2000,clim_2010,hist,SSP2-4.5,SSP3-7.0,SSP5-8.5</valid_values>
    <default_value>clim_2000</default_value>
    <values match="last">
      <value compset="^1850_"   >clim_1850</value>
      <value compset="^2000_"   >clim_2000</value>
      <value compset="^2010_"   >clim_2010</value>
      <value compset="^SSP245_" >SSP2-4.5</value>
      <value compset="^SSP370_" >SSP3-7.0</value>
      <value compset="^SSP585_" >SSP5-8.5</value>
      <value compset="^HIST_"   >hist</value>
      <value compset="^20TR_"   >hist</value>
      <!-- Only needed for compsets with active land; only in DATM CLMNCEP mode -->
      <value compset="_SLND">none</value>
      <value compset="_DLND">none</value>
    </values>
    <group>run_component_datm</group>
    <file>env_run.xml</file>
    <desc>DATM prescribed ozone forcing</desc>
  </entry>

  <entry id="DATM_TOPO">
    <type>char</type>
    <valid_values>none,observed,cplhist</valid_values>
    <default_value>observed</default_value>
    <values match="last">
      <!-- Only needed for compsets with active land; for other compsets, turn it off -->
      <value compset="_SLND">none</value>
      <value compset="_DLND">none</value>
      <value compset="_DATM%CPLHIST">cplhist</value>
    </values>
    <group>run_component_datm</group>
    <file>env_run.xml</file>
    <desc>DATM surface topography forcing</desc>
  </entry>

  <entry id="DATM_CO2_TSERIES">
    <type>char</type>
    <valid_values>none,20tr,20tr.latbnd,omip.iaf,omip.jra,SSP1-1.9,SSP1-2.6,SSP2-4.5,SSP3-7.0,SSP4-3.4,SSP4-6.0,SSP5-3.4,SSP5-8.5,SSP1-1.9.latbnd,SSP1-2.6.latbnd,SSP2-4.5.latbnd,SSP3-7.0.latbnd,SSP4-3.4.latbnd,SSP4-6.0.latbnd,SSP5-3.4.latbnd,SSP5-8.5.latbnd</valid_values>
    <default_value>none</default_value>
    <values match="last">
      <value compset="^SSP119_">SSP1-1.9</value>
      <value compset="^SSP126_">SSP1-2.6</value>
      <value compset="^SSP245_">SSP2-4.5</value>
      <value compset="^SSP370_">SSP3-7.0</value>
      <value compset="^SSP434_">SSP4-3.4</value>
      <value compset="^SSP460_">SSP4-6.0</value>
      <value compset="^SSP534_">SSP5-3.4</value>
      <value compset="^SSP585_">SSP5-8.5</value>
      <value compset="^HIST"   >20tr</value>
      <value compset="^20TR"   >20tr</value>
      <value compset="^OMIP_DATM%IAF.*_POP2%[^_]*ECO">omip.iaf</value>
      <value compset="^OMIP_DATM%JRA.*_POP2%[^_]*ECO">omip.jra</value>
    </values>
    <group>run_component_datm</group>
    <file>env_run.xml</file>
    <desc>DATM CO2 time series</desc>
  </entry>

  <entry id="DATM_CPLHIST_DOMAIN_FILE">
    <type>char</type>
    <valid_values></valid_values>
    <default_value>null</default_value>
    <group>run_component_datm</group>
    <file>env_run.xml</file>
    <desc>
      Full pathname for domain file for datm when DATM_MODE is
      CPLHIST, NOTE: if this is set to 'null' (the default), then
      domain information is read in from the first coupler history
      file in the target stream and it is assumed that the first
      coupler stream file that is pointed to contains the domain
      information for that stream.
    </desc>
  </entry>

  <entry id="DATM_CPLHIST_DIR">
    <type>char</type>
    <valid_values></valid_values>
    <default_value>UNSET</default_value>
    <group>run_component_datm</group>
    <file>env_run.xml</file>
    <desc>directory for coupler history data mode (only used for when DATM_MODE is CPLHIST)</desc>
  </entry>

  <entry id="DATM_CPLHIST_CASE">
    <type>char</type>
    <valid_values></valid_values>
    <default_value>UNSET</default_value>
    <group>run_component_datm</group>
    <file>env_run.xml</file>
    <desc>case name used to determine stream filenames when DATM_MODE is CPLHIST</desc>
  </entry>

  <entry id="DATM_YR_ALIGN">
    <type>integer</type>
    <valid_values></valid_values>
    <default_value>1</default_value>
    <values match="last">
      <value compset="2000.*_DATM%1PT">$DATM_YR_START</value>
      <value compset="1850.*_DATM%QIA">1</value>
      <value compset="1850.*_DATM%CRU">1</value>
      <value compset="1850.*_DATM%GSW">1</value>
      <value compset="HIST.*_DATM%QIA">1895</value>
      <value compset="HIST.*_DATM%CRU">1901</value>
      <value compset="HIST.*_DATM%GSW">1901</value>
      <value compset="HIST.*_DATM%NLDAS2">$DATM_YR_START</value>
      <value compset="20TR.*_DATM%QIA">1895</value>
      <value compset="20TR.*_DATM%CRU">1901</value>
      <value compset="20TR.*_DATM%GSW">1901</value>
      <value compset="SSP.*_DATM%QIA">$DATM_YR_START</value>
      <value compset="SSP.*_DATM%CRU">$DATM_YR_START</value>
      <value compset="SSP.*_DATM%GSW">$DATM_YR_START</value>
      <value compset="1850.*_DATM%CRU">1</value>
      <value compset="1850.*_DATM%GSW">1</value>
      <value compset="2000.*_DATM">$DATM_YR_START</value>
      <value compset="2003.*_DATM">$DATM_YR_START</value>
      <value compset="2010.*_DATM">$DATM_YR_START</value>
      <value compset="4804.*_DATM">$DATM_YR_START</value>
    </values>
    <group>run_component_datm</group>
    <file>env_run.xml</file>
    <desc>
      Simulation year corresponding to DATM_YR_START. A common usage
      is to set this to RUN_STARTDATE. With this setting, the forcing
      in the first year of the run will be the forcing of year
      DATM_YR_START. Another use case is to align the calendar
      of transient forcing with the model calendar. For example,
      setting DATM_YR_ALIGN=DATM_YR_START will lead to
      the forcing calendar being the same as the model calendar. The
      forcing for a given model year would be the forcing of the same
      year. This would be appropriate in transient runs where the
      model calendar is setup to span the same year range as the
      forcing data.
    </desc>
  </entry>

  <entry id="DATM_YR_START">
    <type>integer</type>
    <valid_values></valid_values>
    <default_value>2004</default_value>
    <values match="last">
      <value compset="2000.*_DATM%1PT" grid="CLM_USRDAT"       >2018</value>
      <value compset="2000.*_DATM%1PT" grid="1x1_mexicocityMEX">1993</value>
      <value compset="2000.*_DATM%1PT" grid="1x1_vancouverCAN" >1992</value>
      <value compset="2000.*_DATM%1PT" grid="1x1_urbanc_alpha" >1</value>
      <value compset="1850.*_DATM%QIA">1948</value>
      <value compset="1850.*_DATM%CRU">1901</value>
      <value compset="1850.*_DATM%GSW">1901</value>
      <value compset="1850.*_DATM%NLDAS2">0</value>  <!-- Unsupported -->
      <value compset="2000.*_DATM%WISOQIA">2000</value>
      <value compset="2000.*_DATM%QIA">1972</value>
      <value compset="HIST.*_DATM%QIA">1948</value>
      <value compset="HIST.*_DATM%CRU">1901</value>
      <value compset="HIST.*_DATM%GSW">1901</value>
      <value compset="HIST.*_DATM%NLDAS2">0</value>  <!-- Unsupported -->
      <value compset="20TR.*_DATM%QIA">1948</value>
      <value compset="20TR.*_DATM%CRU">1901</value>
      <value compset="20TR.*_DATM%GSW">1901</value>
      <value compset="20TR.*_DATM%NLDAS2">0</value>  <!-- Unsupported -->
      <value compset="4804.*_DATM%QIA">1948</value>
      <value compset="SSP.*_DATM%QIA" >1995</value>
      <value compset="SSP.*_DATM%CRU" >2001</value>
      <value compset="SSP.*_DATM%GSW" >2001</value>
      <value compset="2003.*_DATM%QIA.*_TEST">2002</value>
      <value compset="1850.*_DATM%CRU">1901</value>
      <value compset="2000.*_DATM%CRU">1991</value>
      <value compset="2003.*_DATM%CRU">2002</value>
      <value compset="2010.*_DATM%CRU">2005</value>
      <value compset="1850.*_DATM%GSW">1901</value>
      <value compset="2000.*_DATM%GSW">1991</value>
      <value compset="2010.*_DATM%GSW">2005</value>
      <value compset="2003.*_DATM%GSW">2002</value>
      <value compset="2000.*_DATM%NLDAS2">1980</value>
      <value compset="2010.*_DATM%NLDAS2">2005</value>
      <value compset="2003.*_DATM%NLDAS2">2002</value>
    </values>
    <group>run_component_datm</group>
    <file>env_run.xml</file>
    <desc>starting year to loop data over</desc>
  </entry>

  <entry id="DATM_YR_END">
    <type>integer</type>
    <valid_values></valid_values>
    <default_value>2004</default_value>
    <values match="last">
      <value   compset="2000.*_DATM%1PT" grid="CLM_USRDAT"       >2019</value>
      <value   compset="2000.*_DATM%1PT" grid="1x1_mexicocityMEX">1993</value>
      <value   compset="2000.*_DATM%1PT" grid="1x1_vancouverCAN" >1992</value>
      <value   compset="2000.*_DATM%1PT" grid="1x1_urbanc_alpha" >2</value>
      <value   compset="1850.*_DATM%QIA">1972</value>
      <value   compset="1850.*_DATM%CRU">1920</value>
      <value   compset="1850.*_DATM%GSW">1920</value>
      <value   compset="1850.*_DATM%NLDAS2">-1</value>  <!-- Unsupported -->
      <value   compset="2000.*_DATM%WISOQIA">2004</value>
      <value   compset="2000.*_DATM%QIA">2004</value>
      <value   compset="HIST.*_DATM%QIA">1972</value>
      <value   compset="HIST.*_DATM%CRU">1920</value>
      <value   compset="HIST.*_DATM%GSW">1920</value>
      <value   compset="HIST.*_DATM%NLDAS2">-1</value>  <!-- Unsupported -->
      <value   compset="20TR.*_DATM%QIA">1972</value>
      <value   compset="20TR.*_DATM%CRU">1920</value>
      <value   compset="20TR.*_DATM%GSW">1920</value>
      <value   compset="20TR.*_DATM%NLDAS2">-1</value>  <!-- Unsupported -->
      <value   compset="4804.*_DATM%QIA">2004</value>
      <value   compset="SSP.*_DATM%QIA">2004</value>
      <value   compset="SSP.*_DATM%CRU">2016</value>
      <value   compset="SSP.*_DATM%GSW">2014</value>
      <value   compset="2003.*_DATM%QIA.*_TEST">2003</value>
      <value   compset="1850.*_DATM%CRU">1920</value>
      <value   compset="2000.*_DATM%CRU">2010</value>
      <value   compset="2003.*_DATM%CRU">2003</value>
      <value   compset="2010.*_DATM%CRU">2014</value>
      <value   compset="1850.*_DATM%GSW">1920</value>
      <value   compset="2000.*_DATM%GSW">2010</value>
      <value   compset="2010.*_DATM%GSW">2014</value>
      <value   compset="2003.*_DATM%GSW">2003</value>
      <value   compset="2000.*_DATM%NLDAS2">2018</value>
      <value   compset="2010.*_DATM%NLDAS2">2014</value>
      <value   compset="2003.*_DATM%NLDAS2">2003</value>
    </values>
    <group>run_component_datm</group>
    <file>env_run.xml</file>
    <desc>ending year to loop data over</desc>
  </entry>

  <entry id="DATM_SKIP_RESTART_READ">
    <type>logical</type>
    <valid_values>TRUE,FALSE</valid_values>
    <default_value>FALSE</default_value>
    <group>run_component_datm</group>
    <file>env_run.xml</file>
    <desc> If set to true, than datm restarts will not be read on a continuation run.
      This capability is used, for example, in CTSM spinup runs.
    </desc>
  </entry>

  <help>
    =========================================
    DATM naming conventions in compset name
    =========================================
  </help>

</entry_id>
