Skip to content

Commit

Permalink
docs: add Kokkos to build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
cz4rs committed Dec 14, 2023
1 parent 23b6d34 commit 4bcb99d
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ that are summarized here:

- :ref:`vt_DIR <cmake-vt-dir>`
- :ref:`vt_ROOT <cmake-vt-root>`
- :ref:`Kokkos_DIR <cmake-kokkos-dir>`
- :ref:`Kokkos_ROOT <cmake-kokkos-root>`
- :ref:`BVH_VT_INSERTABLE_COLLECTIONS <cmake-bvh-vt-insertable-collections>`
- :ref:`VTK_ROOT <cmake-vtk-root>`
- :ref:`BVH_DEBUG_LEVEL <cmake-bvh-debug-level>`
Expand Down Expand Up @@ -67,6 +69,27 @@ BVH can optionally use insertable collections. Use the following to turn off ins
-DBVH_VT_INSERTABLE_COLLECTIONS=OFF
Locating Kokkos
-----------------

BVH is dependent on `Kokkos`_ for performance portability.
Follow the instructions on `Kokkos wiki`_ for Kokkos build and installation.

.. _cmake-kokkos-dir:

.. code-block:: sh
-DKokkos_DIR=path/to/kokkos/install/cmake
.. _cmake-kokkos-root:

.. code-block:: sh
-DKokkos_ROOT=path/to/kokkos/install
.. _Kokkos: https://github.com/kokkos/kokkos
.. _Kokkos wiki: https://kokkos.github.io/kokkos-core-wiki/building.html

Building with VTK
-----------------

Expand Down

0 comments on commit 4bcb99d

Please sign in to comment.