Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions committed Sep 10, 2024
1 parent 1b3158a commit e3a17ee
Show file tree
Hide file tree
Showing 5 changed files with 1 addition and 27 deletions.
3 changes: 0 additions & 3 deletions _sources/building_and_running_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,3 @@ To run the tests, either run test binaries individually, or use ``ctest`` CMake
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
``LD_LIBRARY_PATH`` on Linux.
12 changes: 0 additions & 12 deletions _sources/using_onemkl_with_cmake.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,6 @@ during the build. To check for the existence of backends, CMake's ``if(TARGET
message(FATAL_ERROR "oneMKL Interfaces was not built with CuFFT backend")
endif()
If oneMKL Interfaces has been installed to a non-standard location, the
operating system may not find the backend libraries when they're lazily loaded
at runtime. To make sure they're found you may need to set
``LD_LIBRARY_PATH=<onemkl_install_dir>/lib:$LD_LIBRARY_PATH`` on Linux.

.. _using_with_fetchcontent:

Using CMake's FetchContent
Expand Down Expand Up @@ -93,10 +87,4 @@ against particular backends (as required for static dispatch of oneAPI calls to
a particular backend), use the target ``onemkl_<domain>_<backend>``. For
example, ``onemkl_dft_cufft``.

When using the run-time dispatch mechanism, it is likely that the operating
system will not find the backend libraries when they're loaded at runtime. To
make sure they're found you may need to set
``LD_LIBRARY_PATH=<onemkl_install_dir>/lib:$LD_LIBRARY_PATH`` on Linux.


.. _FetchContent: https://cmake.org/cmake/help/latest/module/FetchContent.html
3 changes: 0 additions & 3 deletions building_and_running_tests.html
Original file line number Diff line number Diff line change
Expand Up @@ -562,9 +562,6 @@ <h1>Building and Running Tests</h1>
</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>
</section>


Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

8 changes: 0 additions & 8 deletions using_onemkl_with_cmake.html
Original file line number Diff line number Diff line change
Expand Up @@ -576,10 +576,6 @@ <h2> Contents </h2>
<span class="nb">endif</span><span class="p">()</span>
</pre></div>
</div>
<p>If oneMKL Interfaces has been installed to a non-standard location, the
operating system may not find the backend libraries when they’re lazily loaded
at runtime. To make sure they’re found you may need to set
<code class="docutils literal notranslate"><span class="pre">LD_LIBRARY_PATH=&lt;onemkl_install_dir&gt;/lib:$LD_LIBRARY_PATH</span></code> on Linux.</p>
</section>
<section id="using-cmake-s-fetchcontent">
<span id="using-with-fetchcontent"></span><h2>Using CMake’s FetchContent<a class="headerlink" href="#using-cmake-s-fetchcontent" title="Link to this heading">#</a></h2>
Expand Down Expand Up @@ -609,10 +605,6 @@ <h2> Contents </h2>
against particular backends (as required for static dispatch of oneAPI calls to
a particular backend), use the target <code class="docutils literal notranslate"><span class="pre">onemkl_&lt;domain&gt;_&lt;backend&gt;</span></code>. For
example, <code class="docutils literal notranslate"><span class="pre">onemkl_dft_cufft</span></code>.</p>
<p>When using the run-time dispatch mechanism, it is likely that the operating
system will not find the backend libraries when they’re loaded at runtime. To
make sure they’re found you may need to set
<code class="docutils literal notranslate"><span class="pre">LD_LIBRARY_PATH=&lt;onemkl_install_dir&gt;/lib:$LD_LIBRARY_PATH</span></code> on Linux.</p>
</section>
</section>

Expand Down

0 comments on commit e3a17ee

Please sign in to comment.