Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Rewrite build documentation #510

Merged
merged 22 commits into from
Jun 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
e8d6a5a
[Docs] Rewrite build documentation
hjabird Jun 10, 2024
104dbd4
Address RBiessy comments
hjabird Jun 11, 2024
3b90655
Minor rewording; link AdaptiveCpp target docs;
hjabird Jun 11, 2024
0244f4c
Move test docs to new file; Rename using with cmake file, add into
hjabird Jun 12, 2024
eabd21e
Merge portFFT/portBLAS sections; link to windows supported backends; …
hjabird Jun 12, 2024
6021078
Link nvidia compute capability table
hjabird Jun 12, 2024
ef4c835
Simplify Build Setup sections
hjabird Jun 12, 2024
3b8c17e
Improve Build Setup (now Environment Setup)
hjabird Jun 14, 2024
9071393
Rename Introduction->Build Commands; Unindent code
hjabird Jun 14, 2024
adedb54
Common Problems->Build FAQ; clarify port*/MKL?PU exclusivity; Additio…
hjabird Jun 14, 2024
edb51ee
Format for 80 character lines
hjabird Jun 14, 2024
3701e07
Use True/False for CMake
hjabird Jun 14, 2024
b33077b
Call it oneMKL Interfaces; more formatting to 80 columns
hjabird Jun 14, 2024
e06b9b9
Update for ONEAPI_DEVICE_SELECTOR; Fix minor formatting issues
hjabird Jun 14, 2024
04744c6
Improve DPC++ Build Commands introduction
hjabird Jun 18, 2024
17befab
Reducing spacing in invocation examples
hjabird Jun 18, 2024
8f4fc93
Replace remaining OFFs / ONs with False / True
hjabird Jun 18, 2024
ef02116
Minor changes: clarify may require; clean up grammar; _o_neMKL; list …
hjabird Jun 18, 2024
4f6af02
Rewording
hjabird Jun 18, 2024
882b98b
Bullet point formatting
hjabird Jun 18, 2024
cbd83b4
Cleanup -> clean up part 2
hjabird Jun 18, 2024
c55db76
Mention MKLROOT environment variable
hjabird Jun 19, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/building_and_running_tests.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
.. _building_and_running_tests:

Building and Running Tests
==========================

The functional tests are enabled by default, and can be enabled/disabled
with the CMake build parameter ``-DBUILD_FUNCTIONAL_TESTS=True/False``. Only
the tests relevant to the enabled backends and target domains will be built.

Building tests for BLAS and LAPACK domains requires additional libraries for
reference.

* BLAS: Requires a reference BLAS library.
* LAPACK: Requires a reference LAPACK library.

For both BLAS and LAPACK, shared libraries supporting both 32 and 64 bit
indexing are required.

A reference LAPACK implementation (including BLAS) can be built as the
following:

.. code-block:: bash

git clone https://github.com/Reference-LAPACK/lapack.git
cd lapack; mkdir -p build; cd build
cmake -DCMAKE_INSTALL_PREFIX=~/lapack -DCBLAS=True -DLAPACK=True -DLAPACKE=True -DBUILD_INDEX64=True -DBUILD_SHARED_LIBS=True ..
cmake --build . -j --target install
cmake -DCMAKE_INSTALL_PREFIX=~/lapack -DCBLAS=True -DLAPACK=True -DLAPACKE=True -DBUILD_INDEX64=False -DBUILD_SHARED_LIBS=True ..
cmake --build . -j --target install

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.

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.
Loading