From 5c78c20dd1ff822aaa1b0b25c312e5ffb6279844 Mon Sep 17 00:00:00 2001 From: Hannah Klion Date: Wed, 18 Dec 2024 16:29:21 -0800 Subject: [PATCH] doc tweaks --- Docs/sphinx_doc/building.rst | 6 +++--- Docs/sphinx_doc/testing.rst | 13 ++++++++----- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/Docs/sphinx_doc/building.rst b/Docs/sphinx_doc/building.rst index 66148c0..f6790b8 100644 --- a/Docs/sphinx_doc/building.rst +++ b/Docs/sphinx_doc/building.rst @@ -161,7 +161,7 @@ Using CMake involves an additional configure step before using the ``make`` comm To build with CMake, a user typically creates a ``build`` directory in the project directory and in that directory the ``cmake ..`` command is used to configure the project before building it. REMORA provides an example build directory called ``Build`` with example scripts for performing the CMake configure. Once the CMake configure step is done, then the ``make`` command will build the executable. -An example CMake configure command to build REMORA without MPI. Replace the compilers with those installed on your system: +An example CMake configure/build command to build REMORA without MPI. Replace the compilers with those installed on your system: :: @@ -170,7 +170,7 @@ An example CMake configure command to build REMORA without MPI. Replace the comp -DCMAKE_CXX_COMPILER:STRING=g++ \ .. && make -An example CMake configure command to build REMORA with MPI is listed below: +An example CMake configure/build command to build REMORA with MPI is listed below: :: @@ -180,7 +180,7 @@ An example CMake configure command to build REMORA with MPI is listed below: .. && make -An example CMake configure command to build REMORA with MPI, PnetCDF, and particles is listed below: +An example CMake configure/build command to build REMORA with MPI, PnetCDF, and particles is listed below: :: diff --git a/Docs/sphinx_doc/testing.rst b/Docs/sphinx_doc/testing.rst index 43b987b..fdb7d8f 100644 --- a/Docs/sphinx_doc/testing.rst +++ b/Docs/sphinx_doc/testing.rst @@ -5,7 +5,7 @@ Testing and Verification Testing and verification of REMORA can be performed using CTest, which is included in the CMake build system. If one builds REMORA with CMake, the testing suite, and the verification suite, can be enabled during the CMake configure step. -An example ``cmake`` configure command performed in the ``Build`` directory in REMORA is shown below with options relevant to the testing suite: +An example ``cmake`` configure/build command performed in the ``Build`` directory in REMORA is shown below with options relevant to the testing suite: :: @@ -16,7 +16,7 @@ An example ``cmake`` configure command performed in the ``Build`` directory in R -DREMORA_ENABLE_FCOMPARE:BOOL=ON \ -DREMORA_ENABLE_TESTS:BOOL=ON \ -DREMORA_USE_CPP:BOOL=ON \ - .. + .. && make While performing a ``cmake -LAH ..`` command will give descriptions of every option for the CMake project. Descriptions of particular options regarding the testing suite are listed below: @@ -31,7 +31,11 @@ Building the Tests Once the user has performed the CMake configure step, the ``make`` command will build every executable required for each test. In this step, it is highly beneficial for the user to use the ``-j`` option for ``make`` -to build source files in parallel. +to build source files in parallel. For example: + + .. code:: shell + + make -j8 Running the Tests ~~~~~~~~~~~~~~~~~ @@ -43,8 +47,7 @@ To run the test suite, run ``ctest`` in the ``Build`` directory. CTest will run Useful options for CTest are ``-VV`` which runs in a verbose mode where the output of each test can be seen. ``-R`` where a regex string can be used to run specific sets of tests. ``-j`` where CTest will bin pack and run tests in parallel based on how many processes each test is specified to use and fit them into the amount of cores available -on the machine. ``-L`` where the subset of tests containing a particular label will be run. -(We note that using ``-L 'regression'`` will run all the tests that do not use SUNDIALS.) +on the machine. Output for the last set of tests run is available in the ``Build`` directory in ``Testing/Temporary/LastTest.log``. Adding Tests