Skip to content

Commit

Permalink
Clearer instructions and small formatting changes, adding ctests docu…
Browse files Browse the repository at this point in the history
…mentation
  • Loading branch information
scrasmussen committed Nov 11, 2024
1 parent 71d6308 commit e9e14c0
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions docs/BUILD.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ Requirements


Install dependencies for Debain/Ubuntu
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: bash
$ apt install -y git cmake libnetcdff-dev mpi-default-dev
Install/activate dependencies for Red Hat/Fedora
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: bash
$ dnf install -y git cmake netcdf-fortran-mpich-devel
Expand Down Expand Up @@ -91,6 +91,12 @@ available options are described in the following table.
CMake Testcase
~~~~~~~~~~~~~~

.. code-block:: bash
$ cd build/Run
$ make croton
$ make run
To download and setup the Croton testcase in ``build/Run`` use one of the
following commands.
The first time the ``croton.tar.gz`` file will be downloaded, extracted, and configured.
Expand All @@ -115,3 +121,12 @@ Future commands will reconfigure the ``Run`` directory.
+---------------------------------+
| make croton-reach-lakes |
+---------------------------------+

CTests
~~~~~~
Run WRF-Hydro unit tests

.. code-block:: bash
$ cd build
$ ctest

0 comments on commit e9e14c0

Please sign in to comment.