Skip to content

Commit

Permalink
very many very minor updates of the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RolfSander committed Jun 30, 2022
1 parent 51f0802 commit d185710
Show file tree
Hide file tree
Showing 11 changed files with 284 additions and 312 deletions.
3 changes: 1 addition & 2 deletions AUTHORS.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
Authors for KPP (19 Apr 2022)
Authors for KPP (30 Jun 2022)

Name Github handle
----- -------------
Adrian Sandu @adrian-sandu
Rolf Sander @RolfSander
Josue Bock @JosueBock
Michael Long @msl3v
Bob Yantosca @yantosca
Haipeng Lin @jimmielin
Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting_started/00_revision_history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ NOTE: Contains KPP modifications specific to GEOS-Chem.
- Add :code:`Aout` argument to return reaction rates from
:code:`SUBROUTINE Fun`.

- Rename :file:`KPP/kpp_2.2.3_01` folder to :file:`KPP/kpp-code`.
- Rename :file:`KPP/kpp_2.2.3_01` directory to :file:`KPP/kpp-code`.

- Now write :file:`gckpp_Model.F90` and :file:`gckpp_Precision.F90`
from :code:`gen.c`.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/getting_started/01_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Clone the KPP source code from the `KPP Github repository
$ cd $HOME
$ git clone https://github.com/KineticPreProcessor/KPP.git
This will create a folder named KPP in your home directory.
This will create a directory named KPP in your home directory.

========================================
Define the KPP_HOME environment variable
Expand Down Expand Up @@ -62,7 +62,7 @@ Now if you type:
$ echo $PATH
You should see the :envvar:`$KPP_HOME/bin` folder placed at the end of
You should see the :envvar:`$KPP_HOME/bin` directory placed at the end of
the :envvar:`PATH` variable.

.. _test-for-dependencies:
Expand Down
20 changes: 10 additions & 10 deletions docs/source/getting_started/02_running_kpp_sample_mech.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ The sections below outline the steps necessary to build and run a
.. _example-step-1:

==================================
1. Create a folder for the example
1. Create a directory for the example
==================================

Create a folder in which to build and run the example mechanism:
Create a directory in which to build and run the example mechanism:

.. code-block:: console
Expand All @@ -63,20 +63,20 @@ Create a folder in which to build and run the example mechanism:
$ cd small_strato_example
In the following sections we will refer to
:file:`$HOME/small_strato_example` as "the example folder".
:file:`$HOME/small_strato_example` as "the example directory".

.. _example-step-2:

===============================
2. Create a KPP Definition File
===============================

Create a KPP definition file in the example folder. The name
Create a KPP definition file in the example directory. The name
of this file will always be :file:`ROOT.kpp`, where :file:`ROOT` is
the name of the chemical mechanism.

For this example, write the following lines into a file named
:file:`small_strato.kpp` in the example folder:
:file:`small_strato.kpp` in the example directory:

.. code-block:: console
Expand All @@ -88,9 +88,9 @@ For this example, write the following lines into a file named
.. important::

KPP will look for the relevant files (e.g. mechanism definition,
driver, etc.) in the proper subfolders of :envvar:`KPP_HOME`.
driver, etc.) in the proper subdirectories of :envvar:`KPP_HOME`.
Therefore you won't need to copy these manually to the example
folder.
directory.

We will now look at the :ref:`kpp-commands` in :file:`small_strato.kpp`.

Expand Down Expand Up @@ -217,7 +217,7 @@ KPP-generated solver code. In this example we are using Fortran90.
----------------------

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

In this example, the :ref:`Rosenbrock integrator <rosenbrock-methods>`
Expand All @@ -231,7 +231,7 @@ and the Fortran90 language have been been specified. Therefore, the file
---------------

The :ref:`driver-cmd` command selects a specific main program (located
in the :file:`$KPP_HOME/drv` folder):
in the :file:`$KPP_HOME/drv` directory):

#. :file:`general_adj.f90` : Used with integrators that use the
discrete adjoint method
Expand All @@ -250,7 +250,7 @@ either adjoint or tangent-linear methods, so the
3. Build the mechanism with KPP
===============================

Now that all the necessary files have been copied to the example folder,
Now that all the necessary files have been copied to the example directory,
the :program:`small_strato` mechanism can be built. Type:

.. code-block:: console
Expand Down
14 changes: 5 additions & 9 deletions docs/source/reference/SUPPORT.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,10 @@ a new
issue <https://github.com/KineticPreProcessor/KPP/issues/new/choose>`__
and select the “ask a question” template.

=====================
How to submit changes
=====================
===============================================
How to submit changes or request an enhancement
===============================================

Please see “Contributing Guidelines”.
See `CONTRIBUTING.md
<https://github.com/KineticPreProcessor/KPP/blob/main/CONTRIBUTING.md>`_.

=============================
How to request an enhancement
=============================

Please see “Contributing Guidelines”.
6 changes: 2 additions & 4 deletions docs/source/reference/known-bugs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,5 @@
Known Bugs
##########

This page links to known bugs in :program:`KPP`.
See the `KPP repository Github issues page
<https://github.com/KineticPreProcessor/KPP/issues/>`_ for updates on
their status.
Bugs are discussed at the `KPP repository Github issues page
<https://github.com/KineticPreProcessor/KPP/issues/>`_.

0 comments on commit d185710

Please sign in to comment.