Skip to content

Commit

Permalink
Fixed a couple more documentation issues
Browse files Browse the repository at this point in the history
docs/source/getting_started/00_revision_history.rst
- Added variables and files in :code: or :file: blocks

docs/source/using_kpp/04_input_for_kpp.rst
- Updates for readability

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
  • Loading branch information
yantosca committed May 18, 2022
1 parent 7bdf412 commit 1b115c8
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 19 deletions.
20 changes: 11 additions & 9 deletions docs/source/getting_started/00_revision_history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,17 +65,18 @@ KPP 2.3.2_gc
NOTE: Contains KPP Modifications specific to GEOS-Chem:

- Added workaround for F90 derived-type objects in inlined code
(i.e. properly parse State_Het%xArea, etc).
(i.e. properly parse :code:`State_Het%xArea`, etc).

- Updated Github issue templates.

- MAX_INLINE (max # of inlined code lines to read) has been increased
to 200000.
- :code:`MAX_INLINE` (max # of inlined code lines to read) has been
increased to 200000.

- Commented out the Update_Sun() functions in update_sun.F90,
update_sun.F. (NOTE: These have been restored in :ref:`kpp250`).
- Commented out the :code:`Update_Sun()` functions in :code:`update_sun.F90`,
:code:`update_sun.F`. (NOTE: These have been restored in
:ref:`kpp250`).

- Default rate law functions are no longer written to gckpp_Rates.F90.
- Default rate law functions are no longer written to :code:`gckpp_Rates.F90`.
(NOTE: These have been restored in :ref:`kpp250`).

.. _kpp231gc:
Expand Down Expand Up @@ -105,7 +106,7 @@ KPP 2.3.0_gc

NOTE: Contains KPP modifications specific to GEOS-Chem

- Added README.md for the GC_updates branch.
- Added :file:`README.md` for the GC_updates branch.

- Added MIT license for the GC_updates branch.

Expand Down Expand Up @@ -135,7 +136,7 @@ KPP 2.2.5_gc

NOTE: Contains KPP modifications specific to GEOS-Chem

- Increase MAX_INLINE from 20000 to 50000
- Increase :code:`MAX_INLINE` from 20000 to 50000

.. _kpp224gc:

Expand All @@ -145,7 +146,8 @@ KPP 2.2.4_gc

NOTE: Contains KPP modifications specific to GEOS-Chem

- Add MIT license files for GC_updates branch and update README.md accordingly
- Add MIT license files for GC_updates branch and update
:file:`README.md` accordingly

- Create :file:`README.md` for main branch

Expand Down
20 changes: 10 additions & 10 deletions docs/source/using_kpp/04_input_for_kpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -380,23 +380,23 @@ are given in the following subsections.
The :command:`#DECLARE` command determines how constants like
:code:`dp`, :code:`NSPEC`, :code:`NVAR`, :code:`NFIX`, and
:code:`NREACT` are inserted into the KPP-generated code.
:command:`#DECLARE SYMBOL` (the default) will declare array variables
:command:`#DECLARE SYMBOL` (the default) will declare array variables
using parameters from the :ref:`Parameters` file. :command:`#DECLARE VALUE`
will replace the parameter with its value.
will replace each parameter with its value.

For example, the global array variable :code:`C` is declared in the
:ref:`Global` file generated by KPP. In the :command:`small_strato`
example described in :ref:`running-kpp-sample-mech`, C has dimension
:code:`NSPEC=7`. Using :command:`#DECLARE SYMBOL` will generate the
following code in :ref:`Global`:
example (described in :ref:`running-kpp-with-an-example-mechanism`),
:code:`C` has dimension :code:`NSPEC=7`. Using :command:`#DECLARE
SYMBOL` will generate the following code in :ref:`Global`:

.. code-block:: F90
! C - Concentration of all species
REAL(kind=dp), TARGET :: C(NSPEC)
!$OMP THREADPRIVATE( C )
whereas :command:`#DECLARE VALUE` will generate this code instead:
Whereas :command:`#DECLARE VALUE` will generate this code instead:

.. code-block:: F90
Expand All @@ -405,9 +405,9 @@ whereas :command:`#DECLARE VALUE` will generate this code instead:
!$OMP THREADPRIVATE( C )
We recommend using :command:`#DECLARE SYMBOL`, as most modern
compilers will automatically replace parameter (e.g. :code:`NSPEC`)
with its value (e.g :code:`7`). This will prevent repeated lookups of
the parameter value, which leads to inefficient execution. If you are
compilers will automatically replace each parameter (e.g. :code:`NSPEC`)
with its value (e.g :code:`7`). This prevents repeated lookups of
the parameter value, which leads to inefficient execution. But if you are
using a very old compiler that is not as sophisticated,
:command:`#DECLARE VALUE` might result in better-optmized code.

Expand Down Expand Up @@ -607,7 +607,7 @@ code file is to be generated. Available options are :command:`Fortran90`,
.. tip::

You can select the suffix (:code:`.F90` or :code:`.f90`) to use for
Fortran90 source code generated by KPP (cf. :ref:`uppercasef90`).
Fortran90 source code generated by KPP (cf. :ref:`uppercasef90-cmd`).

.. _mex-cmd:

Expand Down

0 comments on commit 1b115c8

Please sign in to comment.