Update CDEPS documentation

doc/source/conf.py

@@ -74,7 +74,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en' 
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

doc/source/datm.rst

@@ -1,59 +1,75 @@
-.. _datm-datamodes:
+.. _datm:
 
 Data Atmosphere (DATM)
 ======================
 
 DATM is normally used to provide observational forcing data (or
 forcing data produced by a previous run using active components) to
-drive prognostic components. The various ways of running DATM is referred to as its mode.
+drive prognostic components. The various ways of running DATM is 
+referred to as its mode.
 
-In the case of CESM, these would be: CTSM, POP2, MOM6, POP2/CICE5-6
-and MOM6/CICE5-6.  As examples, CORE2_NYF (CORE2 normal year forcing)
-is the DATM mode used in driving POP2 and MOM6. On the other hand
-CLM_QIAN, CLMCRUNCEP, CLMGSWP3 and CLM1PT are DATM modes using
-observational data for forcing CTSM.
+In the case of CESM, the active model component would be: CTSM, 
+POP2, MOM6, POP2, CICE5-6, WW3 and MOSART. As examples, CORE2_NYF 
+(CORE2 normal year forcing) is the DATM mode used in driving 
+POP2 and MOM6. On the other hand CLM_QIAN, CLMCRUNCEP, CLMGSWP3 
+and CLM1PT are DATM modes using observational data for forcing CTSM.
 
 .. _datm-datamodes:
 
 --------------------
-datamode values
+Supported Data Modes
 --------------------
 
 DATM its own set of supported ``datamode`` values that appears in the
-``datm_in`` namelist input.  The datamode specifies what additional
+``datm_in`` namelist input. The datamode specifies what additional
 operations need to be done by DATM on *ALL* of the streams in the
-``datm.streams.xml`` file.  Each datamode value is also associated
+``datm.streams.xml`` file. Each datamode value is also associated
 with a DATM source file that carries out these operations and these are
 listed in parentheses next to the mode name.
 
 CLMNCEP (``datm_datamode_clmncep_mod.F90``)
   - In conjunction with NCEP climatological atmosphere data, provides
-    the atmosphere forcing favored by the Land Model Working Group when
-    coupling an active land model with observed atmospheric
+    the atmosphere forcing favored by the CESM Land Model Working Group
+    when coupling an active land model with observed atmospheric
     forcing. This mode replicates code previously found in CLM (circa
     2005), before the LMWG started using the CIME coupling
-    infrastructure and data models to do active-land-only simulations."
+    infrastructure and data models to do active-land-only simulations.
 
 CORE2_NYF (``datm_datamode_core2_mod.F90``)
-  - Coordinated Ocean-ice Reference Experiments (CORE) Version 2 Normal Year Forcing."
+  - Coordinated Ocean-ice Reference Experiments (CORE) Version 2 
+    Normalst_aquap[1-10]Year Forcing.
 
 CORE2_IAF (``datm_datamode_core2_mod.F90``)
   - In conjunction with CORE Version 2 atmospheric forcing data,
     provides the atmosphere forcing when coupling an active ocean model
     with observed atmospheric forcing. This mode and associated data
-    sets implement the CORE-IAF Version 2 forcing data, as developed by
-    Large and Yeager (2008) at NCAR.  Note that CORE2_NYF and CORE2_IAF
+    sets implement the `CORE-IAF` Version 2 forcing data, as developed by
+    Large and Yeager (2008) at NCAR. Note that `CORE2_NYF` and `CORE2_IAF`
     work exactly the same way.
 
 CORE_IAF_JRA (``datm_datamode_jra_mod.F90``)
   - In conjunction with JRA-55 Project, provides the atmosphere forcing
     when coupling an active ocean model with observed atmospheric
     forcing. This mode and associated data sets implement the JRA-55
-    v1.3 forcing data."
+    v1.3 forcing data.
 
 ERA5 (``datm_datamode_era5_mod.F90``)
-  - Fifth generation ECMWF atmospheric reanalysis of the global climate
-
+  - Fifth generation ECMWF atmospheric reanalysis of the global climate.
+    This mode mainly used by NOAA's UFS Weather model to support
+    different appalications such as HYCOM ocean and NOAHMP land components.
+
+.. note::
+  Due to high temporal and spatial resoultion of ERA5 dataset, only 2019
+  data is staged on NCAR's Cheyenne platform under 
+  `$CESMDATAROOT/inputdata/atm/datm7/ERA5`
+
+.. note::
+  In addition to the exiting DATM data modes, `CDEPS fork <https://github.com/NOAA-EMC/CDEPS>`_ 
+  used by `NOAA's UFS Weather Model <https://github.com/ufs-community/ufs-weather-model>`_ 
+  also includes additional data modes such as CFSR, GEFS and GFS. These data modes are not 
+  merged with the NCAR's authoritative repository yet but it tested under UFS Weather
+  model.
+
 .. _datm-cime-vars:
 
 ---------------------------------------
@@ -63,17 +79,17 @@ Configuring DATM from CIME
 If CDEPS is coupled to the CIME-CCS then the CIME ``$CASEMROOT`` xml
 variable ``DATM_MODE`` sets the collection of streams the streams that
 are associated with DATM and also sets the datm namelist variable
-``datamode`` in the file ``datm_in``.  The following are the supported
+``datamode`` in the file ``datm_in``. The following are the supported
 DATM ``datamode`` values, as defined in the file
 ``namelist_definition_datm.xml``.
 
 The following table describes the valid values of ``DATM_MODE``
 (defined in the ``config_component.xml`` file for DATM), and how they
 relate to the associated input streams and the ``datamode`` namelist
-variable.  CIME will generate a value of ``DATM_MODE`` based on the
+variable. CIME will generate a value of ``DATM_MODE`` based on the
 compset.
 
-CORE2_NYF,
+CORE2_NYF
    - CORE2 normal year forcing (CESM C ang G compsets)
    - streams: CORE2_NYF.GISS,CORE2_NYF.GXGXS,CORE2_NYF.NCEP
    - datamode: CORE2_NYF
@@ -83,14 +99,14 @@ CORE2_IAF
    - streams: CORE2_IAF.GCGCS.PREC,CORE2_IAF.GISS.LWDN,
      CORE2_IAF.GISS.SWDN,CORE2_IAF.GISS.SWUP,
      CORE2_IAF.NCEP.DN10,CORE2_IAF.NCEP.Q_10,
-     CORE2_IAF.NCEP.SLP_,CORE2_IAF.NCEP.T_10,CORE2_IAF.NCEP.U_10,
+     CORE2_IAF.NCEP.SLP\_,CORE2_IAF.NCEP.T_10,CORE2_IAF.NCEP.U_10,
      CORE2_IAF.NCEP.V_10,CORE2_IAF.CORE2.ArcFactor
    - datamode: CORE2_IAF
 
 CORE_IAF_JRA
    - JRA-55 intra-annual year forcing (CESM C ang G compsets)
    - streams: CORE_IAF_JRA.PREC,CORE_IAF_JRA.LWDN,CORE_IAF_JRA.SWDN,
-     CORE_IAF_JRA.Q_10,CORE_IAF_JRA.SLP_,CORE_IAF_JRA.T_10,CORE_IAF_JRA.U_10,
+     CORE_IAF_JRA.Q_10,CORE_IAF_JRA.SLP\_,CORE_IAF_JRA.T_10,CORE_IAF_JRA.U_10,
      CORE_IAF_JRA.V_10,CORE_IAF_JRA.CORE2.ArcFactor
    - datamode: CORE_IAF_JRA
 
@@ -119,6 +135,11 @@ CLM1PT
    - streams: CLM1PT.$ATM_GRID
    - datamode: CLMNCEP
 
+ERA5
+   - ERA5 atm input data (not used any compset)
+   - streams: ERA5_HOURLY
+   - datamode: ERA5
+
 CPLHIST
    - user generated forcing data from using coupler history files
      used to spinup relevant prognostic components (for CESM this is CLM, POP and CISM)