Merge pull request #201 from JulieSchramm/features/ccpp_tech_v3.0

Features/ccpp tech v3.0

doc/CCPPtechnical/source/BuildingRunningHostModels.rst

@@ -460,4 +460,4 @@ Compatibility between the Code Base, the SDF, and the Namelist in the UFS Atmosp
 
 The variable ``suite_name`` within the ``namelist.input`` file used in the UFS Atmosphere determines which suite will be employed at run time (e.g., ``suite_name=FV3_GFS_v15``). It is the user’s responsibility to ascertain that the other variables in ``namelist.input`` are compatible with the chosen suite. When runs are executed using the RT framework described in the preceding sections, compatibility is assured. For new experiments, users are responsible for modifying the two files (``SDF`` and ``namelist.input``) consistently, since limited checks are in place.
 
-Information about the UFS Atmosphere physics namelist can be found with the CCPP Scientific Documentation at xxx (**!!!LB: Update for release**).
+Information about the UFS Atmosphere physics namelist can be found with the CCPP Scientific Documentation at https://dtcenter.org/GMTB/v3.0/sci_doc/.

doc/CCPPtechnical/source/Overview.rst

@@ -4,6 +4,18 @@
 CCPP Overview
 *************************
 
+.. warning:: The information in this document is up to date with the CCPP and GMTB SCM v3 public
+   release as of June 17, 2019. If you are a developer looking for more current information, please
+   obtain and build the up-to-date Technical Documentation from the master branch of the ccpp-framework
+   code repository:
+
+    .. code-block:: console
+
+       git clone https://github.com/NCAR/ccpp-framework
+       cd ccpp-framework/doc/CCPPtechnical   
+       make html
+       make latexpdf
+
 Ideas for this project originated within the Earth System Prediction Capability (ESPC)
 physics interoperability group, which has representatives from the US National Center
 for Atmospheric Research (NCAR), the Navy, National Oceanic and Atmospheric Administration
@@ -136,7 +148,7 @@ future operational implementations. The GFS_v15plus suite is the same as the GFS
 except using the Turbulent Kinetic Energy (TKE)-based EDMF PBL scheme. The Climate Process
 Team (CPT) v0 suite (CPT_v0) uses the aerosol-aware (aa) Morrison-Gettelman 3 (MG3) microphysics
 scheme and Chikira-Sugiyama convection scheme with Arakawa-Wu extension (CSAW). The NOAA Global
-Systems Division (GSD) v0 suite (GFS_v0) includes aaThompson microphysics,
+Systems Division (GSD) v0 suite (GSD_v0) includes aaThompson microphysics,
 Mellor-Yamada-Nakanishi-Niino (MYNN) PBL and shallow convection, Grell-Freitas (GF) deep
 convection schemes, and the Rapid Update Cycle (RUC) LSM.*
 

doc/CCPPtechnical/source/ScientificDocRules.inc

@@ -28,7 +28,7 @@ documented schemes.
 Reviewing the documentation for CCPP parameterizations is a good way of getting
 started in writing documentation for a new scheme. The CCPP Scientific
 Documentation can be converted to html format 
-(see https://dtcenter.org/gmtb/users/ccpp/docs/sci_doc_v2/).
+(see https://dtcenter.org/GMTB/v3.0/sci_doc/).
 
 Doxygen Comments and Commands
 -----------------------------
@@ -145,7 +145,7 @@ as defined in
    - \ref GFS_CALPRECIPTYPE
    - \ref STOCHY_PHYS
 
-The HTML result is `here <https://dtcenter.org/gmtb/users/ccpp/docs/sci_doc_v2/subpage_overview.html>`_.
+The HTML result is `here <https://dtcenter.org/GMTB/v3.0/sci_doc/GFS_v15_page.html>`_.
 You can see that the ``“-”`` signs before ``“@ref”`` generate a list with bullets.
 Doxygen command ``“\\c”`` displays its argument using a typewriter font.
 
@@ -183,7 +183,6 @@ sense to choose label names that refer to their context.
    */
 
 
-The HTML result is `here <https://dtcenter.org/gmtb/users/ccpp/docs/sci_doc_v2/GFS_ZHAOC.html>`__.
 The physics scheme page will often describe the following:
 
 1. Description section (``“\\section”``), which usually includes:
@@ -237,7 +236,7 @@ is used to aggregate all code related to that scheme, even when it is in separat
 files. Since doxygen cannot know which files or subroutines belong to each physics
 scheme, each relevant subroutine must be tagged with the module name. This allows
 doxygen to understand your modularized design and generate the documentation accordingly.
-`Here <https://dtcenter.org/gmtb/users/ccpp/docs/sci_doc_v2/modules.html>`__ 
+`Here <https://dtcenter.org/GMTB/v3.0/sci_doc/modules.html>`_
 is a list of module list defined in CCPP.
 
 A module is defined using:

doc/CCPPtechnical/source/conf.py

@@ -21,7 +21,7 @@
 
 project = 'CCPP Technical'
 copyright = '2019 '
-author = ' '
+author = 'J. Schramm, L. Bernardet, L. Carson, \\\ G. Firl, D. Heinzeller, L. Pan, and M. Zhang'
 
 # The short X.Y version
 version = 'v3.0.0'
@@ -123,6 +123,7 @@ def setup(app):
 
 # -- Options for LaTeX output ------------------------------------------------
 
+latex_engine = 'pdflatex'
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #
@@ -139,14 +140,15 @@ def setup(app):
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
+      'maketitle': r'\newcommand\sphinxbackoftitlepage{For referencing this document please use: \newline \break Schramm, J., L. Bernardet, L. Carson, G. Firl, D. Heinzeller, L. Pan, and M. Zhang, 2019. CCPP Technical Documentation Release v3.0.0. 91pp. Available at https://dtcenter.org/GMTB/v3.0/ccpp\_tech\_guide.pdf.}\sphinxmaketitle'
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc, 'CCPPtechnical.tex', 'CCPP Technical Documentation',
-     ' ', 'manual'),
+     author,'manual'),
 ]