Skip to content

Commit

Permalink
Fix typo in README.md, change 'Chapter' to 'Section'
Browse files Browse the repository at this point in the history
  • Loading branch information
climbfuji committed Jan 22, 2020
1 parent 62b11b6 commit 8ed370e
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion CCPPtechnical/source/AddingNewSchemes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This chapter contains a brief description on how to add a new scheme to the *CCP

* If the variables are already available, they can be invoked in the scheme’s metadata file and one can skip the rest of this subsection. If the variable required is not available, consider if it can be calculated from the existing variables in the CCPP. If so, an interstitial scheme (such as ``scheme_pre``; see more in :numref:`Chapter %s <CompliantPhysParams>`) can be created to calculate the variable. However, the variable must be defined but not initialized in the host model as the memory for this variable must be allocated on the host model side. Instructions for how to add variables to the host model side is described in :numref:`Chapter %s <Host-side Coding>`.

.. note:: The CCPP framework is capable of performing automatic unit conversions between variables provided by the host model and variables required by the new scheme. See :numref:`Chapter %s <AutomaticUnitConversions>` for details.
.. note:: The CCPP framework is capable of performing automatic unit conversions between variables provided by the host model and variables required by the new scheme. See :numref:`Section %s <AutomaticUnitConversions>` for details.

* If new namelist variables need to be added, the ``GFS_control_type`` DDT should be used. In this case, it is also important to modify the namelist file ``input.nml`` to include the new variable.

Expand Down
4 changes: 2 additions & 2 deletions CCPPtechnical/source/AutoGenPhysCaps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The CCPP *prebuild* step for the dynamic build performs the following tasks:
* Checks requested vs provided variables by ``standard_name``.
* Checks units, rank, type for consistency. Perform unit conversions if a mismatch
of units is detected and the required conversion has been implemented (see
:numref:`Chapter %s <AutomaticUnitConversions>` for details).
:numref:`Section %s <AutomaticUnitConversions>` for details).
* Creates Fortran code that adds pointers to the host model variables and stores them in the
ccpp-data structure (``ccpp_fields_*.inc``). A hash table that is part of cdata is populated with
key = standard_name of a variable and value = location of that variable in memory (i.e. a c-pointer).
Expand Down Expand Up @@ -217,7 +217,7 @@ The CCPP *prebuild* step for the static build performs the tasks below.
* Check requested vs provided variables by ``standard_name``.
* Check units, rank, type. Perform unit conversions if a mismatch
of units is detected and the required conversion has been implemented (see
:numref:`Chapter %s <AutomaticUnitConversions>` for details).
:numref:`Section %s <AutomaticUnitConversions>` for details).
* Filter unused schemes and variables.
* Create Fortran code for the static Application Programming Interface (API) that replaces the dynamic API (CCPP-Framework). The hash table used by the dynamic build to store variables in memory is left empty.
* Create *caps* for groups and suite(s).
Expand Down
2 changes: 1 addition & 1 deletion CCPPtechnical/source/CCPPPreBuild.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ on the host model side and from the individual physics schemes (``.meta`` files;
* Matches these variables by their ``standard_name``, checks for missing variables and mismatches of their
attributes (e.g., units, rank, type, kind) and processes information on optional variables. Performs
automatic unit conversions if a mismatch of units is detected between a scheme and the host model
(see :numref:`Chapter %s <AutomaticUnitConversions>` for details).
(see :numref:`Section %s <AutomaticUnitConversions>` for details).

* For the static build only, filters out unused variables for a given suite.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ccpp-doc
This repository contains the technical documentation for the [GMTB](http://www.dtcenter.org/GMTB/html/)
Common Community Physics Package (CCPP). A viewable version of the latest documentation resides
chttps://dtcenter.org/community-code/common-community-physics-package-ccpp/documentation).
[here](https://dtcenter.org/community-code/common-community-physics-package-ccpp/documentation).

## Notes to Developers
The documentation is generated with Sphinx, using the reStructuredText (*.rst*) files in the
Expand Down

0 comments on commit 8ed370e

Please sign in to comment.