Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions committed Jun 21, 2024
1 parent 28c2b75 commit d9d3216
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 5 deletions.
16 changes: 14 additions & 2 deletions _sources/building_and_running_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,20 @@ following:
and then used in oneMKL by setting ``-REF_BLAS_ROOT=/path/to/lapack/install``
and ``-DREF_LAPACK_ROOT=/path/to/lapack/install``.

To run the tests, either use the CMake test driver, by running ``ctest``, or run
individual test binaries individually.
You can re-run tests without re-building the entire project.

To run the tests, either run test binaries individually, or use ``ctest`` CMake test driver program.

.. code-block:: bash
# Run all tests
ctest
# Run only Gpu specific tests
ctest -R Gpu
# Exclude Cpu tests
ctest -E Cpu
For more ``ctest`` options, refer to `ctest manual page <https://cmake.org/cmake/help/v3.13/manual/ctest.1.html>`_.

When running tests you may encounter the issue ``BACKEND NOT FOUND EXCEPTION``,
you may need to add your ``<oneMKL build directory>/lib`` to your
Expand Down
13 changes: 11 additions & 2 deletions building_and_running_tests.html
Original file line number Diff line number Diff line change
Expand Up @@ -550,8 +550,17 @@ <h1>Building and Running Tests</h1>
</div>
<p>and then used in oneMKL by setting <code class="docutils literal notranslate"><span class="pre">-REF_BLAS_ROOT=/path/to/lapack/install</span></code>
and <code class="docutils literal notranslate"><span class="pre">-DREF_LAPACK_ROOT=/path/to/lapack/install</span></code>.</p>
<p>To run the tests, either use the CMake test driver, by running <code class="docutils literal notranslate"><span class="pre">ctest</span></code>, or run
individual test binaries individually.</p>
<p>You can re-run tests without re-building the entire project.</p>
<p>To run the tests, either run test binaries individually, or use <code class="docutils literal notranslate"><span class="pre">ctest</span></code> CMake test driver program.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Run all tests</span>
ctest
<span class="c1"># Run only Gpu specific tests</span>
ctest<span class="w"> </span>-R<span class="w"> </span>Gpu
<span class="c1"># Exclude Cpu tests</span>
ctest<span class="w"> </span>-E<span class="w"> </span>Cpu
</pre></div>
</div>
<p>For more <code class="docutils literal notranslate"><span class="pre">ctest</span></code> options, refer to <a class="reference external" href="https://cmake.org/cmake/help/v3.13/manual/ctest.1.html">ctest manual page</a>.</p>
<p>When running tests you may encounter the issue <code class="docutils literal notranslate"><span class="pre">BACKEND</span> <span class="pre">NOT</span> <span class="pre">FOUND</span> <span class="pre">EXCEPTION</span></code>,
you may need to add your <code class="docutils literal notranslate"><span class="pre">&lt;oneMKL</span> <span class="pre">build</span> <span class="pre">directory&gt;/lib</span></code> to your
<code class="docutils literal notranslate"><span class="pre">LD_LIBRARY_PATH</span></code> on Linux.</p>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit d9d3216

Please sign in to comment.