Skip to content

Commit

Permalink
Minor cleanup items for ReadTheDocs
Browse files Browse the repository at this point in the history
02_running_kpp_sample_mech.rst
- Updated some cross-references for better readability
- Trimmed trailing whitespace

04_input_for_kpp.rst
- Updated "target language" from a rst link to a ref

07_numerical_methods.rst
- Changed "Other" section to "Other integration methods"
- Added descriptive text for beuler & feuler

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
  • Loading branch information
yantosca committed Jun 10, 2022
1 parent f546287 commit 97e86af
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 17 deletions.
26 changes: 13 additions & 13 deletions docs/source/getting_started/02_running_kpp_sample_mech.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ languages are discussed in the :ref:`language-cmd` section.
KPP user community to spearhead development in C, Matlab, and other
languages.

The KPP input files (with suffix :file:`.kpp`) specify the target
model (:ref:`model-cmd`), the target language (:ref:`language-cmd`),
the integrator (:ref:`integrator-cmd`) the driver program
(:ref:`driver-cmd`). etc. The file name (without the suffix
The KPP input files (with suffix :file:`.kpp`) specify the
:ref:`target model <model-cmd>`, the :ref:`target language
<language-cmd>`, the :ref:`integrator <integrator-cmd>` the
:ref:`driver program <driver-cmd>`. etc. The file name (without the
:file:`.kpp`) serves as the root name for the simulation. Here we will
refer to this name as :code:`ROOT`. Since the root name will be
incorporated into Fortran90 module names, it can only contain valid
Expand Down Expand Up @@ -112,7 +112,7 @@ The :ref:`model-cmd` command selects a specific kinetic mechanism (in
this example, :program:`small_strato`). KPP will look in the path
:file:`$KPP_HOME/models/` for the *model definition file*
:file:`small_strato.def`. This file contains the following
code in the KPP language (cf. :ref:`bnf-description`):
code in the :ref:`KPP language <bnf-description>`.

.. code-block:: console
Expand Down Expand Up @@ -161,8 +161,8 @@ code in the KPP language (cf. :ref:`bnf-description`):
File (:file:`small_strato.def`) :ref:`include-cmd`-s the *species
file* and the *equation file*. It also specifies parameters for
running a "box-model" simualation, such as species initial values
(cf. :ref:`initvalues`),_ start time, stop, time, and timestep
running a "box-model" simualation, such as :ref:`species initial
values <initvalues>`, start time, stop, time, and timestep
(cf. :ref:`inlined-code`).

The *species file* (:file:`small_strato.spc`) file lists all the
Expand Down Expand Up @@ -192,8 +192,8 @@ lists the periodic table of elements in an :command:`ATOM` section

The *equation file* (:file:`small_strato.eqn`) contains the
description of the equations in an :ref:`equations` section. The
chemical kinetic mechanism is specified in the KPP language
(cf. :ref:`bnf-description`). Each reaction is described as “the sum
chemical kinetic mechanism is specified in the :ref:`KPP language
<bnf-description>`. Each reaction is described as “the sum
of reactants equals the sum of products” and is followed by its rate
coefficient. :code:`SUN` is the normalized sunlight intensity, equal
to one at noon and zero at night. Equation tags, e.g. :code:`<R1>`,
Expand All @@ -220,8 +220,8 @@ are optional.
#LANGUAGE Fortran90
-------------------

The :ref:`language-cmd` selects the language for the KPP-generated
solver code. In this example we are using Fortran90.
The :ref:`language-cmd` command selects the language for the
KPP-generated solver code. In this example we are using Fortran90.

.. _example-double-on:

Expand All @@ -242,8 +242,8 @@ The :ref:`integrator-cmd` command selects a numerical integration routine
from the templates provided in the :file:`$KPP_HOME/int` folder, or
implemented by the user.

In this example, the Rosenbrock integrator (cf.
:ref:`rosenbrock-methods`) and the Fortran90 language have been been
In this example, the :ref:`Rosenbrock integrator
<rosenbrock-methods>` and the Fortran90 language have been been
specified. Therefore it will use the file
:file:`$KPP_HOME/int/rosenbrock.f90`.

Expand Down
12 changes: 9 additions & 3 deletions docs/source/tech_info/07_numerical_methods.rst
Original file line number Diff line number Diff line change
Expand Up @@ -510,15 +510,21 @@ BEULER

**Integrator file:** :file:`int/beuler.f90`

=====
Other
=====
Backward Euler integration method.

.. _other-methods:

=========================
Other integration methods
=========================

FEULER
------

**Integrator file:** :file:`int/feuler.f90`

Forward Euler integration method.

.. _integrator-input-output:

=============================
Expand Down
2 changes: 1 addition & 1 deletion docs/source/using_kpp/04_input_for_kpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Only the names of already defined species can be used. The rate
coefficient has to be placed at the end of each equation, separated by a
colon. The rate coefficient does not necessarily need to be a numerical
value. Instead, it can be a valid expression in the
`target language <language-cmd_>`_. If there are several
:ref:`target language <language-cmd>`. If there are several
:command:`#EQUATIONS` sections in the input, their contents will be
concatenated.

Expand Down

0 comments on commit 97e86af

Please sign in to comment.