Merge pull request #40 from ligiabernardet/usersguide

Updates to the title of users guide so it is a guide to Bundle CCPP plus SCM (not just SCM or just CCPP).

Miscellaneous updates throughout Users Guide.

doc/UsersGuide/SCM/chap_install.tex

@@ -5,7 +5,7 @@ \chapter{Software Installation}
 
 
 \section{Overview}
-The following components are included in this release bundle:
+The following components are included in this release:
 
 \begin{itemize}
 	\item CCPP physics
@@ -15,7 +15,7 @@ \section{Overview}
 
 
 This chapter provides instructions for obtaining and compiling 
-the GMTB single column model (SCM). The SCM code calls CCPP-compliant
+the GMTB SCM. The SCM code calls CCPP-compliant
 physics schemes through the CCPP framework code. As such, it requires the
 CCPP framework code and physics code, both of which are included as 
 subdirectories within the SCM code. This package can be considered a simple example
@@ -43,24 +43,20 @@ \section{Obtaining Code}
 
 If you would like to contribute as a developer to this project, please see the Developers Guide at:\\
 
-\url{https://dtcenter.org/gmtb/users/ccpp/index.php}
+\url{https://dtcenter.org/gmtb/users/ccpp/developers/index.php}
 
 
 \section{System Requirements, Libraries, and Tools}
 \label{section: systemrequirements}
 
 The source code for the SCM and CCPP component is in the form
-of programs written in FORTRAN, FORTRAN 90, and C. In addition, there
-are several Python scripts used during the build. 
-
-In addition, the I/O relies on the netCDF
+of programs written in FORTRAN, FORTRAN 90, and C. In addition, the I/O relies on the netCDF
 libraries. Beyond the standard scripts, the build system relies
 on use of the Python scripting language, along with cmake, GNU make and date.
 
-The basic requirements for building and running the HWRF system are
+The basic requirements for building and running the CCPP and SCM bundle are
 listed below:
 
-
 \begin{itemize}
 	\item FORTRAN 90+ compiler
 	\item C compiler
@@ -92,13 +88,14 @@ \section{System Requirements, Libraries, and Tools}
 
 
 \subsection{Compilers}
-The CCPP and Single Column Model  has been tested on a variety of
+The CCPP and SCM have been tested on a variety of
 computing platforms. Currently the CCPP system is actively supported
 on Linux and MacOS computing platforms using the Intel, PGI or GNU Fortran
 compilers. Unforeseen build issues may occur when using older
 compiler versions. Typically the best results come from using the
 most recent version of a compiler. The "Known Issues" section of the
-community website provides notes regarding compiler support and known issues.
+community website (\url{https://dtcenter.org/gmtb/users/ccpp/support/CCPP_KnownIssues.php}) provides notes regarding compiler support and known issues.
+
 
 
 \section{Compiling SCM with CCPP}

doc/UsersGuide/SCM/chap_intro.tex

@@ -2,8 +2,8 @@ \chapter{Introduction}
 \setlength{\parskip}{12pt}
 \section{CCPP Overview}
 
-The Common Community Physics Package (CCPP) is a library of physical parameterizations for atmospheric numerical models. It is distributed with a driver that enables its use with any host application. In this release, the CCPP has been bundled with the Global Model Test Bed Single Column Model (SCM) and contains all the physical parameterizations used in the operational NOAA Global Forecast System (GFS) implemented operationally in June 2017.
+The Common Community Physics Package (CCPP) is a library of physical parameterizations for atmospheric numerical models. It is distributed with a driver that enables its use with any host application. In this release, the CCPP has been bundled with the Global Model Test Bed Single Column Model (SCM) and contains all the physical parameterizations used in the operational NOAA Global Forecast System (GFS) implemented operationally in July 2017.
 
-This Quick Start Users Guide provides basic instructions for using the GMTB SCM.  Please refer to the release web page for further documentation and user notes.
+This Quick Start Users' Guide provides basic instructions for using the CCPP with the GMTB SCM.  Please refer to the release web page for further documentation and user notes.
 
-\url{https://dtcenter.org/gmtb/users/ccpp/index.php}
+\url{https://dtcenter.org/gmtb/users/ccpp/index.php}

doc/UsersGuide/SCM/chap_run.tex

@@ -5,8 +5,9 @@ \chapter{Running SCM}
 
 \section{A sample test case}
 
-The CCPP uses a run-time, dynamically loaded physics library to select physics suites at runtime.  To utilize a given library (of CCPP-complient!) physics parameterizations, first append the path to the physics suite libraries that you need
-within the CCPP. For example, for the GMTB GFS physics suite, use:
+The CCPP uses a runtime, dynamically loaded physics library from which physical parameterizations can be selected at runtime.  To utilize a given library (of CCPP-compliant!) physics parameterizations, first append the path to the physics suite libraries that you need
+within the CCPP. For example, for the library that contains the CCPP-compliant parameterizations of the GFS that went operational in July 2017,
+called gmtb-gfsphysics, use:
 \begin{itemize}
 	\item for sh, bash
 
@@ -23,10 +24,10 @@ \section{A sample test case}
 
 
 \section{Run the SCM with the supplied case} 
-The test case provided with the SCM is TWP-ICE, the Tropical Warm Pool-International Cloud Experiment. The SCM will go through the time steps, applying forcing and calling the physics defined in the suite definition file.
+The test case provided with this version of the SCM is TWP-ICE, the Tropical Warm Pool-International Cloud Experiment. The SCM will go through the time steps, applying forcing and calling the physics defined in the suite definition file.
 There is a single command line argument required, which is the name of the case configuration file.  For the provided case, that name is \exec{twpice}.
 
-\exec{./gmtb\_scm twpice}
+  \exec{./gmtb\_scm twpice}
 
 A netcdf output file is generated in the location specified in the case
 configuration file. Any standard NetCDF file viewing or analysis tools may be used to 
@@ -40,18 +41,20 @@ \section{Run the SCM with the supplied case}
 
 
 \section{Setting up the physics suite}
-First, a physics suite is defined using an XML file located in
-src/ccpp/examples. The XML file contains the suite name, the number of suite
+A physics suite is defined using a Suite Definition File (SDF) located in
+src/ccpp/examples. The SDF file is in XML format and contains the following information: a) suite name, b) number of suite
 "parts" (suite parts exist so that an atmosphere "cap" can execute code between
-calls to the physics driver), the number of subcycles for each scheme (if
-physics schemes require smaller time steps than the dynamics), and the scheme
-names. Scheme names found in the suite XML files must correspond to schemes
+calls to the physics driver), c) number of subcycles for each scheme (if
+physics schemes require smaller time steps than the dynamics), and d) the scheme
+names. Scheme names found in the SDF must correspond to schemes
 located within the physics directory.
 
-Using a suite in the SCM framework involves specifying its name in the case
+Using a SDF in the SCM framework involves specifying its name in the case
 configuration file to be used. For example, for the twpice case
-(case\_config/twpice.nml), the variable 'physics suite' is set to the desired
-suite name. NOTE: As mentioned in the 'Running' section above, since the schemes
+(case\_config/twpice.nml), the variable 'physics suite' is set to the 
+suite name for using the GFS Physics with this case. 
+
+NOTE: As mentioned in the 'Running' section above, since the schemes
  are in their own libraries, you must specify the path to the compiled scheme
  libraries that are being used in the suite by appending the LD\_LIBRARY\_PATH
  (or DYLD\_LIBRARY\_PATH for Mac OS). Without this step, the scheme libraries will

doc/UsersGuide/SCM/title.tex

@@ -5,7 +5,7 @@
 \noindent
 
 \begin{center}
-\textcolor{darkgray}{\bigsf Common Community Physics Package (CCPP)\\}
+\textcolor{darkgray}{\bigsf Common Community Physics Package (CCPP) with Global Model Test Bed Single-Column Model\\}
 \vspace*{1em}\par
 
 \textcolor{darkgray}{\bigst Quick Start Users' Guide \\v1.0}
@@ -17,7 +17,7 @@
 \textit{\small{National Center for Atmospheric Research and Developmental Testbed Center}}\\[4em]
 
 Ligia Bernardet, Dominikus Heinzeller\\
-\textit{\small{NOAA/ESRL Global Systems Division , Developmental Testbed Center and CIRES/CU}}\\[4em]
+\textit{\small{CIRES/CU at NOAA/ESRL Global Systems Division and Developmental Testbed Center}}\\[4em]
 
 \vspace{4em}